readme_missing

Category

Documentation

Severity

Error

What It Does

Checks all v2 formulas and profiles if the README.md file exists.

Why Is This Bad

For documentation purposes formulas and profiles should have a README.md to make it easier to figure out what the purpose of the state is.

How To Fix

Create a new README.md file that has the state name as the first header and then a short description of what the purpose of the state is.

Example README.md from formula.helper_scripts
# formula.helper_scripts

A collection of usefull scripts that can be used with cmd.script.

Known Problems

None

Example

states/formula/helper_scripts
├── fix_user
├── init.sls
├── map.jinja
└── pillar.example

0 directories, 4 files
warning: formula `formula.helper_scripts` does not have a README.md file at the expected path
  quickfix: create an file under "/home/athaller/code/work/salt/saltstack/states/formula/helper_scripts/README.md" that at least contains the name of the formula as a first markdown header

results matching ""

    No results matching ""