Skip to content

Commit 1605036

Browse files
committed
Copy overview.md and _index.md for the translation
1 parent c2f183b commit 1605036

File tree

2 files changed

+69
-0
lines changed

2 files changed

+69
-0
lines changed
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: Contributing new content
3+
weight: 20
4+
---
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
---
2+
title: Contributing new content overview
3+
linktitle: Overview
4+
content_type: concept
5+
main_menu: true
6+
weight: 5
7+
---
8+
9+
<!-- overview -->
10+
11+
This section contains information you should know before contributing new content.
12+
13+
14+
15+
16+
<!-- body -->
17+
18+
## Contributing basics
19+
20+
- Write Kubernetes documentation in Markdown and build the Kubernetes site using [Hugo](https://gohugo.io/).
21+
- 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.
22+
- [Page content types](/docs/contribute/style/page-content-types/) describe the presentation of documentation content in Hugo.
23+
- In addition to the standard Hugo shortcodes, we use a number of
24+
[custom Hugo shortcodes](/docs/contribute/style/hugo-shortcodes/) in our documentation to control the presentation of content.
25+
- Documentation source is available in multiple languages in `/content/`. Each
26+
language has its own folder with a two-letter code determined by the
27+
[ISO 639-1 standard](https://www.loc.gov/standards/iso639-2/php/code_list.php). For
28+
example, English documentation source is stored in `/content/en/docs/`.
29+
- For more information about contributing to documentation in multiple languages or starting a new translation, see [localization](/docs/contribute/localization).
30+
31+
## Before you begin {#before-you-begin}
32+
33+
### Sign the CNCF CLA {#sign-the-cla}
34+
35+
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).
36+
37+
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.
38+
39+
### Choose which Git branch to use
40+
41+
When opening a pull request, you need to know in advance which branch to base your work on.
42+
43+
Scenario | Branch
44+
:---------|:------------
45+
Existing or new English language content for the current release | `master`
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+
Content in other languages (localizations) | Use the localization's convention. See the [Localization branching strategy](/docs/contribute/localization/#branching-strategy) for more information.
48+
49+
50+
If you're still not sure which branch to choose, ask in `#sig-docs` on Slack.
51+
52+
{{< note >}}
53+
If you already submitted your pull request and you know that the base branch
54+
was wrong, you (and only you, the submitter) can change it.
55+
{{< /note >}}
56+
57+
### Languages per PR
58+
59+
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.
60+
61+
## Tools for contributors
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.
64+
65+

0 commit comments

Comments
 (0)