This directory contains templates for various document types in different Kyma repositories.
NOTE: If a template does not specify otherwise, all sections are optional.
The table provides an overview of the template names, the repository they refer to, and their usage:
| Repository | Template(s) | Usage |
|---|---|---|
kyma |
README.md, NOTES.txt |
Use the template for charts. |
examples |
README.md |
Use the template for examples. |
| All | README.md |
Use the template for the main README.md document in any repository within the Kyma organization. |
kyma/docs |
cli-reference.md |
Use the template to describe the syntax and the use of CLI commands for a given component. |
kyma/docs |
custom-resource.md |
Use the template to describe a custom resource (CR) and its elements. |
| No specific repository | Kyma-branded presentation template |
Use the official Kyma-branded presentation to talk about the project and present it to new audiences. |
| No specific repository | Official Kyma graphics and logo |
Use these graphics for any Kyma-related communication. |
kyma/docs |
overview.md |
Use the template to introduce a Kyma component. |
kyma/docs |
details.md |
Use the template to provide more details about a Kyma component. |
kyma/docs |
architecture.md |
Use the template to describe the architecture of a Kyma component. |
kyma/docs |
getting-started.md |
Use the template to provide a clear step-by-step instruction that helps the user to understand a given concept better. |
community/sig-and-wg |
DR.md |
Use the template to document decisions made by SIGs and WGs. |
community/sig-and-wg |
sig-wg-readme-template.md |
Use the template for the main README.md document in a given SIG or WG folder. |
community/sig-and-wg |
sig-wg-meeting-notes-template.md |
Use the template to document meeting notes of a given SIG or WG. |
NOTE: Update the table each time you add a new template to the
resourcesfolder.
See the internal-guidelines folder for the template of an exemplary Kyma repository.