Project Instructions
Code Style
- Use Markdown for any documentation file.
- Add a
README.md in the root of main folder to describe it.
- The
README.md file includes introduction sections and how to use or apply them.
- Concentrate documentation in the minimum number of files to facilitate how to consume them.
- YAML files will use
.yaml file suffix.
- Declare the type of Kubernetes object as suffix of the file name files. E.g:
sample-configmap.yaml for a ConfigMap.
- Use dash character (
-) in file names.
Documentation
- Link documentation to the last official documentation of the product to enhance the content
- Info the reader to use the proper required user privileges to run commands.