-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
📖 document how to udpate kubebuilder book
- Loading branch information
Mengqi Yu
committed
Mar 5, 2020
1 parent
379523a
commit 39a45e3
Showing
2 changed files
with
16 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -48,7 +48,21 @@ $ git clone [email protected]:<user>/kubebuilder.git $GOPATH/src/sigs.k8s.io/kubebu | |
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). | ||
1. Check that all scripts used by the CI are defined in the project. | ||
|
||
## How to preview the changes performed in the docs? | ||
## How to contribute to docs | ||
|
||
We currently have 2 production branches, `book-v2` and `book-v1`. `book-v2` maps | ||
to `book.kubebuilder.io` which contains our latest released features, while | ||
`book-v1` maps to `book-v1.book.kubebuilder.io`, which contains our legacy docs | ||
for kubebuilder V1. | ||
|
||
Docs for unreleased features live in the `master` branch. We merge the `master` | ||
branch into the `book-v2` branch when doing the releases. | ||
|
||
If adding doc for an unreleased feature, the PR should target `master` branch. | ||
If updating existing docs, the PR should target `master` branch and then | ||
cherry-picked into `book-v2` branch. | ||
|
||
### How to preview the changes performed in the docs? | ||
|
||
Check the CI job after to do the Pull Request and then, click on in the `Details` of `netlify/kubebuilder/deploy-preview` | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,6 +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 | ||
1. All [OWNERS](OWNERS) must LGTM this release | ||
1. An OWNER runs `git tag -s $VERSION` and inserts the changelog and pushes the tag with `git push $VERSION` | ||
1. A PR needs to be created to merge `master` branch into `book-v2` to pick up the new docs. | ||
1. The release issue is closed | ||
1. An announcement email is sent to `[email protected]` with the subject `[ANNOUNCE] kubebuilder $VERSION is released` | ||
|
||
|