Skip to content

Commit bf3667c

Browse files
authored
Merge pull request #1415 from mengqiy/bookv2
📖 document how to udpate kubebuilder book
2 parents 379523a + 39a45e3 commit bf3667c

File tree

2 files changed

+16
-1
lines changed

2 files changed

+16
-1
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,21 @@ $ git clone [email protected]:<user>/kubebuilder.git $GOPATH/src/sigs.k8s.io/kubebu
4848
1. Note that the prow tests used in the CI are configured in [kubernetes-sigs/kubebuilder/kubebuilder-presubmits.yaml](https://github.com/kubernetes/test-infra/blob/master/config/jobs/kubernetes-sigs/kubebuilder/kubebuilder-presubmits.yaml).
4949
1. Check that all scripts used by the CI are defined in the project.
5050

51-
## How to preview the changes performed in the docs?
51+
## How to contribute to docs
52+
53+
We currently have 2 production branches, `book-v2` and `book-v1`. `book-v2` maps
54+
to `book.kubebuilder.io` which contains our latest released features, while
55+
`book-v1` maps to `book-v1.book.kubebuilder.io`, which contains our legacy docs
56+
for kubebuilder V1.
57+
58+
Docs for unreleased features live in the `master` branch. We merge the `master`
59+
branch into the `book-v2` branch when doing the releases.
60+
61+
If adding doc for an unreleased feature, the PR should target `master` branch.
62+
If updating existing docs, the PR should target `master` branch and then
63+
cherry-picked into `book-v2` branch.
64+
65+
### How to preview the changes performed in the docs?
5266

5367
Check the CI job after to do the Pull Request and then, click on in the `Details` of `netlify/kubebuilder/deploy-preview`
5468

RELEASE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +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
66
1. All [OWNERS](OWNERS) must LGTM this release
77
1. An OWNER runs `git tag -s $VERSION` and inserts the changelog and pushes the tag with `git push $VERSION`
8+
1. A PR needs to be created to merge `master` branch into `book-v2` to pick up the new docs.
89
1. The release issue is closed
910
1. An announcement email is sent to `[email protected]` with the subject `[ANNOUNCE] kubebuilder $VERSION is released`
1011

0 commit comments

Comments
 (0)