Repository navigation
docs: mark unpublished docs pages as draft - #32351
Draft
nickvigilante wants to merge 2 commits into
Draft
nickvigilante wants to merge 2 commits into
nickvigilante wants to merge 2 commits into
Conversation
The OpenTofu page is a placeholder that was never added to the docs manifest, so it is not published, and the glossary link to it 404s on coder.com. Linkspector does not catch the broken link because the file exists in the repository. Mark the page with draft: true so its unpublished state is explicit, and remove the only link to it. DOCS-1779
The template-author external-auth page has never been in the docs manifest, so it is not published. Mark it with draft: true until it is refreshed and added to the sidebar. DOCS-1779
This branch was previously deployed
This file contains hidden or 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
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.
Two pages under
docs/aren't in the docs manifest, so they aren't published. This PR addsdraft: trueto their front matter so their unpublished state is explicit:docs/admin/integrations/opentofu.md: a placeholder for custom Terraform binaries.docs/templates/extending-templates/external-auth.md: the template-author external-auth page, which has never been in the manifest. DOCS-1213 tracks refreshing it and adding it to the sidebar.The glossary's OpenTofu entry links to the OpenTofu page, so readers who follow that link on coder.com/docs/reference/glossary get a 404. Linkspector doesn't catch it because the linked file exists in the repository. This PR removes that link, which is the only link to either page in the repository. coder/coder.com has no links to them either.
The docs tooling doesn't read
draft:yet, and docs-engine drops front matter keys it doesn't know, so nothing changes in the build. DOCS-1412 tracks defining the key and checking it against the manifest, and DOCS-1780 tracks failing the link check on links to draft pages.Production serves
release/2.39as the mainline version, and that branch has the same glossary link, so this PR has thecherry-picklabel. A localgit merge-treeof this branch ontorelease/2.39applies cleanly, and rename detection puts the external-auth change on that branch's older path,docs/admin/templates/extending-templates/external-auth.md.Checks run locally:
make lint/docs-manifest lint/docs-html lint/docs-redirects lint/emdash lint/style-claims, markdownlint, markdown-table-formatter, and Vale on the changed files. All pass.Linear: DOCS-1779
Note
Generated by Coder Agents on behalf of @nickvigilante.