|
1 | 1 | ---
|
2 | 2 | title: Contributing new content
|
| 3 | +content_type: concept |
| 4 | +main_menu: true |
3 | 5 | weight: 20
|
4 | 6 | ---
|
| 7 | + |
| 8 | +<!-- overview --> |
| 9 | + |
| 10 | +This section contains information you should know before contributing new content. |
| 11 | + |
| 12 | + |
| 13 | + |
| 14 | + |
| 15 | +<!-- body --> |
| 16 | + |
| 17 | +## Contributing basics |
| 18 | + |
| 19 | +- Write Kubernetes documentation in Markdown and build the Kubernetes site using [Hugo](https://gohugo.io/). |
| 20 | +- The source is in [GitHub](https://github.com/kubernetes/website). You can find Kubernetes documentation at `/content/en/docs/`. Some of the reference documentation is automatically generated from scripts in the `update-imported-docs/` directory. |
| 21 | +- [Page content types](/docs/contribute/style/page-content-types/) describe the presentation of documentation content in Hugo. |
| 22 | +- In addition to the standard Hugo shortcodes, we use a number of |
| 23 | + [custom Hugo shortcodes](/docs/contribute/style/hugo-shortcodes/) in our documentation to control the presentation of content. |
| 24 | +- Documentation source is available in multiple languages in `/content/`. Each |
| 25 | + language has its own folder with a two-letter code determined by the |
| 26 | + [ISO 639-1 standard](https://www.loc.gov/standards/iso639-2/php/code_list.php). For |
| 27 | + example, English documentation source is stored in `/content/en/docs/`. |
| 28 | +- For more information about contributing to documentation in multiple languages or starting a new translation, see [localization](/docs/contribute/localization). |
| 29 | + |
| 30 | +## Before you begin {#before-you-begin} |
| 31 | + |
| 32 | +### Sign the CNCF CLA {#sign-the-cla} |
| 33 | + |
| 34 | +All Kubernetes contributors **must** read the [Contributor guide](https://github.com/kubernetes/community/blob/master/contributors/guide/README.md) and [sign the Contributor License Agreement (CLA)](https://github.com/kubernetes/community/blob/master/CLA.md). |
| 35 | + |
| 36 | +Pull requests from contributors who haven't signed the CLA fail the automated tests. The name and email you provide must match those found in your `git config`, and your git name and email must match those used for the CNCF CLA. |
| 37 | + |
| 38 | +### Choose which Git branch to use |
| 39 | + |
| 40 | +When opening a pull request, you need to know in advance which branch to base your work on. |
| 41 | + |
| 42 | +Scenario | Branch |
| 43 | +:---------|:------------ |
| 44 | +Existing or new English language content for the current release | `main` |
| 45 | +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. |
| 46 | +Content in other languages (localizations) | Use the localization's convention. See the [Localization branching strategy](/docs/contribute/localization/#branching-strategy) for more information. |
| 47 | + |
| 48 | + |
| 49 | +If you're still not sure which branch to choose, ask in `#sig-docs` on Slack. |
| 50 | + |
| 51 | +{{< note >}} |
| 52 | +If you already submitted your pull request and you know that the base branch |
| 53 | +was wrong, you (and only you, the submitter) can change it. |
| 54 | +{{< /note >}} |
| 55 | + |
| 56 | +### Languages per PR |
| 57 | + |
| 58 | +Limit pull requests to one language per PR. If you need to make an identical change to the same code sample in multiple languages, open a separate PR for each language. |
| 59 | + |
| 60 | +## Tools for contributors |
| 61 | + |
| 62 | +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. |
| 63 | + |
| 64 | + |
0 commit comments