Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[v17] Update Terraform reference category page locations #48148

Merged
merged 1 commit into from
Oct 30, 2024

Conversation

ptgott
Copy link
Contributor

@ptgott ptgott commented 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.

Copy link

🤖 Vercel preview here: https://docs-4b61h137u-goteleport.vercel.app/docs/ver/preview

@ptgott ptgott added the no-changelog Indicates that a PR does not require a changelog entry label Oct 30, 2024
@ptgott ptgott enabled auto-merge October 30, 2024 18:22
@ptgott ptgott force-pushed the paul.gottschling/47797-bp-v17 branch from 496d53b to 656b106 Compare October 30, 2024 19:48
Copy link

🤖 Vercel preview here: https://docs-m4q04j5on-goteleport.vercel.app/docs/ver/preview

@ptgott ptgott force-pushed the paul.gottschling/47797-bp-v17 branch from 656b106 to a2ffb73 Compare October 30, 2024 20:18
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.
Copy link

🤖 Vercel preview here: https://docs-o53raav5j-goteleport.vercel.app/docs/ver/preview

@ptgott ptgott added this pull request to the merge queue Oct 30, 2024
Merged via the queue into branch/v17 with commit 5a04efa Oct 30, 2024
41 of 42 checks passed
@ptgott ptgott deleted the paul.gottschling/47797-bp-v17 branch October 30, 2024 21:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport documentation no-changelog Indicates that a PR does not require a changelog entry size/sm
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants