From eafe53560b0282e7256a089f0319ecfd025365e1 Mon Sep 17 00:00:00 2001 From: Jonas Rosland Date: Fri, 17 May 2019 21:02:34 +0200 Subject: [PATCH] Small fixes to the README and site Signed-off-by: Jonas Rosland Add docs/latest Signed-off-by: Jonas Rosland Add hardcoded links to latest release for now Signed-off-by: Jonas Rosland --- README.md | 14 +++++++------- site/_config.yml | 16 ++++++++-------- site/_data/master-toc.yml | 5 +++-- site/community.md | 8 ++++---- site/docs/master/README.md | 8 ++++---- site/docs/v0.11.0/README.md | 6 +++--- 6 files changed, 29 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index b9936ccb6..cec225a40 100644 --- a/README.md +++ b/README.md @@ -20,14 +20,14 @@ 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. +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. _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,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://github.com/heptio/velero/blob/master/docs/zenhub.md +[26]: https://velero.io/docs/v0.11.0/zenhub -[29]: https://heptio.github.io/velero/ -[30]: /docs/troubleshooting.md +[29]: https://velero.io/docs/v0.11.0/ +[30]: https://velero.io/docs/v0.11.0/troubleshooting -[99]: /docs/support-matrix.md -[100]: /docs/img/velero.png +[99]: https://velero.io/docs/v0.11.0/support-matrix +[100]: /site/docs/master/img/velero.png diff --git a/site/_config.yml b/site/_config.yml index fea316bdd..4e04bd4bc 100644 --- a/site/_config.yml +++ b/site/_config.yml @@ -7,7 +7,7 @@ url: logo: Velero.svg vm_logo: vm-logo.png gh_repo: https://github.com/heptio/velero -hero: +hero: background-color: med-blue footer: title: Getting Started @@ -17,24 +17,24 @@ footer: cta_text: Documentation vm-link: http://vmware.github.io/ -footer_social_links: +footer_social_links: Twitter: fa_icon: fab fa-twitter url: https://twitter.com/projectvelero Slack: fa_icon: fab fa-slack url: https://kubernetes.slack.com/messages/velero - User Group: + Google Groups: fa_icon: fas fa-users url: https://groups.google.com/forum/#!forum/projectvelero - RSS: + RSS: fa_icon: fa fa-rss url: feed.xml - + defaults: - scope: path: "" # an empty string here means all files in the project - type: "posts" + type: "posts" values: layout: "posts" - scope: @@ -159,7 +159,7 @@ plugins: # Include these subdirectories -include: +include: - CONTRIBUTING.md - README.md @@ -171,4 +171,4 @@ exclude: - LICENSE - CNAME - Runbook.docx - - '*.sh' \ No newline at end of file + - '*.sh' diff --git a/site/_data/master-toc.yml b/site/_data/master-toc.yml index b4bef87e6..e313f154f 100644 --- a/site/_data/master-toc.yml +++ b/site/_data/master-toc.yml @@ -28,7 +28,7 @@ toc: - page: Run on GCP url: /gcp-config - page: Restic Setup - url: /restic + url: /restic - title: Use subfolderitems: - page: Disaster Recovery @@ -63,4 +63,5 @@ toc: url: /output-file-format - page: FAQ url: /faq - + - page: ZenHub + url: /zenhub diff --git a/site/community.md b/site/community.md index 21a4fd412..d6d3b8977 100644 --- a/site/community.md +++ b/site/community.md @@ -7,12 +7,12 @@ id: community If you’re a newcomer, check out the “[Good first issue](https://github.com/heptio/velero/issues?q=is%3Aopen+is%3Aissue+label%3A%22Good+first+issue%22)” and “[Help wanted](https://github.com/heptio/velero/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+label%3A%22Help+wanted%22+)” labels in the Velero repository. -* Follow us on Twitter at [@projectvelero​](https://groups.google.com/forum/#!forum/projectvelero) +* Follow us on Twitter at [@projectvelero](https://twitter.com/projectvelero) -* Join our Kubernetes Slack channel and talk to over 800 other community members: [#velero​](https://groups.google.com/forum/#!forum/projectvelero) +* Join our Kubernetes Slack channel and talk to over 800 other community members: [#velero](https://kubernetes.slack.com/messages/velero) * Join our [Google Group](https://groups.google.com/forum/#!forum/projectvelero) to get updates on the project and invites to community meetings. -* Join the Velero community meetings every 1st and 3rd Tuesday:​ +* Join the Velero community meetings every 1st and 3rd Tuesday: -* See previous community meetings on our [YouTube Channel](https://www.youtube.com/playlist?list=PL7bmigfV0EqQRysvqvqOtRNk4L5S7uqwM) \ No newline at end of file +* See previous community meetings on our [YouTube Channel](https://www.youtube.com/playlist?list=PL7bmigfV0EqQRysvqvqOtRNk4L5S7uqwM) diff --git a/site/docs/master/README.md b/site/docs/master/README.md index a65168e75..37456846e 100644 --- a/site/docs/master/README.md +++ b/site/docs/master/README.md @@ -20,14 +20,14 @@ 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. +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. _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 +71,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://heptio.github.io/velero/ +[29]: https://velero.io/docs/master/ [30]: troubleshooting.md [99]: support-matrix.md diff --git a/site/docs/v0.11.0/README.md b/site/docs/v0.11.0/README.md index b3e758271..f5427ff03 100644 --- a/site/docs/v0.11.0/README.md +++ b/site/docs/v0.11.0/README.md @@ -20,14 +20,14 @@ 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. +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. _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. @@ -74,7 +74,7 @@ See [the list of releases][6] to find out about feature changes. [26]: https://github.com/heptio/velero/blob/master/docs/zenhub.md -[29]: https://heptio.github.io/velero/ +[29]: https://velero.io/docs/v0.11.0/install-overview [30]: /troubleshooting.md [99]: /support-matrix.md