Skip to content

Commit

Permalink
Merge pull request vmware-tanzu#1502 from skriss/1.0-docs
Browse files Browse the repository at this point in the history
add 1.0 docs
  • Loading branch information
skriss authored May 20, 2019
2 parents 1ed1a84 + f44ad1a commit 72f5cad
Show file tree
Hide file tree
Showing 43 changed files with 27 additions and 29 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,11 +70,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
10 changes: 5 additions & 5 deletions site/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion site/_data/toc-mapping.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
File renamed without changes.
13 changes: 4 additions & 9 deletions site/_includes/version-warning.html
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
{% if page.version != site.latest %}
<div class="alert alert-primary" role="alert">
{% if page.version == 'master' %}
<p>
Expand All @@ -13,25 +14,19 @@
unstable, and these docs only a best-guess effort at being up to date or correct. See the
<a href="{{latest_url}}">latest version</a>.
</p>
{% elsif page.version != site.latest %}
{% else %}
<p>
<i class="fa fa-exclamation-triangle" aria-hidden="true"></i>
Documentation for version {{ page.version }} is no longer actively maintained.
The version you are currently viewing is a static snapshot.
For up-to-date documentation, see the <a href="{{latest_url}}">latest version</a>.
</p>
{% endif %}
<p>
<i class="fa fa-exclamation-triangle" aria-hidden="true"></i>
Heptio Ark is now Velero! v0.11 is our first release with the new name. For instructions on
migrating your Ark deployments and data to Velero, please see the Upgrade section in the <a href="{{latest_url}}">latest version</a>.
For more details on the renaming, please read our <a href="https://blogs.vmware.com/cloudnative/2019/02/05/welcoming-heptio-open-source-projects-to-vmware/">blog post</a>.
</p>
{% elsif page.version == site.latest %}
<p>
<i class="fa fa-exclamation-triangle" aria-hidden="true"></i>
Heptio Ark is now Velero! v0.11 is our first release with the new name. For instructions on
migrating your Ark deployments and data to Velero, please see the Upgrade section in the <a href="{{latest_url}}">latest version</a>.
For more details on the renaming, please read our <a href="https://blogs.vmware.com/cloudnative/2019/02/05/welcoming-heptio-open-source-projects-to-vmware/">blog post</a>.
</p>
</div>
{% endif %}
</div>
3 changes: 1 addition & 2 deletions site/docs/master/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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!_

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
3 changes: 2 additions & 1 deletion site/docs/v1.0.0-rc.1/hooks.md → site/docs/v1.0.0/hooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 2 additions & 2 deletions site/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -184,4 +184,4 @@ <h2>Blog Highlights</h2>
<div class="section-content">
{% include contributors.html %}
</div>
</div>
</div>

0 comments on commit 72f5cad

Please sign in to comment.