Documentation contributions

Information about contributing to the Keptn documentation

This section is under development. Contents are not complete, but all material here has been reviewed for technical accuracy.

Keptn software and documentation is developed and maintained by the Keptn community. We invite you to join us.


CRD name

template for new CRD reference pages

Contribution guidelines for documentation

Guidelines for contributing towards Keptn

Build Documentation Locally

This guide explains how to create a local version of the documentation

Linter Requirements

To maintain optimal code quality, this project employs linters which require a specific IDE configuration for effective utilization.

Spell checker

How to work with the spell checker

Source File Structure

Structure source files with Metadata

Published Doc Structure

Structure of the published documentation

Word list

Proper use of terms for the Keptn project documentation