docs: fix broken links and link every guide from a README - #165
Merged
Conversation
alix-graylog
approved these changes
Aug 5, 2026
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.
Summary
Four repository links are broken, five guides have no inbound link, and one code block mixes a command with its output.
Details
README.md:[examples](/examples/)used a site-root path, which does not resolve on GitHub. It is nowexamples/.charts/graylog/README.md: the cert-manager section linked to#bring-your-own-certificate-ingress-controller-recommended. The heading is### Option 1: Bring Your Own Certificate with Ingress Controller (recommended), so the anchor is#option-1-bring-your-own-certificate-with-ingress-controller-recommended.docs/TESTING.md: the links toCONTRIBUTING.mdandREADME.mdwere sibling links. They resolved todocs/CONTRIBUTING.mdanddocs/README.md, and neither file exists. They now point to../CONTRIBUTING.mdand../charts/graylog/README.md, which is the chart reference that the link text names.README.md: added a Guides section. No document linked todocs/GeoIP_Sidecar_Deployment_Guide.md. Four more pages had no link from either README, butCONTRIBUTING.md:21,32,72links the Testing, MicroK8s, and Releasing guides, anddocs/bring-your-own-opensearch.md:19links the MongoDB guide.docs/graylog-secrets.md: the hash example put a$prompt and the output in one copyable block. The command is now its own block, and the output is separate. The command usesprintfandcut, so it returns the digest that the document prints.Linked issues
None.
PR Checklist
Please check the items that apply to your change.
Testing Checklist
Static Validation
helm lint ./charts/grayloghelm template graylog ./charts/graylog --validate--validateneeds the MongoDB Operator CRD. The test cluster does not have it.helm templatewithout--validatepasses.Installation
helm install graylog ./charts/graylogkubectl rollout status statefulset/grayloghelm test graylogFunctional (if applicable)
Upgrade (if applicable)
This change edits documentation only. The installation, functional, and upgrade tests did not run.
Specific to this PR
docs/now has one inbound link or more from a README. Before this change, no document linked toGeoIP_Sidecar_Deployment_Guide.md.printf %s 'my-password' | sha256sum | cut -d ' ' -f1returns the digest that the document prints.Notes for reviewers
The link checker is not in CI. With it in CI, these four links cannot come back.