Skip to content

Commit 68e37f1

Browse files
committed
Add content about editing Kubernetes source code.
1 parent 4de38b2 commit 68e37f1

File tree

1 file changed

+74
-1
lines changed

1 file changed

+74
-1
lines changed

docs/home/contribute/generated-reference/kubernetes-components.md

+74-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,80 @@ information, see
3838

3939
{% capture steps %}
4040

41-
## Overview
41+
## Getting two repositories
42+
43+
If you don't already have the `kubernetes/website` repository, get it now:
44+
45+
```shell
46+
mkdir $GOPATH/src
47+
cd $GOPATH/src
48+
go get github.com/kubernetes/website
49+
```
50+
51+
Determine the base directory of your clone of the
52+
[kubernetes/website](https://github.com/kubernetes/website) repository.
53+
For example, if you followed the preceding step to get the repository,
54+
your base directory is `$GOPATH/src/github.com/kubernetes/website.`
55+
The remaining steps refer to your base directory as `<web-base>`.
56+
57+
If you plan on making changes to the ref docs, and if you don't already have
58+
the `kubernetes/kubernetes` repository, get it now:
59+
60+
```shell
61+
mkdir $GOPATH/src
62+
cd $GOPATH/src
63+
go get github.com/kubernetes/kubernetes
64+
```
65+
66+
Determine the base directory of your clone of the
67+
[kubernetes/kubernetes](https://github.com/kubernetes/kubernetes) repository.
68+
For example, if you followed the preceding step to get the repository,
69+
your base directory is `$GOPATH/src/github.com/kubernetes/kubernetes.`
70+
The remaining steps refer to your base directory as `<k8s-base>`.
71+
72+
**Note:**
73+
If you only need to generate, but not change, the reference docs, you don't need to
74+
manually get the `kubernetes/kubernetes` repository. When you run the `update-imported-docs`
75+
tool, it will automatically clone the the `kubernetes/kubernetes` repository.
76+
{: .note}
77+
78+
## Editing the Kubernetes source code
79+
80+
The reference documentation for the Kubernetes components and tools is automatically
81+
generated from the Kubernetes source code. If you want to change the reference documentation,
82+
the first step is to change one or more comments in the Kubernetes source code. Make the
83+
change in your local kubernetes/kubernetes repository, and then submit a pull request to
84+
the master branch of
85+
[github.com/kubernetes/kubernetes](https://github.com/kubernetes/kubernetes).
86+
87+
[PR 56942](https://github.com/kubernetes/kubernetes/pull/56942)
88+
is an example of a pull request that makes changes to comments in the Kubernetes
89+
source code.
90+
91+
Monitor your pull request, and respond to reviewer comments. Continue to monitor
92+
your pull request until it is merged into the master branch of the
93+
kubernetes/kubernetes repository.
94+
95+
## Cherry picking your change into a release branch
96+
97+
Your change is now in the master branch, which is used for development of the next
98+
Kubernetes release. If you want your change to appear in the docs for a Kubernetes
99+
version that has already been released, you need to propose that your change be cherry
100+
picked into the release branch.
101+
102+
For example, suppose the master branch is being used to develop Kubernetes 1.10, and
103+
you want to backport your change to the release-1.9 branch. For instructions on how
104+
to do this, see
105+
[Propose a Cherry Pick](https://github.com/kubernetes/community/blob/master/contributors/devel/cherry-picks.md).
106+
107+
Monitor your cherry-pick pull request until it is merged into the release branch.
108+
109+
**Note:** Proposing a cherry pick requires that you have permission to set a label
110+
and a milestone in your pull request. If you don’t have those permissions, you will
111+
need to work with someone who can set the label and milestone for you.
112+
{: .note}
113+
114+
## Overview update-imported-docs
42115

43116
The `update-imported-docs` tool performs these steps:
44117

0 commit comments

Comments
 (0)