From c48586a8c7140046bbb0051e51d99db1219f30fc Mon Sep 17 00:00:00 2001 From: Steve Kriss Date: Tue, 25 Jun 2019 08:57:05 -0600 Subject: [PATCH] update README.md link to install docs, minor reorg install docs content Signed-off-by: Steve Kriss --- README.md | 4 ++-- site/_data/shortlinks.yml | 3 +++ site/docs/master/README.md | 3 ++- site/docs/master/install-overview.md | 12 ++++++------ site/docs/v1.0.0/README.md | 3 ++- site/docs/v1.0.0/install-overview.md | 12 ++++++------ 6 files changed, 21 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 61f3637fb..011ca1799 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ You can run Velero in clusters on a cloud provider or on-premises. For detailed ## Installation We strongly recommend that you use an [official release][6] of Velero. The tarballs for each release contain the -`velero` command-line client. Follow the instructions under the **Install** section of [our documentation][29] to get started. +`velero` command-line client. Follow the [installation instructions][28] to get started. _The code and sample YAML files in the master branch of the Velero repository are under active development and are not guaranteed to be stable. Use them at your own risk!_ @@ -72,7 +72,7 @@ See [the list of releases][6] to find out about feature changes. [25]: https://kubernetes.slack.com/messages/velero [26]: https://velero.io/docs/zenhub - +[28]: https://velero.io/docs/install-overview [29]: https://velero.io/docs/ [30]: https://velero.io/docs/troubleshooting diff --git a/site/_data/shortlinks.yml b/site/_data/shortlinks.yml index ddd84c841..ffa78fe33 100644 --- a/site/_data/shortlinks.yml +++ b/site/_data/shortlinks.yml @@ -7,3 +7,6 @@ - title: ZenHub key: zenhub destination: zenhub +- title: Install Overview + key: install-overview + destination: install-overview diff --git a/site/docs/master/README.md b/site/docs/master/README.md index 03ec77405..681518920 100644 --- a/site/docs/master/README.md +++ b/site/docs/master/README.md @@ -20,7 +20,7 @@ You can run Velero in clusters on a cloud provider or on-premises. For detailed ## Installation We strongly recommend that you use an [official release][6] of Velero. The tarballs for each release contain the -`velero` command-line client. Follow the instructions under the **Install** section of [our documentation][29] to get started. +`velero` command-line client. Follow the [installation instructions][28] to get started. _The code and sample YAML files in the master branch of the Velero repository are under active development and are not guaranteed to be stable. Use them at your own risk!_ @@ -73,6 +73,7 @@ See [the list of releases][6] to find out about feature changes. [26]: /zenhub.md +[28]: install-overview.md [29]: https://velero.io/docs/master/ [30]: troubleshooting.md diff --git a/site/docs/master/install-overview.md b/site/docs/master/install-overview.md index 04f271a75..94f68625f 100644 --- a/site/docs/master/install-overview.md +++ b/site/docs/master/install-overview.md @@ -6,12 +6,6 @@ You can run Velero in any namespace, which requires additional customization. Se You can also use Velero's integration with restic, which requires additional setup. See [restic instructions][20]. -## Customize configuration - -Whether you run Velero on a cloud provider or on-premises, if you have more than one volume snapshot location for a given volume provider, you can specify its default location for backups by setting a server flag in your Velero deployment YAML. - -For details, see the documentation topics for individual cloud providers. - ## Cloud provider The Velero client includes an `install` command to specify the settings for each supported cloud provider. You can install Velero for the included cloud providers using the following command: @@ -54,6 +48,12 @@ the supported options. For example, if you use [Portworx][102] for persistent st of your Velero backups. If there is no native snapshot plugin available for your storage platform, you can use Velero's [restic integration][20], which provides a platform-agnostic backup solution for volume data. +## Customize configuration + +Whether you run Velero on a cloud provider or on-premises, if you have more than one volume snapshot location for a given volume provider, you can specify its default location for backups by setting a server flag in your Velero deployment YAML. + +For details, see the documentation topics for individual cloud providers. + ## Removing Velero If you would like to completely uninstall Velero from your cluster, the following commands will remove all resources created by `velero install`: diff --git a/site/docs/v1.0.0/README.md b/site/docs/v1.0.0/README.md index be1c1f5a3..4c91b4195 100644 --- a/site/docs/v1.0.0/README.md +++ b/site/docs/v1.0.0/README.md @@ -20,7 +20,7 @@ You can run Velero in clusters on a cloud provider or on-premises. For detailed ## Installation We strongly recommend that you use an [official release][6] of Velero. The tarballs for each release contain the -`velero` command-line client. Follow the instructions under the **Install** section of [our documentation][29] to get started. +`velero` command-line client. Follow the [installation instructions][28] to get started. _The code and sample YAML files in the master branch of the Velero repository are under active development and are not guaranteed to be stable. Use them at your own risk!_ @@ -73,6 +73,7 @@ See [the list of releases][6] to find out about feature changes. [26]: /zenhub.md +[28]: install-overview.md [29]: https://velero.io/docs/v1.0.0/ [30]: troubleshooting.md diff --git a/site/docs/v1.0.0/install-overview.md b/site/docs/v1.0.0/install-overview.md index 04f271a75..94f68625f 100644 --- a/site/docs/v1.0.0/install-overview.md +++ b/site/docs/v1.0.0/install-overview.md @@ -6,12 +6,6 @@ You can run Velero in any namespace, which requires additional customization. Se You can also use Velero's integration with restic, which requires additional setup. See [restic instructions][20]. -## Customize configuration - -Whether you run Velero on a cloud provider or on-premises, if you have more than one volume snapshot location for a given volume provider, you can specify its default location for backups by setting a server flag in your Velero deployment YAML. - -For details, see the documentation topics for individual cloud providers. - ## Cloud provider The Velero client includes an `install` command to specify the settings for each supported cloud provider. You can install Velero for the included cloud providers using the following command: @@ -54,6 +48,12 @@ the supported options. For example, if you use [Portworx][102] for persistent st of your Velero backups. If there is no native snapshot plugin available for your storage platform, you can use Velero's [restic integration][20], which provides a platform-agnostic backup solution for volume data. +## Customize configuration + +Whether you run Velero on a cloud provider or on-premises, if you have more than one volume snapshot location for a given volume provider, you can specify its default location for backups by setting a server flag in your Velero deployment YAML. + +For details, see the documentation topics for individual cloud providers. + ## Removing Velero If you would like to completely uninstall Velero from your cluster, the following commands will remove all resources created by `velero install`: