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

Docs/set docs hidden #61

Merged
merged 2 commits into from
Mar 22, 2024
Merged

Docs/set docs hidden #61

merged 2 commits into from
Mar 22, 2024

Conversation

clayton-cornell
Copy link
Contributor

PR Description

Set docs to be hidden, not published/indexed.

Which issue(s) this PR fixes

Notes to the Reviewer

PR Checklist

  • CHANGELOG.md updated
  • Documentation added
  • Tests updated
  • Config converters updated

@clayton-cornell clayton-cornell added the type/docs Docs Squad label across all Grafana Labs repos label Mar 22, 2024
Copy link
Member

@rfratto rfratto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

So, this will sync to grafana/website/content/docs/alloy/VERSION/*, and hide individual versions. I still wonder if we need to also add this to the metadata of grafana/website/content/docs/alloy/_index.md too (i.e., what if this change only hides individual versions but not the fact that the section exists)

@rfratto
Copy link
Member

rfratto commented Mar 22, 2024

One downside of this change: make docs hides everything from you now. If setting this on the _index.md one level above the version folder hides everything too, it might be better since it still allows you to view everything locally.

@clayton-cornell
Copy link
Contributor Author

clayton-cornell commented Mar 22, 2024

Wherever it's set, the topic/content is hidden and the TOC entry for the content is not generated. So if it's set one level deeper into the TOC, you still get nothing on the TOC side. You have to know the URL or click an on-page link to navigate to any topic in the tree.

If we really need to test the local build with TOC navigation, we can remove the flag in the working branch, run make docs, test, and then add it back before pushing.

@clayton-cornell clayton-cornell merged commit b36ee4b into main Mar 22, 2024
10 checks passed
@clayton-cornell clayton-cornell deleted the docs/set-docs-hidden branch March 22, 2024 20:10
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 22, 2024
@rfratto rfratto added the backport-to-agent:no PR should NOT be backported to the agent repo. label Apr 23, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
backport-to-agent:no PR should NOT be backported to the agent repo. frozen-due-to-age type/docs Docs Squad label across all Grafana Labs repos
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants