Repository navigation
docs: restructure into Write, Configure, Deploy, Templates and Internals - #68
Merged
Merged
Conversation
2 of 3 tasks
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.
Part of #52 (work package 5: content restructure). Closes nothing; #52 stays open for work packages 8 and 9 and the docs snapshot step.
What changes
docs/is reorganised into five sections, each with an intro page and a_category_.json:edge -> injector -> Outlinepicture), Docker Compose, Injector, Image fetching, Limits, Security notes, Upgrading; coming soon: Helm/Kubernetes (#51), reverse-proxy recipes, Podmanneutral)website/src/pages/index.js(numbered list of the five sections, one line each), five sections in the navbar.docs/README.mdstays a plain table for GitHub and is excluded from the site.### \code`anchor each (#no_binding,#busy,#user_limit, ...).scripts/docs-error-codes.sh check` compares the codes in the source with the entries on the page (46 and 46).scripts/docs-catalogue/(Go, reuses the product's package loader and metadata resolver, so every block shown passed the real checks) generates the pages from the template packages. Tasksdocs:catalogue,docs:catalogue-check,docs:catalogue-preview,docs:errors-check. The preview imagedocs/assets/screens/template-neutral.pngis rendered with the real pipeline and committed.THIRD_PARTY_NOTICES, code comments and tests that named moved pages (only references to docs paths were touched outsidedocs/).Not done
docs:catalogue-checkanddocs:errors-check. Adding them is a workflow change (work package 8).package-lock.jsonin the repo root still has the nameoutline-latex-pdf(from the logo kit); not part of this PR.gateway,worker,tex) where the real error messages contain them.Test plan
assets/**are bundled.mddocs:catalogue-checkclean; the metadata blocks on the Write pages pass the real resolvertask sanitize,task test,task test-guard/adr/, a coming-soon page and the error anchors return 200; light and dark screenshots checked