repo-setup.md

Repository setup

We recommend that CNCF projects separate docs into their own repository, away from code. This has the following advantages:

• Docs contributors don't need to know the full code build pipeline
• It simplifies repo management/continuous integration setup

For more information:

• The cncf/project-template repository contains many of the files needed to set up a new repository

CLA/DCO

CLA/DCO should be set up for a project as a part of their project onboarding.

License files

Unless otherwise specified, documentation for CNCF projects is licensed under CC-BY-4.0. Code is licensed under Apache 2.0.

Most CNCF documentation repositories are a mix of code (website code) and documentation itself, so they need two license files.

For documentation this means you must:

1. Add copyright notices for both the code and the docs to the repository's README and the website's footer

   For the repository:

   # License
   
   $PROJECT_NAME is licensed under an [Apache 2.0 license](./LICENSE).
   
   The #PROJECT_NAME documentation is licensed under a
   [CC-BY-4.0 license](./LICENSE-docs).

2. Add both the CC-BY-4.0 LICENCE-docs and Apache 2.0 LICENCE files to the root directory of the documentation. For a plain text versions of both, see cncf/project-template

For more information, see:

• CNCF's project copyright guidelines
• IP Policy

README

All docs repositories should have a README file that includes build instructions. Look at Longhorn's for an example, and the cncf/project-template for boilerplate.