templates

Templates

Overview

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 README.md document in any repository, directory, or subdirectory within the Kyma organization.
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	architecture.md	Use the template to describe the architecture of a Kyma component.
kyma/docs	details.md	Use the template to provide more details about a Kyma component.
kyma/docs	configuration.md	Use the template to describe configuration options for a Kyma chart or sub-chart.
kyma/docs	custom-resource.md	Use the template to describe a custom resource (CR) and its elements.
kyma/docs	cli-reference.md	Use the template to describe the syntax and the use of CLI commands for a given component.
kyma/docs	tutorials.md	Use the template to provide a clear step-by-step instruction that helps the user to understand a given concept better.
kyma/docs	troubleshooting.md	Use the template to explain all details needed for Kyma and its components' troubleshooting.
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.
website/content/blog-posts	release-notes.md	Use the template to write release notes. This template is dedicated to technical writers.
Internal use	release-notes-input.md	Use the template to provide input for the release notes. This template is dedicated to product owners.

NOTE: Update the table each time you add a new template to the resources folder.

See the internal-guidelines folder for the template of an exemplary Kyma repository.