templates-type.md

Document Types Templates

Use a particular document type template to be consistent with the Kyma standards. The tables provide an overview of the template names, the repository they refer to, and their usage:

NOTE: If a template does not specify otherwise, all sections are optional.

General Documents

This table contains templates for general documents.

Repository	Template	Usage	Author
All	README.md	Use the template for the README.md document in any repository, directory, or subdirectory within the Kyma organization.	All contributors

Document Types for Kyma Areas and Components

This table lists all document types used to fully describe a Kyma area and/or component.

Repository	Template	Usage	Author
kyma/docs	concept.md	Use the template to introduce a given concept.	All contributors
kyma/docs	architecture.md	Use the template to describe the architecture of a Kyma component.	All contributors
kyma/docs	configuration.md	Use the template to describe configuration options for a Kyma chart or sub-chart.	All contributors
kyma/docs	custom-resource.md	Use the template to describe a custom resource (CR) and its elements.	All contributors
kyma/docs	task.md	Use the template to provide a clear step-by-step instruction.	All contributors
kyma/docs	troubleshooting.md	Use the template to explain all details needed for Kyma and its components' troubleshooting.	All contributors

Official Kyma Graphics and Logo

See the following table to find a template of Kyma graphics and logo.

Repository	Template	Usage	Author
No specific repository	Official Kyma graphics and logo	Use these graphics for any Kyma-related communication.	All contributors

Repository Templates

Go to the template-repository directory for the template of an exemplary Kyma repository.

Special Interest Group and Working Group

In the table you can find README.md and meeting notes templates for SIGs and WGs.

Repository	Template	Usage	Author
community/sigs-and-wgs	sig-wg-readme-template.md	Use the template for the main README.md document in a given SIG or WG folder.	SIG and WG members
community/sigs-and-wgs	sig-wg-meeting-notes-template.md	Use the template to document meeting notes of a given SIG or WG.	SIG and WG members