Repository navigation
docs: move the role and plugin rules to docs/developer-guide/ - #796
Merged
Merged
Conversation
CONTRIBUTING.md (85 KB) is beyond what people and coding agents read in full. Its Ansible guidelines move into nine files under docs/developer-guide/ (playbooks, plugins, roles, systemd, tasks, templates, testing, upstream, variables), each listed in a table in CONTRIBUTING.md with when to read it. CONTRIBUTING.md keeps the style guide, deliverables, OS coverage, security by default and the changelog sections, and shrinks to 14 KB. A word count over all files shows no change apart from the new table and the title "systemd". Quoted section names that now point to another file become links, and relative links follow the move. The 38 references to CONTRIBUTING.md sections in roles, Molecule, tests, tools/maintenance.yml and the follow-upstream skill point to the new files. tools/build-docs lists docs/developer-guide/ in the mkdocs nav, and writes docs/contributing.md as a copy whose links into docs/developer-guide/ work on the documentation site. A build compared against main shows no new link findings.
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.
CONTRIBUTING.md(85 KB) is beyond what people and coding agents read in full; the Linuxfabrik Standards set a limit of 50 KB. Its Ansible guidelines move into nine files underdocs/developer-guide/, each listed in a table inCONTRIBUTING.mdthat says when to read it:roles.mdvariables.mdtesting.mdtasks.mdsystemd.mdupstream.mdtemplates.mdplugins.mdplaybooks.mdCONTRIBUTING.mdkeeps the style guide, commit scopes, deliverables, OS coverage, security by default, the changelog sections and the credits, and shrinks to 14 KB.A word count over all files against the original shows no change apart from the new table and the title "systemd". Quoted section names that now point to another file become links, and relative links follow the move; every link and anchor resolves.
The 38 references to
CONTRIBUTING.mdsections in roles,roles/shared/README.md, Molecule,.gitignore,tests/unit/test_playbooks.py,tools/maintenance.ymland thelfops-follow-upstreamskill point to the new files.tools/build-docslistsdocs/developer-guide/in the mkdocs nav under "Developer Guide", and writesdocs/contributing.mdas a copy in which links intodocs/developer-guide/work on the documentation site.This is a move only; the adoption of the shared standards block follows in a pull request of its own.
Checks:
mkdocs buildwith the pinned versions aftertools/build-docs, compared againstmain: no new findings.tools/sync-standards checkpasses.tools/build-docschanged; CI runs the unit tests.