Skip to content

Commit

Permalink
Upgrade docs for v1.6.0-rc2 (#3662)
Browse files Browse the repository at this point in the history
* Update changelog for v1.6.0-rc.2

Signed-off-by: Carlisia <carlisia@vmware.com>

* Update docs for v1.6.0-rc.2

Signed-off-by: Carlisia <carlisia@vmware.com>

* Upgrade docs for v1.6.0-rc2

Signed-off-by: Carlisia <carlisia@vmware.com>
  • Loading branch information
Carlisia Thompson committed Apr 5, 2021
1 parent c65c17c commit 9f24587
Show file tree
Hide file tree
Showing 78 changed files with 40 additions and 41 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Expand Up @@ -2,7 +2,7 @@
* [CHANGELOG-1.5.md][15]

## Development releases:
* [v1.6.0-rc.1][16]
* [CHANGELOG-1.6.md][16]

## Older releases:
* [CHANGELOG-1.4.md][14]
Expand Down
13 changes: 6 additions & 7 deletions changelogs/CHANGELOG-1.6.md
@@ -1,17 +1,17 @@
## v1.6.0-rc.1
## v1.6.0-rc.2
### 2021-03-29

### Download
https://github.com/vmware-tanzu/velero/releases/tag/v1.6.0-rc.1
https://github.com/vmware-tanzu/velero/releases/tag/v1.6.0-rc.2

### Container Image
`velero/velero:v1.6.0-rc.1`
`velero/velero:v1.6.0-rc.2`

### Documentation
https://velero.io/docs/v1.6.0-rc.1/
https://velero.io/docs/v1.6-rc.2/

### Upgrading
https://velero.io/docs/v1.6.0-rc.1/upgrade-to-1.6/
https://velero.io/docs/v1.6-rc.2/upgrade-to-1.6/

### Highlights

Expand Down Expand Up @@ -68,5 +68,4 @@ https://velero.io/docs/v1.6.0-rc.1/upgrade-to-1.6/
* Pass annotations from schedule to backup it creates the same way it is done for labels. Add WithannotationsMap function to builder to be able to pass map instead of key/val list (#3067, @funkycode)
* Add instructions to clone repository for examples in docs (#3074, @MadhavJivrajani)
* 🏃‍♂️ update setup-kind github actions CI (#3085, @ashish-amarnath)
* Modify wrong function name to correct one. (#3106, @shellwedance)
* Add additional printer columns for Velero CRDs to allow more information to be exposed when using `kubectl get`. (#2881, @zubron)
* Modify wrong function name to correct one. (#3106, @shellwedance)
2 changes: 1 addition & 1 deletion site/config.yaml
Expand Up @@ -15,7 +15,7 @@ params:
latest: v1.5
versions:
- main
- v1.6.0-rc.1
- v1.6-rc.2
- v1.5
- v1.4
- v1.3.2
Expand Down
12 changes: 6 additions & 6 deletions site/content/docs/main/upgrade-to-1.6.md
Expand Up @@ -29,7 +29,7 @@ If you're not yet running at least Velero v1.5, see the following:

```bash
Client:
Version: v1.6.0-rc.1
Version: v1.6.0-rc.2
Git commit: <git SHA>
```

Expand All @@ -45,12 +45,12 @@ If you're not yet running at least Velero v1.5, see the following:

```bash
kubectl set image deployment/velero \
velero=velero/velero:v1.6.0-rc.1 \
velero=velero/velero:v1.6.0-rc.2 \
--namespace velero

# optional, if using the restic daemon set
kubectl set image daemonset/restic \
restic=velero/velero:v1.6.0-rc.1 \
restic=velero/velero:v1.6.0-rc.2 \
--namespace velero
```

Expand All @@ -64,11 +64,11 @@ If you're not yet running at least Velero v1.5, see the following:

```bash
Client:
Version: v1.6.0-rc.1
Version: v1.6.0-rc.2
Git commit: <git SHA>

Server:
Version: v1.6.0-rc.1
Version: v1.6.0-rc.2
```

## Notes
Expand All @@ -86,4 +86,4 @@ After upgrading, if there is a previously created backup storage location with t
[6]: https://github.com/vmware-tanzu/velero/releases/tag/v1.4.2
[7]: https://github.com/vmware-tanzu/velero/issues/2077
[8]: https://github.com/vmware-tanzu/velero/issues/2311
[9]: https://velero.io/docs/v1.6/locations
[9]: https://velero.io/docs/v1.6-rc.2/locations
@@ -1,7 +1,7 @@
---
toc: "false"
cascade:
version: main
version: v1.6-rc.2
toc: "true"
---
![100]
Expand Down Expand Up @@ -33,7 +33,7 @@ If you encounter issues, review the [troubleshooting docs][30], [file an issue][

## Contributing

If you are ready to jump in and test, add code, or help with documentation, follow the instructions on our [Start contributing](https://velero.io/docs/v1.6.0-rc.1/start-contributing/) documentation for guidance on how to setup Velero for development.
If you are ready to jump in and test, add code, or help with documentation, follow the instructions on our [Start contributing](https://velero.io/docs/v1.6-rc.2/start-contributing/) documentation for guidance on how to setup Velero for development.

## Changelog

Expand Down
Expand Up @@ -88,5 +88,5 @@ To use multiple commands, wrap your target command in a shell and separate them


[1]: api-types/backup.md
[2]: https://github.com/vmware-tanzu/velero/blob/v1.6.0-rc.1/examples/nginx-app/with-pv.yaml
[2]: https://github.com/vmware-tanzu/velero/blob/v1.6-rc.2/examples/nginx-app/with-pv.yaml
[3]: cloud-common.md
Expand Up @@ -70,7 +70,7 @@ Example:

We use a package to generate mocks for our interfaces.

Example: if you want to change this mock: https://github.com/vmware-tanzu/velero/blob/v1.6.0-rc.1/pkg/restic/mocks/restorer.go
Example: if you want to change this mock: https://github.com/vmware-tanzu/velero/blob/v1.6-rc.2/pkg/restic/mocks/restorer.go

Run:

Expand Down
Expand Up @@ -244,5 +244,5 @@ After creating the Velero server in your cluster, try this example:

## Additional Reading

* [Official Velero Documentation](https://velero.io/docs/v1.6.0-rc.1/)
* [Official Velero Documentation](https://velero.io/docs/v1.6-rc.2/)
* [Oracle Cloud Infrastructure Documentation](https://docs.cloud.oracle.com/)
File renamed without changes.
Expand Up @@ -113,5 +113,5 @@ Once parsed into a `[]string`, the features can then be registered using the `Ne
Velero adds the `LD_LIBRARY_PATH` into the list of environment variables to provide the convenience for plugins that requires C libraries/extensions in the runtime.

[1]: https://github.com/vmware-tanzu/velero-plugin-example
[2]: https://github.com/vmware-tanzu/velero/blob/v1.6.0-rc.1/pkg/plugin/logger.go
[3]: https://github.com/vmware-tanzu/velero/blob/v1.6.0-rc.1/pkg/restore/restic_restore_action.go
[2]: https://github.com/vmware-tanzu/velero/blob/v1.6-rc.2/pkg/plugin/logger.go
[3]: https://github.com/vmware-tanzu/velero/blob/v1.6-rc.2/pkg/restore/restic_restore_action.go
Expand Up @@ -365,4 +365,4 @@ If you get an error like `complete:13: command not found: compdef`, then add the
[8]: https://github.com/vmware-tanzu/velero/issues/2311
[9]: self-signed-certificates.md
[10]: csi.md
[11]: https://github.com/vmware-tanzu/velero/blob/v1.6.0-rc.1/pkg/apis/velero/v1/constants.go
[11]: https://github.com/vmware-tanzu/velero/blob/v1.6-rc.2/pkg/apis/velero/v1/constants.go
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
Expand Up @@ -4,7 +4,7 @@ layout: docs
toc: "true"
---

There are some guidelines maintainers need to follow. We list them here for quick reference, especially for new maintainers. These guidelines apply to all projects in the Velero org, including the main project, the Velero Helm chart, and all other [related repositories](https://github.com/vmware-tanzu/velero/blob/v1.6.0-rc.1/GOVERNANCE.md#code-repositories).
There are some guidelines maintainers need to follow. We list them here for quick reference, especially for new maintainers. These guidelines apply to all projects in the Velero org, including the main project, the Velero Helm chart, and all other [related repositories](https://github.com/vmware-tanzu/velero/blob/v1.6-rc.2/GOVERNANCE.md#code-repositories).

Please be sure to also go through the guidance under the entire [Contribute](start-contributing/) section.

Expand All @@ -14,12 +14,12 @@ Please be sure to also go through the guidance under the entire [Contribute](sta
- As you review a PR that is not yet ready to merge, please check if the "request review" needs to be refreshed for any reviewer (this is better than @mention at them)
- Refrain from @mention other maintainers to review the PR unless it is an immediate need. All maintainers already get notified through the automated add to the "request review". If it is an urgent need, please add a helpful message as to why it is so people can properly prioritize work.
- There is no need to manually request reviewers: after the PR is created, all maintainers will be automatically added to the list (note: feel free to remove people if they are on PTO, etc).
- Be familiar with the [lazy consensus](https://github.com/vmware-tanzu/velero/blob/v1.6.0-rc.1/GOVERNANCE.md#lazy-consensus) policy for the project.
- Be familiar with the [lazy consensus](https://github.com/vmware-tanzu/velero/blob/v1.6-rc.2/GOVERNANCE.md#lazy-consensus) policy for the project.

Some tips for doing reviews:
- There are some [code standards and general guidelines](https://velero.io/docs/v1.6.0-rc.1/code-standards) we aim for
- We have [guidelines for writing and reviewing documentation](https://velero.io/docs/v1.6.0-rc.1/style-guide/)
- When reviewing a design document, ensure it follows [our format and guidelines]( https://github.com/vmware-tanzu/velero/blob/v1.6.0-rc.1/design/_template.md). Also, when reviewing a PR that implements a previously accepted design, ensure the associated design doc is moved to the [design/implemented](https://github.com/vmware-tanzu/velero/tree/main/design/implemented) folder.
- There are some [code standards and general guidelines](https://velero.io/docs/v1.6-rc.2/code-standards) we aim for
- We have [guidelines for writing and reviewing documentation](https://velero.io/docs/v1.6-rc.2/style-guide/)
- When reviewing a design document, ensure it follows [our format and guidelines]( https://github.com/vmware-tanzu/velero/blob/v1.6-rc.2/design/_template.md). Also, when reviewing a PR that implements a previously accepted design, ensure the associated design doc is moved to the [design/implemented](https://github.com/vmware-tanzu/velero/tree/main/design/implemented) folder.


## Creating a release
Expand All @@ -32,4 +32,4 @@ Maintainers are expected to participate in the community support rotation. We ha
Maintainers for the Velero project are highly involved with the open source community. All the online community meetings for the project are listed in our [community](community) page.

## How do I become a maintainer?
The Velero project welcomes contributors of all kinds. We are also always on the look out for a high level of engagement from contributors and opportunities to bring in new maintainers. If this is of interest, take a look at how [adding a maintainer](https://github.com/vmware-tanzu/velero/blob/v1.6.0-rc.1/GOVERNANCE.md#maintainers) is decided.
The Velero project welcomes contributors of all kinds. We are also always on the look out for a high level of engagement from contributors and opportunities to bring in new maintainers. If this is of interest, take a look at how [adding a maintainer](https://github.com/vmware-tanzu/velero/blob/v1.6-rc.2/GOVERNANCE.md#maintainers) is decided.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Expand Up @@ -9,7 +9,7 @@ This page covers the steps to perform when releasing a new version of Velero.
- Please read the documented variables in each script to understand what they are for and how to properly format their values.
- You will need to have an upstream remote configured to use to the [vmware-tanzu/velero](https://github.com/vmware-tanzu/velero) repository.
You can check this using `git remote -v`.
The release script ([`tag-release.sh`](https://github.com/vmware-tanzu/velero/blob/v1.6.0-rc.1/hack/release-tools/tag-release.sh)) will use `upstream` as the default remote name if it is not specified using the environment variable `REMOTE`.
The release script ([`tag-release.sh`](https://github.com/vmware-tanzu/velero/blob/v1.6-rc.2/hack/release-tools/tag-release.sh)) will use `upstream` as the default remote name if it is not specified using the environment variable `REMOTE`.
- GA release: major and minor releases only. Example: 1.0 (major), 1.5 (minor).
- Pre-releases: Any release leading up to a GA. Example: 1.4.0-beta.1, 1.5.0-rc.1
- RC releases: Release Candidate, contains everything that is supposed to ship with the GA release. This is still a pre-release.
Expand Down
File renamed without changes.
File renamed without changes.
Expand Up @@ -28,7 +28,7 @@ Please browse our list of resources, including a playlist of past online communi

If you are ready to jump in and test, add code, or help with documentation, please use the navigation on the left under `Contribute`.

[1]: https://github.com/vmware-tanzu/velero/blob/v1.6.0-rc.1/CODE_OF_CONDUCT.md
[2]: https://github.com/vmware-tanzu/velero/blob/v1.6.0-rc.1/CONTRIBUTING.md
[3]: https://github.com/vmware-tanzu/velero/blob/v1.6.0-rc.1/.github/ISSUE_TEMPLATE/feature-enhancement-request.md
[4]: https://github.com/vmware-tanzu/velero/blob/v1.6.0-rc.1/.github/ISSUE_TEMPLATE/bug_report.md
[1]: https://github.com/vmware-tanzu/velero/blob/v1.6-rc.2/CODE_OF_CONDUCT.md
[2]: https://github.com/vmware-tanzu/velero/blob/v1.6-rc.2/CONTRIBUTING.md
[3]: https://github.com/vmware-tanzu/velero/blob/v1.6-rc.2/.github/ISSUE_TEMPLATE/feature-enhancement-request.md
[4]: https://github.com/vmware-tanzu/velero/blob/v1.6-rc.2/.github/ISSUE_TEMPLATE/bug_report.md
File renamed without changes.
File renamed without changes.
File renamed without changes.
Expand Up @@ -29,7 +29,7 @@ If you're not yet running at least Velero v1.5, see the following:

```bash
Client:
Version: v1.6.0-rc.1
Version: v1.6.0-rc.2
Git commit: <git SHA>
```

Expand All @@ -45,12 +45,12 @@ If you're not yet running at least Velero v1.5, see the following:

```bash
kubectl set image deployment/velero \
velero=velero/velero:v1.6.0-rc.1 \
velero=velero/velero:v1.6.0-rc.2 \
--namespace velero

# optional, if using the restic daemon set
kubectl set image daemonset/restic \
restic=velero/velero:v1.6.0-rc.1 \
restic=velero/velero:v1.6.0-rc.2 \
--namespace velero
```

Expand All @@ -64,11 +64,11 @@ If you're not yet running at least Velero v1.5, see the following:

```bash
Client:
Version: v1.6.0-rc.1
Version: v1.6.0-rc.2
Git commit: <git SHA>

Server:
Version: v1.6.0-rc.1
Version: v1.6.0-rc.2
```

## Notes
Expand All @@ -86,4 +86,4 @@ After upgrading, if there is a previously created backup storage location with t
[6]: https://github.com/vmware-tanzu/velero/releases/tag/v1.4.2
[7]: https://github.com/vmware-tanzu/velero/issues/2077
[8]: https://github.com/vmware-tanzu/velero/issues/2311
[9]: https://velero.io/docs/v1.6/locations
[9]: https://velero.io/docs/v1.6-rc.2/locations
2 changes: 1 addition & 1 deletion site/data/docs/toc-mapping.yml
Expand Up @@ -3,7 +3,7 @@
# that the navigation for older versions still work.

main: main-toc
v1.6.0-rc.1: v1-6-0-rc-1-toc
v1.6-rc.2: v1-6-rc.2-toc
v1.5: v1-5-toc
v1.4: v1-4-toc
v1.3.2: v1-3-2-toc
Expand Down
File renamed without changes.

0 comments on commit 9f24587

Please sign in to comment.