Skip to content

Latest commit

 

History

History
20 lines (18 loc) · 1.17 KB

overview.md

File metadata and controls

20 lines (18 loc) · 1.17 KB
Raw
title type
Overview
Overview

NOTE: In case there are more than one Overview documents in a repository, follow this convention for a title: {Component name} overview.

NOTE: Blockquotes in this document provide instructions. Remove them from the final document.

This is a template for the Overview document type that introduces a given Kyma component.

In the document:

  • Describe the component in general.
  • Provide its purpose and function.
  • Be short but descriptive.
  • Avoid headings. If you want to provide more details, create a separate Details document.
  • Follow the {000}-overview-{component-name}.md convention to name the document.
  • In the metadata section, follow the {Component name} overview convention for the title if there are more than one Overview document in a repository. If there is only one document of a certain type, remove the type metadata completely so that the document displays well on the UI.

For reference, see the existing Overview document for the Application Connector.