docs: fix missing links and add consistency #6177
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dhmlau
approved these changes
Aug 24, 2020
hacksparrow
force-pushed
the
docs/concept-links
branch
from
d461a1f
to
52e1435
Compare
hacksparrow
force-pushed
the
docs/concept-links
branch
2 times, most recently
from
0386661
to
1e8c407
Compare
jannyHou
approved these changes
Aug 24, 2020
docs/site/Concepts.md
Outdated
| @@ -13,24 +14,24 @@ responsibilities for typical API and/or Microservice applications. | |||
|
|
|||
| - [**Application**](Application.md): The central class for setting up all of | |||
| your module’s components, controllers, servers and bindings. The Application | |||
| class extends [Context](Context.md) and provides the controls for starting and | |||
| stopping its associated servers. | |||
| class extends [Context](./Context.md) and provides the controls for starting | |||
There was a problem hiding this comment.
nitpick, it's ok to keep as Context.md for consistency
There was a problem hiding this comment.
Actually I had updated to relative paths, but undid it after seeing a lot more of non-breaking non-relative paths. It would be inconsistent to update only some of them in this PR; and I did not want to get into updating everything, you never know what new problems might be encountered. I wanted to make this PR a quick one. Let's keep "use of relative paths on all doc pages" as a task for another PR.
There was a problem hiding this comment.
Oh, I got what you mean. Updating.
Fixed missing links and added consistency. Signed-off-by: Yaapa Hage <[email protected]>
hacksparrow
force-pushed
the
docs/concept-links
branch
from
1e8c407
to
02fa0ab
Compare
raymondfeng
approved these changes
Aug 24, 2020
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Addresses #6176.
There were some inconsistencies in use of plurals, causing the links to fail. I have also renamed the title "Behind the scenes" to "Concepts", as it should be.
On my local machine, after running
npm run docs:prepare, I could not start the server withnpm run docs:startdue to this error:I had to comment out
{% include readmes/loopback-example-angular.md %}ondocs/_preview/pages/readmes/loopback-next/sandbox/loopback.io/README.mdto get it working.I don't know if the remote doc server will encounter the same error or not. If it is going to encounter the same error, land this only after fixing that issue first.
Checklist
npm testpasses on your machinepackages/cliwere updatedexamples/*were updated👉 Check out how to submit a PR 👈