[v16] Restructure docs menu pages #48149
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
github-actions
bot
requested review from
hugoShaka,
mmcallister,
tigrato and
xinding33
|
This pull request is automatically being deployed by Amplify Hosting (learn more). |
hugoShaka
approved these changes
Oct 30, 2024
|
🤖 Vercel preview here: https://docs-bhmkr4y6w-goteleport.vercel.app/docs/ver/preview |
tigrato
approved these changes
Oct 30, 2024
public-teleport-github-review-bot
bot
removed request for
mmcallister and
xinding33
ptgott
added
the
no-changelog
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
Backports #47797 Docusaurus [sidebar generation](https://docusaurus.io/docs/next/sidebar/autogenerated) expects category index pages to have one of three file path conventions: - `section/index.mdx` - `section/README.mdx` - `section/section.mdx` This change standardizes category index paths on the third convention so Docusaurus sidebar generation succeeds. We can then add checks to the current docs site to prevent additional menu pages from violating this convention. This change also adds redirects to the new category index pages, and updates internal links to pages that were moved. Note that this change does not move all relevant menu pages. We still need to reorganize the `reference/terraform-provider` section. Since this section is automatically generated, we need another approach to restructuring it.
Backports #47955 As with #47797, Docusaurus expects category index pages to be within--and named after--their parent directories. (Docusaurus also accepts the names `README` and `index` for category pages, but we are not using this convention.) This change applies this standard to our Terraform provider reference docs. - Update paths in the generator configuration. Assume that each category index page is in the same subdirectory as its contents. - Update paths in the `lint.yaml` workflow. - Fix internal links.
ptgott
force-pushed
the
paul.gottschling/47797-bp-v16
branch
from
73dfa4c to
cae5ae1
Compare
|
🤖 Vercel preview here: https://docs-58jo1991r-goteleport.vercel.app/docs/ver/preview |
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.
Backports #47797 and #47955