From effa5dbeee05c33e501c78af400b8faa3aab0f82 Mon Sep 17 00:00:00 2001 From: Steve Kriss Date: Fri, 17 May 2019 12:45:17 -0600 Subject: [PATCH 1/2] add 1.0 docs Signed-off-by: Steve Kriss --- site/_config.yml | 10 +++++----- site/_data/toc-mapping.yml | 2 +- site/_data/{v1-0-rc-1-toc.yml => v1-0-toc.yml} | 0 site/_includes/version-warning.html | 13 ++++--------- site/docs/master/README.md | 3 +-- site/docs/{v1.0.0-rc.1 => v1.0.0}/README.md | 9 ++++----- site/docs/{v1.0.0-rc.1 => v1.0.0}/about.md | 0 .../{v1.0.0-rc.1 => v1.0.0}/api-types/README.md | 0 .../{v1.0.0-rc.1 => v1.0.0}/api-types/backup.md | 0 .../api-types/backupstoragelocation.md | 0 .../api-types/volumesnapshotlocation.md | 0 site/docs/{v1.0.0-rc.1 => v1.0.0}/aws-config.md | 0 site/docs/{v1.0.0-rc.1 => v1.0.0}/azure-config.md | 0 .../{v1.0.0-rc.1 => v1.0.0}/build-from-source.md | 0 .../{v1.0.0-rc.1 => v1.0.0}/debugging-install.md | 0 .../{v1.0.0-rc.1 => v1.0.0}/debugging-restores.md | 0 site/docs/{v1.0.0-rc.1 => v1.0.0}/disaster-case.md | 0 site/docs/{v1.0.0-rc.1 => v1.0.0}/extend.md | 0 site/docs/{v1.0.0-rc.1 => v1.0.0}/faq.md | 0 site/docs/{v1.0.0-rc.1 => v1.0.0}/gcp-config.md | 0 site/docs/{v1.0.0-rc.1 => v1.0.0}/get-started.md | 0 site/docs/{v1.0.0-rc.1 => v1.0.0}/hooks.md | 3 ++- site/docs/{v1.0.0-rc.1 => v1.0.0}/ibm-config.md | 0 site/docs/{v1.0.0-rc.1 => v1.0.0}/image-tagging.md | 0 site/docs/{v1.0.0-rc.1 => v1.0.0}/img/README.md | 0 .../{v1.0.0-rc.1 => v1.0.0}/img/backup-process.png | Bin site/docs/{v1.0.0-rc.1 => v1.0.0}/img/velero.png | Bin .../{v1.0.0-rc.1 => v1.0.0}/install-overview.md | 0 site/docs/{v1.0.0-rc.1 => v1.0.0}/locations.md | 0 .../{v1.0.0-rc.1 => v1.0.0}/migrating-to-velero.md | 0 .../docs/{v1.0.0-rc.1 => v1.0.0}/migration-case.md | 0 site/docs/{v1.0.0-rc.1 => v1.0.0}/namespace.md | 0 .../{v1.0.0-rc.1 => v1.0.0}/output-file-format.md | 0 site/docs/{v1.0.0-rc.1 => v1.0.0}/plugins.md | 0 site/docs/{v1.0.0-rc.1 => v1.0.0}/rbac.md | 0 site/docs/{v1.0.0-rc.1 => v1.0.0}/restic.md | 0 .../docs/{v1.0.0-rc.1 => v1.0.0}/support-matrix.md | 4 ++++ .../{v1.0.0-rc.1 => v1.0.0}/troubleshooting.md | 0 .../docs/{v1.0.0-rc.1 => v1.0.0}/upgrade-to-1.0.md | 0 .../vendoring-dependencies.md | 0 site/docs/{v1.0.0-rc.1 => v1.0.0}/zenhub.md | 0 site/index.html | 4 ++-- 42 files changed, 23 insertions(+), 25 deletions(-) rename site/_data/{v1-0-rc-1-toc.yml => v1-0-toc.yml} (100%) rename site/docs/{v1.0.0-rc.1 => v1.0.0}/README.md (89%) rename site/docs/{v1.0.0-rc.1 => v1.0.0}/about.md (100%) rename site/docs/{v1.0.0-rc.1 => v1.0.0}/api-types/README.md (100%) rename site/docs/{v1.0.0-rc.1 => v1.0.0}/api-types/backup.md (100%) rename site/docs/{v1.0.0-rc.1 => v1.0.0}/api-types/backupstoragelocation.md (100%) rename site/docs/{v1.0.0-rc.1 => v1.0.0}/api-types/volumesnapshotlocation.md (100%) rename site/docs/{v1.0.0-rc.1 => v1.0.0}/aws-config.md (100%) rename site/docs/{v1.0.0-rc.1 => v1.0.0}/azure-config.md (100%) rename site/docs/{v1.0.0-rc.1 => v1.0.0}/build-from-source.md (100%) rename site/docs/{v1.0.0-rc.1 => v1.0.0}/debugging-install.md (100%) rename site/docs/{v1.0.0-rc.1 => v1.0.0}/debugging-restores.md (100%) rename site/docs/{v1.0.0-rc.1 => v1.0.0}/disaster-case.md (100%) rename site/docs/{v1.0.0-rc.1 => v1.0.0}/extend.md (100%) rename site/docs/{v1.0.0-rc.1 => v1.0.0}/faq.md (100%) rename site/docs/{v1.0.0-rc.1 => v1.0.0}/gcp-config.md (100%) rename site/docs/{v1.0.0-rc.1 => v1.0.0}/get-started.md (100%) rename site/docs/{v1.0.0-rc.1 => v1.0.0}/hooks.md (96%) rename site/docs/{v1.0.0-rc.1 => v1.0.0}/ibm-config.md (100%) rename site/docs/{v1.0.0-rc.1 => v1.0.0}/image-tagging.md (100%) rename site/docs/{v1.0.0-rc.1 => v1.0.0}/img/README.md (100%) rename site/docs/{v1.0.0-rc.1 => v1.0.0}/img/backup-process.png (100%) rename site/docs/{v1.0.0-rc.1 => v1.0.0}/img/velero.png (100%) rename site/docs/{v1.0.0-rc.1 => v1.0.0}/install-overview.md (100%) rename site/docs/{v1.0.0-rc.1 => v1.0.0}/locations.md (100%) rename site/docs/{v1.0.0-rc.1 => v1.0.0}/migrating-to-velero.md (100%) rename site/docs/{v1.0.0-rc.1 => v1.0.0}/migration-case.md (100%) rename site/docs/{v1.0.0-rc.1 => v1.0.0}/namespace.md (100%) rename site/docs/{v1.0.0-rc.1 => v1.0.0}/output-file-format.md (100%) rename site/docs/{v1.0.0-rc.1 => v1.0.0}/plugins.md (100%) rename site/docs/{v1.0.0-rc.1 => v1.0.0}/rbac.md (100%) rename site/docs/{v1.0.0-rc.1 => v1.0.0}/restic.md (100%) rename site/docs/{v1.0.0-rc.1 => v1.0.0}/support-matrix.md (93%) rename site/docs/{v1.0.0-rc.1 => v1.0.0}/troubleshooting.md (100%) rename site/docs/{v1.0.0-rc.1 => v1.0.0}/upgrade-to-1.0.md (100%) rename site/docs/{v1.0.0-rc.1 => v1.0.0}/vendoring-dependencies.md (100%) rename site/docs/{v1.0.0-rc.1 => v1.0.0}/zenhub.md (100%) diff --git a/site/_config.yml b/site/_config.yml index afed999a33..be5dbee33a 100644 --- a/site/_config.yml +++ b/site/_config.yml @@ -49,10 +49,10 @@ defaults: gh: https://github.com/heptio/velero/tree/master layout: "docs" - scope: - path: docs/v1.0.0-rc.1 + path: docs/v1.0.0 values: - version: v1.0.0-rc.1 - gh: https:/github.com/heptio/velero/tree/v1.0.0-rc.1 + version: v1.0.0 + gh: https:/github.com/heptio/velero/tree/v1.0.0 layout: "docs" - scope: path: docs/v0.11.0 @@ -126,10 +126,10 @@ collections: - casestudies versioning: true -latest: v0.11.0 +latest: v1.0.0 versions: - master -- v1.0.0-rc.1 +- v1.0.0 - v0.11.0 - v0.10.0 - v0.9.0 diff --git a/site/_data/toc-mapping.yml b/site/_data/toc-mapping.yml index f1c9c353f7..ab2dffcdca 100644 --- a/site/_data/toc-mapping.yml +++ b/site/_data/toc-mapping.yml @@ -3,7 +3,7 @@ # that the navigation for older versions still work. master: master-toc -v1.0.0-rc.1: v1-0-rc-1-toc +v1.0.0: v1-0-toc v0.11.0: v011-toc v0.10.0: v010-toc v0.9.0: v9-toc diff --git a/site/_data/v1-0-rc-1-toc.yml b/site/_data/v1-0-toc.yml similarity index 100% rename from site/_data/v1-0-rc-1-toc.yml rename to site/_data/v1-0-toc.yml diff --git a/site/_includes/version-warning.html b/site/_includes/version-warning.html index 74b5338ed4..fa89a0cfb0 100644 --- a/site/_includes/version-warning.html +++ b/site/_includes/version-warning.html @@ -1,3 +1,4 @@ +{% if page.version != site.latest %} {% endif %} - \ No newline at end of file diff --git a/site/docs/master/README.md b/site/docs/master/README.md index 37456846e7..03ec774058 100644 --- a/site/docs/master/README.md +++ b/site/docs/master/README.md @@ -20,8 +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 -command-line client **and** version-specific sample YAML files for deploying Velero to your cluster. -Follow the instructions under the **Install** section of [our documentation][29] to get started. +`velero` command-line client. Follow the instructions under the **Install** section of [our documentation][29] 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!_ diff --git a/site/docs/v1.0.0-rc.1/README.md b/site/docs/v1.0.0/README.md similarity index 89% rename from site/docs/v1.0.0-rc.1/README.md rename to site/docs/v1.0.0/README.md index 33f8939484..be1c1f5a30 100644 --- a/site/docs/v1.0.0-rc.1/README.md +++ b/site/docs/v1.0.0/README.md @@ -20,14 +20,13 @@ 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 -command-line client **and** version-specific sample YAML files for deploying Velero to your cluster. -Follow the instructions under the **Install** section of [our documentation][29] to get started. +`velero` command-line client. Follow the instructions under the **Install** section of [our documentation][29] 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!_ ## More information -[The documentation][29] provides a getting started guide, plus information about building from source, architecture, extending Velero, and more. +[The documentation][29] provides a getting started guide, plus information about building from source, architecture, extending Velero, and more. Please use the version selector at the top of the site to ensure you are using the appropriate documentation for your version of Velero. @@ -71,10 +70,10 @@ See [the list of releases][6] to find out about feature changes. [24]: https://groups.google.com/forum/#!forum/projectvelero [25]: https://kubernetes.slack.com/messages/velero -[26]: https://github.com/heptio/velero/blob/master/docs/zenhub.md +[26]: /zenhub.md -[29]: https://velero.io/docs/v1.0.0-rc.1/ +[29]: https://velero.io/docs/v1.0.0/ [30]: troubleshooting.md [99]: support-matrix.md diff --git a/site/docs/v1.0.0-rc.1/about.md b/site/docs/v1.0.0/about.md similarity index 100% rename from site/docs/v1.0.0-rc.1/about.md rename to site/docs/v1.0.0/about.md diff --git a/site/docs/v1.0.0-rc.1/api-types/README.md b/site/docs/v1.0.0/api-types/README.md similarity index 100% rename from site/docs/v1.0.0-rc.1/api-types/README.md rename to site/docs/v1.0.0/api-types/README.md diff --git a/site/docs/v1.0.0-rc.1/api-types/backup.md b/site/docs/v1.0.0/api-types/backup.md similarity index 100% rename from site/docs/v1.0.0-rc.1/api-types/backup.md rename to site/docs/v1.0.0/api-types/backup.md diff --git a/site/docs/v1.0.0-rc.1/api-types/backupstoragelocation.md b/site/docs/v1.0.0/api-types/backupstoragelocation.md similarity index 100% rename from site/docs/v1.0.0-rc.1/api-types/backupstoragelocation.md rename to site/docs/v1.0.0/api-types/backupstoragelocation.md diff --git a/site/docs/v1.0.0-rc.1/api-types/volumesnapshotlocation.md b/site/docs/v1.0.0/api-types/volumesnapshotlocation.md similarity index 100% rename from site/docs/v1.0.0-rc.1/api-types/volumesnapshotlocation.md rename to site/docs/v1.0.0/api-types/volumesnapshotlocation.md diff --git a/site/docs/v1.0.0-rc.1/aws-config.md b/site/docs/v1.0.0/aws-config.md similarity index 100% rename from site/docs/v1.0.0-rc.1/aws-config.md rename to site/docs/v1.0.0/aws-config.md diff --git a/site/docs/v1.0.0-rc.1/azure-config.md b/site/docs/v1.0.0/azure-config.md similarity index 100% rename from site/docs/v1.0.0-rc.1/azure-config.md rename to site/docs/v1.0.0/azure-config.md diff --git a/site/docs/v1.0.0-rc.1/build-from-source.md b/site/docs/v1.0.0/build-from-source.md similarity index 100% rename from site/docs/v1.0.0-rc.1/build-from-source.md rename to site/docs/v1.0.0/build-from-source.md diff --git a/site/docs/v1.0.0-rc.1/debugging-install.md b/site/docs/v1.0.0/debugging-install.md similarity index 100% rename from site/docs/v1.0.0-rc.1/debugging-install.md rename to site/docs/v1.0.0/debugging-install.md diff --git a/site/docs/v1.0.0-rc.1/debugging-restores.md b/site/docs/v1.0.0/debugging-restores.md similarity index 100% rename from site/docs/v1.0.0-rc.1/debugging-restores.md rename to site/docs/v1.0.0/debugging-restores.md diff --git a/site/docs/v1.0.0-rc.1/disaster-case.md b/site/docs/v1.0.0/disaster-case.md similarity index 100% rename from site/docs/v1.0.0-rc.1/disaster-case.md rename to site/docs/v1.0.0/disaster-case.md diff --git a/site/docs/v1.0.0-rc.1/extend.md b/site/docs/v1.0.0/extend.md similarity index 100% rename from site/docs/v1.0.0-rc.1/extend.md rename to site/docs/v1.0.0/extend.md diff --git a/site/docs/v1.0.0-rc.1/faq.md b/site/docs/v1.0.0/faq.md similarity index 100% rename from site/docs/v1.0.0-rc.1/faq.md rename to site/docs/v1.0.0/faq.md diff --git a/site/docs/v1.0.0-rc.1/gcp-config.md b/site/docs/v1.0.0/gcp-config.md similarity index 100% rename from site/docs/v1.0.0-rc.1/gcp-config.md rename to site/docs/v1.0.0/gcp-config.md diff --git a/site/docs/v1.0.0-rc.1/get-started.md b/site/docs/v1.0.0/get-started.md similarity index 100% rename from site/docs/v1.0.0-rc.1/get-started.md rename to site/docs/v1.0.0/get-started.md diff --git a/site/docs/v1.0.0-rc.1/hooks.md b/site/docs/v1.0.0/hooks.md similarity index 96% rename from site/docs/v1.0.0-rc.1/hooks.md rename to site/docs/v1.0.0/hooks.md index bd1c006dd4..9849210c7d 100644 --- a/site/docs/v1.0.0-rc.1/hooks.md +++ b/site/docs/v1.0.0/hooks.md @@ -7,7 +7,8 @@ Velero currently supports executing commands in containers in pods during a back When performing a backup, you can specify one or more commands to execute in a container in a pod when that pod is being backed up. The commands can be configured to run *before* any custom action processing ("pre" hooks), or after all custom actions have been completed and any additional items -specified by custom action have been backed up ("post" hooks). +specified by custom action have been backed up ("post" hooks). Note that hooks are _not_ executed within a shell +on the containers. There are two ways to specify hooks: annotations on the pod itself, and in the Backup spec. diff --git a/site/docs/v1.0.0-rc.1/ibm-config.md b/site/docs/v1.0.0/ibm-config.md similarity index 100% rename from site/docs/v1.0.0-rc.1/ibm-config.md rename to site/docs/v1.0.0/ibm-config.md diff --git a/site/docs/v1.0.0-rc.1/image-tagging.md b/site/docs/v1.0.0/image-tagging.md similarity index 100% rename from site/docs/v1.0.0-rc.1/image-tagging.md rename to site/docs/v1.0.0/image-tagging.md diff --git a/site/docs/v1.0.0-rc.1/img/README.md b/site/docs/v1.0.0/img/README.md similarity index 100% rename from site/docs/v1.0.0-rc.1/img/README.md rename to site/docs/v1.0.0/img/README.md diff --git a/site/docs/v1.0.0-rc.1/img/backup-process.png b/site/docs/v1.0.0/img/backup-process.png similarity index 100% rename from site/docs/v1.0.0-rc.1/img/backup-process.png rename to site/docs/v1.0.0/img/backup-process.png diff --git a/site/docs/v1.0.0-rc.1/img/velero.png b/site/docs/v1.0.0/img/velero.png similarity index 100% rename from site/docs/v1.0.0-rc.1/img/velero.png rename to site/docs/v1.0.0/img/velero.png diff --git a/site/docs/v1.0.0-rc.1/install-overview.md b/site/docs/v1.0.0/install-overview.md similarity index 100% rename from site/docs/v1.0.0-rc.1/install-overview.md rename to site/docs/v1.0.0/install-overview.md diff --git a/site/docs/v1.0.0-rc.1/locations.md b/site/docs/v1.0.0/locations.md similarity index 100% rename from site/docs/v1.0.0-rc.1/locations.md rename to site/docs/v1.0.0/locations.md diff --git a/site/docs/v1.0.0-rc.1/migrating-to-velero.md b/site/docs/v1.0.0/migrating-to-velero.md similarity index 100% rename from site/docs/v1.0.0-rc.1/migrating-to-velero.md rename to site/docs/v1.0.0/migrating-to-velero.md diff --git a/site/docs/v1.0.0-rc.1/migration-case.md b/site/docs/v1.0.0/migration-case.md similarity index 100% rename from site/docs/v1.0.0-rc.1/migration-case.md rename to site/docs/v1.0.0/migration-case.md diff --git a/site/docs/v1.0.0-rc.1/namespace.md b/site/docs/v1.0.0/namespace.md similarity index 100% rename from site/docs/v1.0.0-rc.1/namespace.md rename to site/docs/v1.0.0/namespace.md diff --git a/site/docs/v1.0.0-rc.1/output-file-format.md b/site/docs/v1.0.0/output-file-format.md similarity index 100% rename from site/docs/v1.0.0-rc.1/output-file-format.md rename to site/docs/v1.0.0/output-file-format.md diff --git a/site/docs/v1.0.0-rc.1/plugins.md b/site/docs/v1.0.0/plugins.md similarity index 100% rename from site/docs/v1.0.0-rc.1/plugins.md rename to site/docs/v1.0.0/plugins.md diff --git a/site/docs/v1.0.0-rc.1/rbac.md b/site/docs/v1.0.0/rbac.md similarity index 100% rename from site/docs/v1.0.0-rc.1/rbac.md rename to site/docs/v1.0.0/rbac.md diff --git a/site/docs/v1.0.0-rc.1/restic.md b/site/docs/v1.0.0/restic.md similarity index 100% rename from site/docs/v1.0.0-rc.1/restic.md rename to site/docs/v1.0.0/restic.md diff --git a/site/docs/v1.0.0-rc.1/support-matrix.md b/site/docs/v1.0.0/support-matrix.md similarity index 93% rename from site/docs/v1.0.0-rc.1/support-matrix.md rename to site/docs/v1.0.0/support-matrix.md index f06b12bf4a..e99ef8c0a8 100644 --- a/site/docs/v1.0.0-rc.1/support-matrix.md +++ b/site/docs/v1.0.0/support-matrix.md @@ -40,6 +40,7 @@ _Some storage providers, like Quobyte, may need a different [signature algorithm | [Restic][1] | Velero Team | [Slack][10], [GitHub Issue][11] | | [Portworx][6] | Portworx | [Slack][13], [GitHub Issue][14] | | [DigitalOcean][7] | StackPointCloud | | +| [OpenEBS][18] | OpenEBS | [Slack][19], [GitHub Issue][20] | ### Adding a new plugin @@ -64,3 +65,6 @@ After you publish your plugin, open a PR that adds your plugin to the appropriat [15]: api-types/backupstoragelocation.md#aws [16]: http://www.noobaa.com/ [17]: restic.md +[18]: https://github.com/openebs/velero-plugin +[19]: https://openebs-community.slack.com/ +[20]: https://github.com/openebs/velero-plugin/issues diff --git a/site/docs/v1.0.0-rc.1/troubleshooting.md b/site/docs/v1.0.0/troubleshooting.md similarity index 100% rename from site/docs/v1.0.0-rc.1/troubleshooting.md rename to site/docs/v1.0.0/troubleshooting.md diff --git a/site/docs/v1.0.0-rc.1/upgrade-to-1.0.md b/site/docs/v1.0.0/upgrade-to-1.0.md similarity index 100% rename from site/docs/v1.0.0-rc.1/upgrade-to-1.0.md rename to site/docs/v1.0.0/upgrade-to-1.0.md diff --git a/site/docs/v1.0.0-rc.1/vendoring-dependencies.md b/site/docs/v1.0.0/vendoring-dependencies.md similarity index 100% rename from site/docs/v1.0.0-rc.1/vendoring-dependencies.md rename to site/docs/v1.0.0/vendoring-dependencies.md diff --git a/site/docs/v1.0.0-rc.1/zenhub.md b/site/docs/v1.0.0/zenhub.md similarity index 100% rename from site/docs/v1.0.0-rc.1/zenhub.md rename to site/docs/v1.0.0/zenhub.md diff --git a/site/index.html b/site/index.html index 5ee72b4f65..d037a89f54 100644 --- a/site/index.html +++ b/site/index.html @@ -13,7 +13,7 @@ url: https://blogs.vmware.com/cloudnative/2019/02/28/velero-v0-11-delivers-an-open-source-tool-to-back-up-and-migrate-kubernetes-clusters/ cta_link2: text: Download Velero - url: https://github.com/heptio/velero/releases/tag/v1.0.0-alpha.2 + url: https://github.com/heptio/velero/releases/tag/v1.0.0 promo1: icon: /img/disaster-recover-icon.svg #url: http://www.example.com?box1 @@ -184,4 +184,4 @@

Blog Highlights

{% include contributors.html %}
- \ No newline at end of file + From f44ad1ad3462ec5886559cd730747ca9fdae27b8 Mon Sep 17 00:00:00 2001 From: Steve Kriss Date: Sun, 19 May 2019 13:47:00 -0600 Subject: [PATCH 2/2] update root README.md to point to 1.0 docs Signed-off-by: Steve Kriss --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index cec225a40b..4d031f02c7 100644 --- a/README.md +++ b/README.md @@ -71,11 +71,11 @@ See [the list of releases][6] to find out about feature changes. [24]: https://groups.google.com/forum/#!forum/projectvelero [25]: https://kubernetes.slack.com/messages/velero -[26]: https://velero.io/docs/v0.11.0/zenhub +[26]: https://velero.io/docs/v1.0.0/zenhub -[29]: https://velero.io/docs/v0.11.0/ -[30]: https://velero.io/docs/v0.11.0/troubleshooting +[29]: https://velero.io/docs/v1.0.0/ +[30]: https://velero.io/docs/v1.0.0/troubleshooting -[99]: https://velero.io/docs/v0.11.0/support-matrix +[99]: https://velero.io/docs/v1.0.0/support-matrix [100]: /site/docs/master/img/velero.png