-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[v16] Restructure docs menu pages (#48149)
* 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.
- Loading branch information
Showing
195 changed files
with
847 additions
and
841 deletions.
There are no files selected for viewing
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
Oops, something went wrong.