Repository navigation
docs: standardize image deployment guides - #17
Merged
Merged
Conversation
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
Defines and applies a reusable image-guide contract so future images enter the catalog with complete, safe, and operationally useful documentation.
This PR is stacked on #16 because the standardized Maddy guide documents the v0.9.5 paths and commands introduced there. Merge #16 first, then retarget this PR to
main.Guide standard
Adds
docs/image-guide-template.mdwith required sections for:Adds
scripts/validate-image-guides.pyand a required CI job. It validates all five catalog guides and rejects dangerous patterns such as recursive world-writable permissions, hard-coded aria2 RPC secrets, destructive database-reset advice, and legacy Compose commands. It also checks repository-owned Compose policy.Guide and Compose updates
All repository-owned Compose files now omit obsolete top-level
versionkeys and use consistent logging/volume syntax.Verification
Publishing impact
No Docker image is published or deleted. Documentation and historical Compose behavior are made safer, but archived entries remain explicitly unsupported for new deployments.