Restructure docs menu pages #47797
Merged
Restructure docs menu pages #47797
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
greedy52,
hugoShaka,
Joerger,
kimlisa,
mmcallister,
nklaassen,
r0mant,
ravicious,
rosstimothy,
strideynet,
tigrato,
timothyb89,
xinding33 and
zmb3
|
Reviewer notes:
|
|
This pull request is automatically being deployed by Amplify Hosting (learn more). |
|
🤖 Vercel preview here: https://docs-ms4odugcs-goteleport.vercel.app/docs/ver/preview |
ptgott
force-pushed
the
paul.gottschling/2024-10-nav-fix
branch
from
9994ebb to
0680c2a
Compare
|
🤖 Vercel preview here: https://docs-gnmntn1kl-goteleport.vercel.app/docs/ver/preview |
xinding33
approved these changes
Oct 23, 2024
mmcallister
approved these changes
Oct 23, 2024
public-teleport-github-review-bot
bot
removed request for
ravicious,
r0mant,
timothyb89,
tigrato and
zmb3
ptgott
added a commit
that referenced
this pull request
Oct 28, 2024
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
added a commit
that referenced
this pull request
Oct 28, 2024
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.
github-merge-queue bot
pushed a commit
that referenced
this pull request
Oct 29, 2024
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
added a commit
that referenced
this pull request
Oct 29, 2024
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.
ptgott
added a commit
that referenced
this pull request
Oct 29, 2024
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
added a commit
that referenced
this pull request
Oct 29, 2024
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
added a commit
that referenced
this pull request
Oct 29, 2024
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
added a commit
that referenced
this pull request
Oct 30, 2024
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
added a commit
that referenced
this pull request
Oct 30, 2024
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.
ptgott
added a commit
that referenced
this pull request
Oct 30, 2024
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.
ptgott
added a commit
that referenced
this pull request
Oct 30, 2024
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.
This was referenced Oct 30, 2024
ptgott
added a commit
that referenced
this pull request
Oct 30, 2024
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.
github-merge-queue bot
pushed a commit
that referenced
this pull request
Oct 30, 2024
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.
github-merge-queue bot
pushed a commit
that referenced
this pull request
Oct 30, 2024
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.
ptgott
added a commit
that referenced
this pull request
Oct 30, 2024
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.
ptgott
added a commit
that referenced
this pull request
Oct 30, 2024
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
added a commit
that referenced
this pull request
Oct 30, 2024
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
added a commit
that referenced
this pull request
Oct 30, 2024
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
added a commit
that referenced
this pull request
Oct 30, 2024
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.
github-merge-queue bot
pushed a commit
that referenced
this pull request
Oct 30, 2024
* Restructure docs menu pages 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. * Update Terraform reference category page locations 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.
github-merge-queue bot
pushed a commit
that referenced
this pull request
Oct 30, 2024
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
added a commit
that referenced
this pull request
Oct 31, 2024
Add redirects based on changes in #47797
ptgott
added a commit
that referenced
this pull request
Nov 1, 2024
Add redirects based on changes in #47797
ptgott
added a commit
that referenced
this pull request
Nov 19, 2024
Add redirects based on changes in #47797
github-merge-queue bot
pushed a commit
that referenced
this pull request
Nov 19, 2024
Add redirects based on changes in #47797
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.
Docusaurus sidebar
generation expects category index pages to have one of three file path conventions:
section/index.mdxsection/README.mdxsection/section.mdxThis 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.