Update Terraform reference category page locations #47955
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
ptgott
requested review from
klizhentas,
russjones,
r0mant,
zmb3,
fheinecke,
camscale,
tcsc,
rosstimothy and
codingllama
as code owners
github-actions
bot
requested review from
bernardjkim,
hugoShaka,
marcoandredinis,
mmcallister,
tigrato and
xinding33
|
I am going to backport this manually along with the backports of #47797. |
|
This pull request is automatically being deployed by Amplify Hosting (learn more). |
|
🤖 Vercel preview here: https://docs-jlfqe7oka-goteleport.vercel.app/docs/ver/preview |
hugoShaka
approved these changes
Oct 28, 2024
tigrato
approved these changes
Oct 28, 2024
public-teleport-github-review-bot
bot
removed request for
marcoandredinis,
mmcallister,
bernardjkim and
xinding33
ptgott
added
the
no-changelog
ptgott
force-pushed
the
paul.gottschling/2024-10-24-tf-ref-structure
branch
from
02fc215 to
bad3911
Compare
|
🤖 Vercel preview here: https://docs-lbkiqy0op-goteleport.vercel.app/docs/ver/preview |
ptgott
force-pushed
the
paul.gottschling/2024-10-24-tf-ref-structure
branch
from
bad3911 to
c2f5a68
Compare
|
🤖 Vercel preview here: https://docs-4kk9x2fdh-goteleport.vercel.app/docs/ver/preview |
ptgott
force-pushed
the
paul.gottschling/2024-10-24-tf-ref-structure
branch
from
c2f5a68 to
a0c6f28
Compare
|
🤖 Vercel preview here: https://docs-pu6jhgs5o-goteleport.vercel.app/docs/ver/preview |
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/2024-10-24-tf-ref-structure
branch
from
a0c6f28 to
79aca1e
Compare
|
🤖 Vercel preview here: https://docs-o7dx9s605-goteleport.vercel.app/docs/ver/preview |
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.
This was referenced Oct 30, 2024
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.
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.
As with #47797, Docusaurus expects category index pages to be within--and named after--their parent directories. (Docusaurus also accepts the names
READMEandindexfor category pages, but we are not using this convention.) This change applies this standard to our Terraform provider reference docs.lint.yamlworkflow.