From 462e5443a89ecc27dad6a9e59a3f692adbf7d63f Mon Sep 17 00:00:00 2001 From: Jessica Yao Date: Tue, 15 Aug 2017 13:03:05 -0700 Subject: [PATCH] use same versioning warning across the board Signed-off-by: Jessica Yao --- README.md | 8 +++----- docs/cloud-provider-specifics.md | 3 +++ 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index f3ad3b9cc..5ee9a4a57 100644 --- a/README.md +++ b/README.md @@ -45,11 +45,9 @@ Clone or fork the Heptio Ark repo: git clone git@github.com:heptio/ark.git ``` -Checkout the appropriate tag for the Ark version you wish to use (e.g. replacing `` with "v0.3.3"): -``` -git checkout -``` -You should `git checkout master` only if you're planning on [building the Ark image from scratch][7]. +> NOTE: Documentation may change between releases. See the [Changelog][20] for links to previous versions of this repository and its docs. +> +> To ensure that you are working off a specific release, `git checkout ` where `` is the appropriate tag for the Ark version you wish to use (e.g. "v0.3.3"). You should `git checkout master` only if you're planning on [building the Ark image from scratch][7]. ### 2. Setup diff --git a/docs/cloud-provider-specifics.md b/docs/cloud-provider-specifics.md index d89ccc2f3..25ac349dd 100644 --- a/docs/cloud-provider-specifics.md +++ b/docs/cloud-provider-specifics.md @@ -1,6 +1,8 @@ # Cloud Provider Specifics > NOTE: Documentation may change between releases. See the [Changelog][20] for links to previous versions of this repository and its docs. +> +> To ensure that you are working off a specific release, `git checkout ` where `` is the appropriate tag for the Ark version you wish to use (e.g. "v0.3.3"). You should `git checkout master` only if you're planning on [building the Ark image from scratch][21]. While the [Quickstart][0] uses a local storage service to quickly set up Heptio Ark as a demonstration, this document details additional configurations that are required when integrating with the cloud providers below: @@ -362,3 +364,4 @@ ark restore create nginx-backup --restore-volumes [18]: https://docs.microsoft.com/en-us/azure/storage/storage-azure-cli [19]: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#reclaiming [20]: /CHANGELOG.md +[21]: /docs/build-from-scratch.md