Contributing new content

    flowchart LR subgraph second[Before you begin] direction TB S[ ] -.- A[Sign the CNCF CLA] —> B[Choose Git branch] B —> C[One language per PR] C —> F[Check out
    contributor tools] end subgraph first[Contributing Basics] direction TB T[ ] -.- D[Write docs in markdown
    and build site with Hugo] —- E[source in GitHub] E —- G[‘/content/../docs’ folder contains docs
    for multiple languages] G —- H[Review Hugo page content
    types and shortcodes] end first ——> second classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px; classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold classDef spacewhite fill:#ffffff,stroke:#fff,stroke-width:0px,color:#000 class A,B,C,D,E,F,G,H grey class S,T spacewhite class first,second white

    JavaScript must be enabled to view this content

    Figure - Contributing new content preparation

    • Write Kubernetes documentation in Markdown and build the Kubernetes site using Hugo.
    • Kubernetes documentation uses as its flavor of Markdown.
    • Page content types describe the presentation of documentation content in Hugo.
    • You can use or custom Hugo shortcodes to contribute to Kubernetes documentation.
    • In addition to the standard Hugo shortcodes, we use a number of in our documentation to control the presentation of content.
    • Documentation source is available in multiple languages in /content/. Each language has its own folder with a two-letter code determined by the ISO 639-1 standard . For example, English documentation source is stored in .
    • For more information about contributing to documentation in multiple languages or starting a new translation, see .

    All Kubernetes contributors must read the Contributor guide and .

    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.

    When opening a pull request, you need to know in advance which branch to base your work on.

    Note: If you already submitted your pull request and you know that the base branch was wrong, you (and only you, the submitter) can change it.

    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.

    The directory in the kubernetes/website repository contains tools to help your contribution journey go more smoothly.