docs: move "Reserved binding keys" to "Reference guides" #5775
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
bajtos
force-pushed
the
docs/move-reserved-binding-keys
branch
from
4a62f7e to
58ada00
Compare
This was referenced Jun 19, 2020
hacksparrow
approved these changes
Jun 19, 2020
raymondfeng
requested changes
Jun 19, 2020
| @@ -4,11 +4,10 @@ title: 'Reserved binding keys' | |||
| keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI | |||
| toc_level: 1 | |||
| sidebar: lb4_sidebar | |||
| permalink: /doc/en/lb4/Reserved-binding-keys.html | |||
| permalink: /doc/en/lb4/reference-reserved-binding-keys.html | |||
There was a problem hiding this comment.
Let's capitalize the first letter to be consistent with our urls.
/doc/en/lb4/Reference-reserved-binding-keys.html
There was a problem hiding this comment.
I would like to transition our URL scheme to all-lowercase names and eventually to nested paths (/reference/reserved-binding-keys.html) to match the directory layout in docs/site.
I encountered some issues when using nested paths, so I am using - instead of / for now:
reference/reserved-binding-keys.md -> reference-reserved-binding-keys.html
We are already following the all-lowercase slug style in migration guide, see e.g. here:
docs/site/sidebars/lb4_sidebar.yml
Outdated
| @@ -563,6 +559,10 @@ children: | |||
| url: apidocs.index.html | |||
| output: 'web, pdf' | |||
|
|
|||
| - title: 'Reserved binding keys' | |||
| url: reference-reserved-binding-keys.html | |||
dhmlau
approved these changes
Jun 19, 2020
This was referenced Jun 22, 2020
|
Based on discussion with @raymondfeng, we will stick with Sentence-style.html to land my PRs and then normalize URL slugs afterwards, as this part may take a bit longer to reach consensus. |
bajtos
force-pushed
the
docs/move-reserved-binding-keys
branch
from
58ada00 to
ffccaf0
Compare
raymondfeng
approved these changes
Jun 22, 2020
Also remove "Overview" heading from the page. I feel the heading is redundant when there are no other headings. Before this change, the page was rendered with a single-item Table of Contents at the top, which looked weird to me. After this change, the pages is rendered as a single block with the page title as the only heading. Signed-off-by: Miroslav Bajtoš <[email protected]>
bajtos
force-pushed
the
docs/move-reserved-binding-keys
branch
from
ffccaf0 to
95606b2
Compare
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.
Also remove "Overview" heading from the page. I feel the heading is redundant when there are no other headings. Before this change, the page was rendered with a single-item Table of Contents at the top, which looked weird to me. After this change, the pages is rendered as a single block with the page title as the only heading.
This is a follow-up to #5718, see also #5549.
Checklist
👉 Read and sign the CLA (Contributor License Agreement) 👈
npm testpasses on your machinepackages/cliwere updatedexamples/*were updated👉 Check out how to submit a PR 👈