Skip to content

Commit

Permalink
Merge pull request #1960 from camilamacedo86/book-v3-files-update
Browse files Browse the repository at this point in the history
📖 update the docs over regards book-v3 branch
  • Loading branch information
k8s-ci-robot committed Apr 27, 2021
2 parents b80c2b8 + 9facdc4 commit 33ca7eb
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,8 +95,8 @@ separately.

The docs are published off of three branches:

- `book-v2`: [book.kubebuilder.io](https://book.kubebuilder.io) -- current
docs
- `book-v3`: [book.kubebuilder.io](https://book.kubebuilder.io) -- current docs
- `book-v2`: [book-v2.kubebuilder.io](https://book.kubebuilder.io) -- legacy docs
- `book-v1`:
[book-v1.book.kubebuilder.io](https://book-v1.book.kubebuilder.io) --
legacy docs
Expand Down
2 changes: 1 addition & 1 deletion RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ The Kubebuilder Project is released on an as-needed basis. The process is as fol
1. An issue is proposing a new release with a changelog since the last release. You will need to use the [kubebuilder-release-tools][kubebuilder-release-tools] to generate the notes. See [here][release-notes-generation]
1. All [OWNERS](OWNERS) must LGTM this release
1. An OWNER runs `git tag -s $VERSION` and pushes the tag with `git push $VERSION`. Note that after the OWNER push the tag the CI will automatically add the release notes and the assets.
1. A PR needs to be created to merge `release-X` branch into `book-vX` to pick up the new docs.
1. A PR needs to be created to merge `master` branch into `book-v3` to pick up the new docs.
1. The release issue is closed
1. An announcement email is sent to `kubebuilder@googlegroups.com` with the subject `[ANNOUNCE] kubebuilder $VERSION is released`

Expand Down
4 changes: 2 additions & 2 deletions VERSIONING.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ the latest controller-tools release. That info is stored in
## Book Releases

The book's main version (https://book.kubebuilder.io) is published off of
the [book-v2][book-branch] (a version built off the main branch can be
the [book-v3][book-branch] (a version built off the main branch can be
found at https://master.book.kubebuilder.io).

Docs changes that aren't specific to a new feature should be
Expand All @@ -43,7 +43,7 @@ The cherry-picks will automatically be published to the book once their PR
merges.

**When you publish a KubeBuilder release**, be sure to also submit a PR
that merges the main branch into [book-v2][book-branch], so that it
that merges the main branch into [book-v3][book-branch], so that it
describes the latest changes in the new release.

[book-branch]: https://github.com/kubernetes-sigs/kubebuilder/tree/tools-releases
Expand Down

0 comments on commit 33ca7eb

Please sign in to comment.