You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en/docs/contribute/localization.md
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -98,7 +98,7 @@ Once you've opened a localization PR, you can become members of the Kubernetes G
98
98
99
99
### Add your localization team in GitHub
100
100
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).
102
102
103
103
Members of `@kubernetes/sig-docs-**-owners` can approve PRs that change content within (and only within) your localization directory: `/content/**/`.
104
104
@@ -117,7 +117,7 @@ For an example of adding a label, see the PR for adding the [Italian language la
117
117
118
118
### Modify the site configuration
119
119
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`.
121
121
122
122
Add a configuration block for the new language to `config.toml`, under the existing `[languages]` block. The German block, for example, looks like:
123
123
@@ -136,7 +136,7 @@ For more information about Hugo's multilingual support, see "[Multilingual Mode]
136
136
137
137
### Add a new localization directory
138
138
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`:
140
140
141
141
```shell
142
142
mkdir content/de
@@ -219,7 +219,7 @@ For an example of adding a new localization, see the PR to enable [docs in Frenc
219
219
220
220
### Add a localized README file
221
221
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`.
223
223
224
224
Provide guidance to localization contributors in the localized `README-**.md` file. Include the same information contained in `README.md` as well as:
225
225
@@ -276,15 +276,15 @@ To find source files for your target version:
276
276
2. Select a branch for your target version from the following table:
277
277
Target version | Branch
278
278
-----|-----
279
-
Latest version | [`master`](https://github.com/kubernetes/website/tree/master)
279
+
Latest version | [`main`](https://github.com/kubernetes/website/tree/main)
280
280
Previous version | [`release-{{< skew prevMinorVersion >}}`](https://github.com/kubernetes/website/tree/release-{{< skew prevMinorVersion >}})
281
281
Next version | [`dev-{{< skew nextMinorVersion >}}`](https://github.com/kubernetes/website/tree/dev-{{< skew nextMinorVersion >}})
282
282
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 >}}.
284
284
285
285
### Site strings in i18n
286
286
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`.
288
288
289
289
Add a new localization directory and file to `data/i18n/`. For example, with German (`de`):
290
290
@@ -339,14 +339,14 @@ Repeat steps 1-4 as needed until the localization is complete. For example, subs
339
339
Teams must merge localized content into the same branch from which the content was sourced.
340
340
341
341
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" }}`.
344
344
345
345
{{< 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 >}}`.
347
347
{{< /note >}}
348
348
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.
350
350
351
351
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.
Copy file name to clipboardExpand all lines: content/en/docs/contribute/new-content/blogs-case-studies.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,7 +40,7 @@ Anyone can write a blog post and submit it for review.
40
40
- 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.
41
41
- Blog posts should be original content
42
42
- 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.
44
44
- Blog posts should aim to be future proof
45
45
- Given the development velocity of the project, we want evergreen content that won't require updates to stay accurate for the reader.
46
46
- 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
56
56
57
57
To submit a blog post follow these directions:
58
58
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.
60
60
61
61
- Ensure that your blog post follows the correct naming conventions and the following frontmatter (metadata) information:
62
62
@@ -90,6 +90,6 @@ Case studies highlight how organizations are using Kubernetes to solve
90
90
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.
91
91
92
92
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).
94
94
95
95
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.
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`:
131
131
132
132
```bash
133
133
git fetch origin
@@ -137,15 +137,15 @@ Make sure you have [git](https://git-scm.com/book/en/v2/Getting-Started-Installi
137
137
This makes sure your local repository is up to date before you start making changes.
138
138
139
139
{{< 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.
141
141
{{< /note >}}
142
142
143
143
### Create a branch
144
144
145
145
1. Decide which branch base to your work on:
146
146
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`.
149
149
- For localized content, use the localization's conventions. For more information, see [localizing Kubernetes documentation](/docs/contribute/localization/).
150
150
- 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/).
151
151
- 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
154
154
155
155
If you need help choosing a branch, ask in the `#sig-docs` Slack channel.
156
156
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`:
158
158
159
159
```bash
160
-
git checkout -b <my_new_branch> upstream/master
160
+
git checkout -b <my_new_branch> upstream/main
161
161
```
162
162
163
163
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
262
262
263
263
Alternately, install and use the `hugo`command on your computer:
264
264
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).
266
266
267
267
2. If you have not updated your website repository, the `website/themes/docsy` directory is empty.
268
268
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
Copy file name to clipboardExpand all lines: content/en/docs/contribute/new-content/overview.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -42,7 +42,7 @@ When opening a pull request, you need to know in advance which branch to base yo
42
42
43
43
Scenario | Branch
44
44
:---------|:------------
45
-
Existing or new English language content for the current release | `master`
45
+
Existing or new English language content for the current release | `main`
46
46
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.
47
47
Content in other languages (localizations) | Use the localization's convention. See the [Localization branching strategy](/docs/contribute/localization/#branching-strategy) for more information.
48
48
@@ -60,6 +60,6 @@ Limit pull requests to one language per PR. If you need to make an identical cha
60
60
61
61
## Tools for contributors
62
62
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.
Copy file name to clipboardExpand all lines: content/en/docs/contribute/participate/pr-wranglers.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -44,8 +44,8 @@ These queries exclude localization PRs. All queries are against the main branch
44
44
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.
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.
0 commit comments