Documentation

Overview

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

Start with the overarching Kyma documentation where you can find the general information on Kyma and the Getting Started guides. Then, read about the product in more detail:

• API Gateway
• Application Connector
• Backup
• Console
• Eventing
• Helm Broker
• Logging
• Monitoring
• Rafter
• Runtime Agent
• Security
• Serverless
• Service Catalog
• Service Mesh
• Tracing

Read it directly in GitHub or inside the Kyma Console if you have access to the Kyma cluster.

The navigation order of the documentation page is based on the rafter.kyma-project.io/order label specified in the ClusterAssetGroup for a given Kyma component.

Development

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

1. Get familiar with the Content Strategy to learn about the Kyma's 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.