Skip to content

Commit 9facdc4

Browse files
📖 update the docs over regards book-v3 branch
1 parent b80c2b8 commit 9facdc4

File tree

3 files changed

+5
-5
lines changed

3 files changed

+5
-5
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,8 +95,8 @@ separately.
9595

9696
The docs are published off of three branches:
9797

98-
- `book-v2`: [book.kubebuilder.io](https://book.kubebuilder.io) -- current
99-
docs
98+
- `book-v3`: [book.kubebuilder.io](https://book.kubebuilder.io) -- current docs
99+
- `book-v2`: [book-v2.kubebuilder.io](https://book.kubebuilder.io) -- legacy docs
100100
- `book-v1`:
101101
[book-v1.book.kubebuilder.io](https://book-v1.book.kubebuilder.io) --
102102
legacy docs

RELEASE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ The Kubebuilder Project is released on an as-needed basis. The process is as fol
55
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]
66
1. All [OWNERS](OWNERS) must LGTM this release
77
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.
8-
1. A PR needs to be created to merge `release-X` branch into `book-vX` to pick up the new docs.
8+
1. A PR needs to be created to merge `master` branch into `book-v3` to pick up the new docs.
99
1. The release issue is closed
1010
1. An announcement email is sent to `[email protected]` with the subject `[ANNOUNCE] kubebuilder $VERSION is released`
1111

VERSIONING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ the latest controller-tools release. That info is stored in
3434
## Book Releases
3535

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

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

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

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

0 commit comments

Comments
 (0)