Topic/docs refactor - #2032
Open
egernst wants to merge 6 commits into
Open
Conversation
github-actions
Bot
added
the
documentation
… volumes Signed-off-by: Eric Ernst <eric_ernst@apple.com>
Document --ulimit syntax, supported limit types, and how to inspect limits inside a container. Signed-off-by: Eric Ernst <eric_ernst@apple.com>
Anonymous volumes get a bare UUID, not the anon-{uuid} naming
command-reference.md claimed, so its own grep example matched nothing.
Move the fixed explanation into volumes.md alongside the rest of the
volumes docs, and trim command-reference.md to a pointer.
Signed-off-by: Eric Ernst <eric_ernst@apple.com>
DNS setup was split across three docs, each describing only one of the two required steps. Give it one canonical walkthrough in networking.md's new "Set up DNS-based container names" section, and trim the other docs to link there instead of re-deriving it. Also fixes a stale `container network list` example. Signed-off-by: Eric Ernst <eric_ernst@apple.com>
how-to.md had become a catch-all with no way to discover it beyond README's single link to it. Split its remaining sections into topic pages (resource usage, host integration, logs, multiplatform images, runtime configuration, inspection, shell completions), merge tmpfs into volumes.md as "Mounts and volumes", and move system-properties docs into container-system-config.md. how-to.md itself becomes a short index. README also gains a minimal "Run your first container" step before "Next steps". Signed-off-by: Eric Ernst <eric_ernst@apple.com>
egernst
force-pushed
the
topic/docs-refactor
branch
from
July 28, 2026 20:00
81cfc6d to
98693fc
Compare
Code Coverage
|
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
1 participant
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.
Important
All commits must be signed and verified. Pull requests containing unsigned or unverified commits cannot be built or merged. See the GitHub documentation for instructions.
For all but trivial fixes, make sure to first create a GitHub issue that concisely describes the bug or desired enhancement as justification for the change. Large PRs with no justifying issue will be closed.
Type of Change
Motivation and Context
[Why is this change needed?]
Refactor some of the documents so we have standalone topics, and cover more resource topics (ulimits)
Testing