docs/

README

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 Kyma Community content strategy. Then, read about the components in more detail:

• Connector
• Director
• Integration System
• Runtime Agent
• System Broker
• System Fetcher
• Asynchronous Operations Controller

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 general contribution rules and process. See Contributing Rules.
3. Make use of the templates to structure your documents properly. See Document Types Templates.
4. Be compliant with the writing guidelines to contribute high-quality and standardized content. See Content Guidelines.