Documentation

Overview

The docs folder contains documentation on Kyma Control Plane (KCP) and its components. The documents are arranged in the fixed order that follows the content strategy.

Start with the overarching KCP documentation where you can find general information on KCP. Then, read about these components in more detail:

• KCP CLI
• Kyma Environment Broker
• Runtime Provisioner

Docs structure

The directory has the following structure:

  ├── cli                        # Documentation for KCP CLI
  ├── internal                   # Internal documentation, such as investigations, proposals, and standards
  ├── kyma-control-plane         # Overarching documentation for Kyma Control Plane                                     
  ├── kyma-environment-broker    # Documentation for the Kyma Environment Broker component                                     
  └── provisioner                # Documentation for the Runtime Provisioner component     

Development

Follow these basic rules when you add a new document to the official documentation:

1. Get familiar with the Content Strategy to learn about the official approach to content development.
2. Follow the Contribution Guide for the general contribution rules and process.
3. Make use of the templates to structure your documents properly.
4. Be compliant with the writing guidelines to contribute high-quality and standardized content.