docs

Documentation

Overview

The docs folder contains end-to-end documentation on Compass and its components.

Start with the overarching Compass documentation where you can find general information on Compass. The documents are arranged in the fixed order that follows the content strategy. Then, read about the components in more detail:

• Connector
• Director
• Integration System
• Runtime Agent
• Runtime Provisioner

Docs structure

The directory has the following structure:

  ├── compass                  # Overarching Compass documentation
  ├── connector                # Documentation for the Connector component     
  ├── director                 # Documentation for the Director component      
  ├── integration-system       # Documentation for the Integration System component                                    
  ├── internal                 # Internal documentation, such as investigations, proposals, and standards
  ├── kyma-environment-broker  # Documentation for the Kyma Environment Broker component
  ├── provisioner              # Documentation for the Runtime Provisioner component                                          
  └── runtime-agent            # Documentation for the Runtime Agent 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.