From a5fd902893c5687cf648cee0ba036f92fb5cf3d9 Mon Sep 17 00:00:00 2001 From: Saehej Kang Date: Tue, 2 Dec 2025 05:12:42 -0800 Subject: [PATCH] [docs]: move callout regarding documentation revisions (#921) - Closes #920 - Makes note about main branch documentation more discoverable. --- README.md | 5 ----- docs/command-reference.md | 5 +++++ docs/how-to.md | 5 +++++ docs/technical-overview.md | 5 +++++ docs/tutorial.md | 5 +++++ 5 files changed, 20 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index d30df676..b6ce1a3d 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/docs/command-reference.md b/docs/command-reference.md index fcd05d64..8430842d 100644 --- a/docs/command-reference.md +++ b/docs/command-reference.md @@ -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 diff --git a/docs/how-to.md b/docs/how-to.md index bd86e414..22069994 100644 --- a/docs/how-to.md +++ b/docs/how-to.md @@ -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 diff --git a/docs/technical-overview.md b/docs/technical-overview.md index 02d62d89..715c2db0 100644 --- a/docs/technical-overview.md +++ b/docs/technical-overview.md @@ -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? diff --git a/docs/tutorial.md b/docs/tutorial.md index 8c75a60d..20e9db76 100644 --- a/docs/tutorial.md +++ b/docs/tutorial.md @@ -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