- Closes#568.
## Type of Change
- [ ] Bug fix
- [ ] New feature
- [ ] Breaking change
- [x] Documentation update
## Motivation and Context
Uninstall script will fail with an informative message if the users
doesn't run `container system stop`, but including this step in the
upgrade process reinforces the need to do this. Upgrading without
restarting the service can lead to unexpected failures due to API or
persistent data incompatibility.
## Testing
- [ ] Tested locally
- [ ] Added/updated tests
- [x] Added/updated docs
Clarify that container is only supported on macOS 26, and remove
language that implies that it's also designed for macOS 15.
This change also includes a couple of minor Apple Style Guide changes,
and links to the OCI container image format for clarity.
The demonstration is that patch versions can be updated without breaking
changes, and that minor versions include breaking changes.
Please excuse the small documentation commit, just caused me a moment of
confusion.
Closes https://github.com/apple/container/issues/80
Adds the following help message if you try to run `container` against a
host that hasn't started the container system:
```
❯ /usr/local/bin/container list
Error: internalError: "failed to list containers" (cause: "interrupted: "Connection invalid: ensure container system has been started with `container system start`"")
❯ /usr/local/bin/container run -it --rm docker.io/alpine
Error: interrupted: "Connection invalid: ensure container system has been started with `container system start`"
```
- Switched to use bookworm Python image as `curl` is not in slim.
- Use `pre` tags for console blocks. We lose syntax highlighting, but
get rid of the copy button.
- Fix `dockerfile` tag in tutorial.
- Fix GitHub typo in README.
Moves the introductory animation/image to beneath a title for the README
and the initial introductory text. Explains what you're seeing a bit
better, while still keeping the image "above the fold" to make it
prominent and encourage people to see and understand what this project
does.
* Remove local `CODE-OF-CONDUCT.md` as we are now using the organization
one.
* Update `SECURITY.md`'s title to
```diff
- # Security process
+ # Security disclosure process
```
* Remove extra space in `CONTRIBUTING.md` title
* Add contribution section in `README.md`
- Extract README sections into BUILDING and CONTRIBUTING documents. This
should work better than sections in README as it keeps the README short,
and the BUILDING and CONTRIBUTING files will stand out in the file list.
- Merged localdev document into BUILDING.
- Fixed broken links.
- Changed DNS setup so later DNS-dependent steps should work.
- Added h1 and link to SECURITY document.
J Logan