These guidelines provide rules and tips to all who contribute content to the Kyma repositories.
Content Strategy: Understand our target audience and documentation structure.
User Documentation: Define the structure of user documentation and publish it on kyma-project.io.
Documentation Templates: Use standardized templates for concept topics, task topics, custom resources, troubleshooting guides, and release notes.
Formatting: Learn about code font and bold font, how to create "Note" boxes, and correct headings.
Style and Terminology: Use active voice and present tense. Look up correct capitalization and vocabulary.
UI Elements: Create concise buttons, tooltips, and (error) messages.
Tabs and Toggles: Create tabs or expandable sections, for example, for code blocks.
Links: Create meaningful links.
Release Notes: Write release notes for (pre-modular) Kyma.
Screenshots: Create useful screenshots.
Diagrams: Learn about the diagram style we use in Kyma.
Autogenerate CRD Documentation: Use tools to automatically generate custom resource documentation from code.
Preview Documentation: Before publishing on kyma-project.io, check how your docs will look like.