mirror of
https://github.com/apple/container.git
synced 2026-09-28 10:35:38 +00:00
[docs]: move callout regarding documentation revisions (#921)
- Closes #920 - Makes note about main branch documentation more discoverable.
This commit is contained in:
@@ -58,11 +58,6 @@ uninstall-container.sh -k
|
||||
- [Build and run](./BUILDING.md) `container` on your own development system.
|
||||
- View the project [API documentation](https://apple.github.io/container/documentation/).
|
||||
|
||||
> [!IMPORTANT]
|
||||
> The links above are for the CURRENT BRANCH's documentation. To find documentation for official releases, find the target release on the [Release Page](https://github.com/apple/container/releases) and click the tag corresponding to your release version.
|
||||
>
|
||||
> Example: [release 0.4.1 tag](https://github.com/apple/container/tree/0.4.1)
|
||||
|
||||
## Contributing
|
||||
|
||||
Contributions to `container` are welcomed and encouraged. Please see our [main contributing guide](https://github.com/apple/containerization/blob/main/CONTRIBUTING.md) for more information.
|
||||
|
||||
@@ -1,5 +1,10 @@
|
||||
# Container CLI Command Reference
|
||||
|
||||
> [!IMPORTANT]
|
||||
> This file contains documentation for the CURRENT BRANCH. To find documentation for official releases, find the target release on the [Release Page](https://github.com/apple/container/releases) and click the tag corresponding to your release version.
|
||||
>
|
||||
> Example: [release 0.4.1 tag](https://github.com/apple/container/tree/0.4.1)
|
||||
|
||||
Note: Command availability may vary depending on host operating system and macOS version.
|
||||
|
||||
## Core Commands
|
||||
|
||||
@@ -1,5 +1,10 @@
|
||||
# How-to
|
||||
|
||||
> [!IMPORTANT]
|
||||
> This file contains documentation for the CURRENT BRANCH. To find documentation for official releases, find the target release on the [Release Page](https://github.com/apple/container/releases) and click the tag corresponding to your release version.
|
||||
>
|
||||
> Example: [release 0.4.1 tag](https://github.com/apple/container/tree/0.4.1)
|
||||
|
||||
How to use the features of `container`.
|
||||
|
||||
## Configure memory and CPUs for your containers
|
||||
|
||||
@@ -1,5 +1,10 @@
|
||||
# Technical Overview
|
||||
|
||||
> [!IMPORTANT]
|
||||
> This file contains documentation for the CURRENT BRANCH. To find documentation for official releases, find the target release on the [Release Page](https://github.com/apple/container/releases) and click the tag corresponding to your release version.
|
||||
>
|
||||
> Example: [release 0.4.1 tag](https://github.com/apple/container/tree/0.4.1)
|
||||
|
||||
A brief description and technical overview of `container`.
|
||||
|
||||
## What are containers?
|
||||
|
||||
@@ -1,5 +1,10 @@
|
||||
# Tutorial
|
||||
|
||||
> [!IMPORTANT]
|
||||
> This file contains documentation for the CURRENT BRANCH. To find documentation for official releases, find the target release on the [Release Page](https://github.com/apple/container/releases) and click the tag corresponding to your release version.
|
||||
>
|
||||
> Example: [release 0.4.1 tag](https://github.com/apple/container/tree/0.4.1)
|
||||
|
||||
Take a guided tour of `container` by building, running, and publishing a simple web server image.
|
||||
|
||||
## Try out the `container` CLI
|
||||
|
||||
Reference in New Issue
Block a user