Skip to content

Commit ba20879

Browse files
authored
Merge pull request #28463 from sftim/20210617_update_docs_for_primary_branch_rename
Update docs for primary branch rename to "main"
2 parents 837e1c6 + da31234 commit ba20879

File tree

15 files changed

+42
-42
lines changed

15 files changed

+42
-42
lines changed

content/en/docs/concepts/cluster-administration/manage-deployment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ It is a recommended practice to put resources related to the same microservice o
5050
A URL can also be specified as a configuration source, which is handy for deploying directly from configuration files checked into GitHub:
5151

5252
```shell
53-
kubectl apply -f https://raw.githubusercontent.com/kubernetes/website/master/content/en/examples/application/nginx/nginx-deployment.yaml
53+
kubectl apply -f https://raw.githubusercontent.com/kubernetes/website/main/content/en/examples/application/nginx/nginx-deployment.yaml
5454
```
5555

5656
```shell

content/en/docs/contribute/generate-ref-docs/quickstart.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ the build setup and generates the reference documentation for a release.
1818

1919
## Getting the docs repository
2020

21-
Make sure your `website` fork is up-to-date with the `kubernetes/website` master and clone
22-
your `website` fork.
21+
Make sure your `website` fork is up-to-date with the `kubernetes/website` remote on
22+
GitHub (`main` branch), and clone your `website` fork.
2323

2424
```shell
2525
mkdir github.com
@@ -171,7 +171,7 @@ For example:
171171
The `release.yml` configuration file contains instructions to fix relative links.
172172
To fix relative links within your imported files, set the`gen-absolute-links`
173173
property to `true`. You can find an example of this in
174-
[`release.yml`](https://github.com/kubernetes/website/blob/master/update-imported-docs/release.yml).
174+
[`release.yml`](https://github.com/kubernetes/website/blob/main/update-imported-docs/release.yml).
175175

176176
## Adding and committing changes in kubernetes/website
177177

content/en/docs/contribute/localization.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ Once you've opened a localization PR, you can become members of the Kubernetes G
9898

9999
### Add your localization team in GitHub
100100

101-
Next, add your Kubernetes localization team to [`sig-docs/teams.yaml`](https://github.com/kubernetes/org/blob/master/config/kubernetes/sig-docs/teams.yaml). For an example of adding a localization team, see the PR to add the [Spanish localization team](https://github.com/kubernetes/org/pull/685).
101+
Next, add your Kubernetes localization team to [`sig-docs/teams.yaml`](https://github.com/kubernetes/org/blob/main/config/kubernetes/sig-docs/teams.yaml). For an example of adding a localization team, see the PR to add the [Spanish localization team](https://github.com/kubernetes/org/pull/685).
102102

103103
Members of `@kubernetes/sig-docs-**-owners` can approve PRs that change content within (and only within) your localization directory: `/content/**/`.
104104

@@ -117,7 +117,7 @@ For an example of adding a label, see the PR for adding the [Italian language la
117117

118118
### Modify the site configuration
119119

120-
The Kubernetes website uses Hugo as its web framework. The website's Hugo configuration resides in the [`config.toml`](https://github.com/kubernetes/website/tree/master/config.toml) file. To support a new localization, you'll need to modify `config.toml`.
120+
The Kubernetes website uses Hugo as its web framework. The website's Hugo configuration resides in the [`config.toml`](https://github.com/kubernetes/website/tree/main/config.toml) file. To support a new localization, you'll need to modify `config.toml`.
121121

122122
Add a configuration block for the new language to `config.toml`, under the existing `[languages]` block. The German block, for example, looks like:
123123

@@ -136,7 +136,7 @@ For more information about Hugo's multilingual support, see "[Multilingual Mode]
136136

137137
### Add a new localization directory
138138

139-
Add a language-specific subdirectory to the [`content`](https://github.com/kubernetes/website/tree/master/content) folder in the repository. For example, the two-letter code for German is `de`:
139+
Add a language-specific subdirectory to the [`content`](https://github.com/kubernetes/website/tree/main/content) folder in the repository. For example, the two-letter code for German is `de`:
140140

141141
```shell
142142
mkdir content/de
@@ -219,7 +219,7 @@ For an example of adding a new localization, see the PR to enable [docs in Frenc
219219

220220
### Add a localized README file
221221

222-
To guide other localization contributors, add a new [`README-**.md`](https://help.github.com/articles/about-readmes/) to the top level of k/website, where `**` is the two-letter language code. For example, a German README file would be `README-de.md`.
222+
To guide other localization contributors, add a new [`README-**.md`](https://help.github.com/articles/about-readmes/) to the top level of [k/website](https://github.com/kubernetes/website/), where `**` is the two-letter language code. For example, a German README file would be `README-de.md`.
223223

224224
Provide guidance to localization contributors in the localized `README-**.md` file. Include the same information contained in `README.md` as well as:
225225

@@ -276,15 +276,15 @@ To find source files for your target version:
276276
2. Select a branch for your target version from the following table:
277277
Target version | Branch
278278
-----|-----
279-
Latest version | [`master`](https://github.com/kubernetes/website/tree/master)
279+
Latest version | [`main`](https://github.com/kubernetes/website/tree/main)
280280
Previous version | [`release-{{< skew prevMinorVersion >}}`](https://github.com/kubernetes/website/tree/release-{{< skew prevMinorVersion >}})
281281
Next version | [`dev-{{< skew nextMinorVersion >}}`](https://github.com/kubernetes/website/tree/dev-{{< skew nextMinorVersion >}})
282282

283-
The `master` branch holds content for the current release `{{< latest-version >}}`. The release team will create a `{{< release-branch >}}` branch before the next release: v{{< skew nextMinorVersion >}}.
283+
The `main` branch holds content for the current release `{{< latest-version >}}`. The release team will create a `{{< release-branch >}}` branch before the next release: v{{< skew nextMinorVersion >}}.
284284

285285
### Site strings in i18n
286286

287-
Localizations must include the contents of [`data/i18n/en/en.toml`](https://github.com/kubernetes/website/blob/master/data/i18n/en/en.toml) in a new language-specific file. Using German as an example: `data/i18n/de/de.toml`.
287+
Localizations must include the contents of [`data/i18n/en/en.toml`](https://github.com/kubernetes/website/blob/main/data/i18n/en/en.toml) in a new language-specific file. Using German as an example: `data/i18n/de/de.toml`.
288288

289289
Add a new localization directory and file to `data/i18n/`. For example, with German (`de`):
290290

@@ -339,14 +339,14 @@ Repeat steps 1-4 as needed until the localization is complete. For example, subs
339339
Teams must merge localized content into the same branch from which the content was sourced.
340340

341341
For example:
342-
- a localization branch sourced from `master` must be merged into `master`.
343-
- a localization branch sourced from `release-1.19` must be merged into `release-1.19`.
342+
- a localization branch sourced from `main` must be merged into `main`.
343+
- a localization branch sourced from `release-{{ skew "prevMinorVersion" }}` must be merged into `release-{{ skew "prevMinorVersion" }}`.
344344

345345
{{< note >}}
346-
If your localization branch was created from `master` branch but it is not merged into `master` before new release branch `{{< release-branch >}}` created, merge it into both `master` and new release branch `{{< release-branch >}}`. To merge your localization branch into new release branch `{{< release-branch >}}`, you need to switch upstream branch of your localization branch to `{{< release-branch >}}`.
346+
If your localization branch was created from `main` branch but it is not merged into `main` before new release branch `{{< release-branch >}}` created, merge it into both `main` and new release branch `{{< release-branch >}}`. To merge your localization branch into new release branch `{{< release-branch >}}`, you need to switch upstream branch of your localization branch to `{{< release-branch >}}`.
347347
{{< /note >}}
348348

349-
At the beginning of every team milestone, it's helpful to open an issue comparing upstream changes between the previous localization branch and the current localization branch. There are two scripts for comparing upstream changes. [`upstream_changes.py`](https://github.com/kubernetes/website/tree/master/scripts#upstream_changespy) is useful for checking the changes made to a specific file. And [`diff_l10n_branches.py`](https://github.com/kubernetes/website/tree/master/scripts#diff_l10n_branchespy) is useful for creating a list of outdated files for a specific localization branch.
349+
At the beginning of every team milestone, it's helpful to open an issue comparing upstream changes between the previous localization branch and the current localization branch. There are two scripts for comparing upstream changes. [`upstream_changes.py`](https://github.com/kubernetes/website/tree/main/scripts#upstream_changespy) is useful for checking the changes made to a specific file. And [`diff_l10n_branches.py`](https://github.com/kubernetes/website/tree/main/scripts#diff_l10n_branchespy) is useful for creating a list of outdated files for a specific localization branch.
350350

351351
While only approvers can open a new localization branch and merge pull requests, anyone can open a pull request for a new localization branch. No special permissions are required.
352352

content/en/docs/contribute/new-content/blogs-case-studies.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Anyone can write a blog post and submit it for review.
4040
- Many CNCF projects have their own blog. These are often a better choice for posts. There are times of major feature or milestone for a CNCF project that users would be interested in reading on the Kubernetes blog.
4141
- Blog posts should be original content
4242
- The official blog is not for repurposing existing content from a third party as new content.
43-
- The [license](https://github.com/kubernetes/website/blob/master/LICENSE) for the blog allows commercial use of the content for commercial purposes, but not the other way around.
43+
- The [license](https://github.com/kubernetes/website/blob/main/LICENSE) for the blog allows commercial use of the content for commercial purposes, but not the other way around.
4444
- Blog posts should aim to be future proof
4545
- Given the development velocity of the project, we want evergreen content that won't require updates to stay accurate for the reader.
4646
- It can be a better choice to add a tutorial or update official documentation than to write a high level overview as a blog post.
@@ -56,7 +56,7 @@ The SIG Docs [blog subproject](https://github.com/kubernetes/community/tree/mast
5656

5757
To submit a blog post follow these directions:
5858

59-
- [Open a pull request](/docs/contribute/new-content/open-a-pr/#fork-the-repo) with a new blog post. New blog posts go under the [`content/en/blog/_posts`](https://github.com/kubernetes/website/tree/master/content/en/blog/_posts) directory.
59+
- [Open a pull request](/docs/contribute/new-content/open-a-pr/#fork-the-repo) with a new blog post. New blog posts go under the [`content/en/blog/_posts`](https://github.com/kubernetes/website/tree/main/content/en/blog/_posts) directory.
6060

6161
- Ensure that your blog post follows the correct naming conventions and the following frontmatter (metadata) information:
6262

@@ -90,6 +90,6 @@ Case studies highlight how organizations are using Kubernetes to solve
9090
real-world problems. The Kubernetes marketing team and members of the {{< glossary_tooltip text="CNCF" term_id="cncf" >}} collaborate with you on all case studies.
9191

9292
Have a look at the source for the
93-
[existing case studies](https://github.com/kubernetes/website/tree/master/content/en/case-studies).
93+
[existing case studies](https://github.com/kubernetes/website/tree/main/content/en/case-studies).
9494

9595
Refer to the [case study guidelines](https://github.com/cncf/foundation/blob/master/case-study-guidelines.md) and submit your request as outlined in the guidelines.

content/en/docs/contribute/new-content/open-a-pr.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ Make sure you have [git](https://git-scm.com/book/en/v2/Getting-Started-Installi
127127
upstream https://github.com/kubernetes/website.git (push)
128128
```
129129

130-
6. Fetch commits from your fork's `origin/master` and `kubernetes/website`'s `upstream/master`:
130+
6. Fetch commits from your fork's `origin/main` and `kubernetes/website`'s `upstream/main`:
131131

132132
```bash
133133
git fetch origin
@@ -137,15 +137,15 @@ Make sure you have [git](https://git-scm.com/book/en/v2/Getting-Started-Installi
137137
This makes sure your local repository is up to date before you start making changes.
138138

139139
{{< note >}}
140-
This workflow is different than the [Kubernetes Community GitHub Workflow](https://github.com/kubernetes/community/blob/master/contributors/guide/github-workflow.md). You do not need to merge your local copy of `master` with `upstream/master` before pushing updates to your fork.
140+
This workflow is different than the [Kubernetes Community GitHub Workflow](https://github.com/kubernetes/community/blob/master/contributors/guide/github-workflow.md). You do not need to merge your local copy of `main` with `upstream/main` before pushing updates to your fork.
141141
{{< /note >}}
142142

143143
### Create a branch
144144

145145
1. Decide which branch base to your work on:
146146

147-
- For improvements to existing content, use `upstream/master`.
148-
- For new content about existing features, use `upstream/master`.
147+
- For improvements to existing content, use `upstream/main`.
148+
- For new content about existing features, use `upstream/main`.
149149
- For localized content, use the localization's conventions. For more information, see [localizing Kubernetes documentation](/docs/contribute/localization/).
150150
- For new features in an upcoming Kubernetes release, use the feature branch. For more information, see [documenting for a release](/docs/contribute/new-content/new-features/).
151151
- For long-running efforts that multiple SIG Docs contributors collaborate on,
@@ -154,10 +154,10 @@ Make sure you have [git](https://git-scm.com/book/en/v2/Getting-Started-Installi
154154
155155
If you need help choosing a branch, ask in the `#sig-docs` Slack channel.
156156
157-
2. Create a new branch based on the branch identified in step 1. This example assumes the base branch is `upstream/master`:
157+
2. Create a new branch based on the branch identified in step 1. This example assumes the base branch is `upstream/main`:
158158
159159
```bash
160-
git checkout -b <my_new_branch> upstream/master
160+
git checkout -b <my_new_branch> upstream/main
161161
```
162162
163163
3. Make your changes using a text editor.
@@ -262,7 +262,7 @@ The commands below use Docker as default container engine. Set the `CONTAINER_EN
262262

263263
Alternately, install and use the `hugo` command on your computer:
264264

265-
1. Install the [Hugo](https://gohugo.io/getting-started/installing/) version specified in [`website/netlify.toml`](https://raw.githubusercontent.com/kubernetes/website/master/netlify.toml).
265+
1. Install the [Hugo](https://gohugo.io/getting-started/installing/) version specified in [`website/netlify.toml`](https://raw.githubusercontent.com/kubernetes/website/main/netlify.toml).
266266

267267
2. If you have not updated your website repository, the `website/themes/docsy` directory is empty.
268268
The site cannot build without a local copy of the theme. To update the website theme, run:
@@ -370,11 +370,11 @@ If another contributor commits changes to the same file in another PR, it can cr
370370
git push --force-with-lease origin <your-branch-name>
371371
```
372372

373-
2. Fetch changes from `kubernetes/website`'s `upstream/master` and rebase your branch:
373+
2. Fetch changes from `kubernetes/website`'s `upstream/main` and rebase your branch:
374374
375375
```bash
376376
git fetch upstream
377-
git rebase upstream/master
377+
git rebase upstream/main
378378
```
379379
380380
3. Inspect the results of the rebase:

content/en/docs/contribute/new-content/overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ When opening a pull request, you need to know in advance which branch to base yo
4242

4343
Scenario | Branch
4444
:---------|:------------
45-
Existing or new English language content for the current release | `master`
45+
Existing or new English language content for the current release | `main`
4646
Content for a feature change release | The branch which corresponds to the major and minor version the feature change is in, using the pattern `dev-<version>`. For example, if a feature changes in the `v{{< skew nextMinorVersion >}}` release, then add documentation changes to the ``dev-{{< skew nextMinorVersion >}}`` branch.
4747
Content in other languages (localizations) | Use the localization's convention. See the [Localization branching strategy](/docs/contribute/localization/#branching-strategy) for more information.
4848

@@ -60,6 +60,6 @@ Limit pull requests to one language per PR. If you need to make an identical cha
6060

6161
## Tools for contributors
6262

63-
The [doc contributors tools](https://github.com/kubernetes/website/tree/master/content/en/docs/doc-contributor-tools) directory in the `kubernetes/website` repository contains tools to help your contribution journey go more smoothly.
63+
The [doc contributors tools](https://github.com/kubernetes/website/tree/main/content/en/docs/doc-contributor-tools) directory in the `kubernetes/website` repository contains tools to help your contribution journey go more smoothly.
6464

6565

content/en/docs/contribute/participate/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,8 @@ two [prow plugins](https://github.com/kubernetes/test-infra/tree/master/prow/plu
7373
- approve
7474

7575
These two plugins use the
76-
[OWNERS](https://github.com/kubernetes/website/blob/master/OWNERS) and
77-
[OWNERS_ALIASES](https://github.com/kubernetes/website/blob/master/OWNERS_ALIASES)
76+
[OWNERS](https://github.com/kubernetes/website/blob/main/OWNERS) and
77+
[OWNERS_ALIASES](https://github.com/kubernetes/website/blob/main/OWNERS_ALIASES)
7878
files in the top level of the `kubernetes/website` GitHub repository to control
7979
how prow works within the repository.
8080

content/en/docs/contribute/participate/pr-wranglers.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ These queries exclude localization PRs. All queries are against the main branch
4444
Lists PRs that need an LGTM from a member. If the PR needs technical review, loop in one of the reviewers suggested by the bot. If the content needs work, add suggestions and feedback in-line.
4545
- [Has LGTM, needs docs approval](https://github.com/kubernetes/website/pulls?q=is%3Aopen+is%3Apr+-label%3Ado-not-merge%2Fwork-in-progress+-label%3Ado-not-merge%2Fhold+label%3Alanguage%2Fen+label%3Algtm+):
4646
Lists PRs that need an `/approve` comment to merge.
47-
- [Quick Wins](https://github.com/kubernetes/website/pulls?utf8=%E2%9C%93&q=is%3Apr+is%3Aopen+base%3Amaster+-label%3A%22do-not-merge%2Fwork-in-progress%22+-label%3A%22do-not-merge%2Fhold%22+label%3A%22cncf-cla%3A+yes%22+label%3A%22size%2FXS%22+label%3A%22language%2Fen%22): Lists PRs against the main branch with no clear blockers. (change "XS" in the size label as you work through the PRs [XS, S, M, L, XL, XXL]).
48-
- [Not against the main branch](https://github.com/kubernetes/website/pulls?q=is%3Aopen+is%3Apr+label%3Alanguage%2Fen+-base%3Amaster): If the PR is against a `dev-` branch, it's for an upcoming release. Assign the [docs release manager](https://github.com/kubernetes/sig-release/tree/master/release-team#kubernetes-release-team-roles) using: `/assign @<manager's_github-username>`. If the PR is against an old branch, help the author figure out whether it's targeted against the best branch.
47+
- [Quick Wins](https://github.com/kubernetes/website/pulls?utf8=%E2%9C%93&q=is%3Apr+is%3Aopen+base%3Amain+-label%3A%22do-not-merge%2Fwork-in-progress%22+-label%3A%22do-not-merge%2Fhold%22+label%3A%22cncf-cla%3A+yes%22+label%3A%22size%2FXS%22+label%3A%22language%2Fen%22): Lists PRs against the main branch with no clear blockers. (change "XS" in the size label as you work through the PRs [XS, S, M, L, XL, XXL]).
48+
- [Not against the primary branch](https://github.com/kubernetes/website/pulls?q=is%3Aopen+is%3Apr+label%3Alanguage%2Fen+-base%3Amain): If the PR is against a `dev-` branch, it's for an upcoming release. Assign the [docs release manager](https://github.com/kubernetes/sig-release/tree/master/release-team#kubernetes-release-team-roles) using: `/assign @<manager's_github-username>`. If the PR is against an old branch, help the author figure out whether it's targeted against the best branch.
4949

5050
### Helpful Prow commands for wranglers
5151

0 commit comments

Comments
 (0)