Users need to read the various probe def.yml files
What is the new behavior (if this is a feature change)?**
Users can read docs/probes.md (view the current status from this commit here)
Walks the various probes def.yaml files and puts them in a single markdown document. This doesn't currently include the remediation, but neither does the existing checks.md document either.
In order to avoid duplicating yaml definitions, this existing ones were moved to an internal directory so they can be reused.
[ ] Tests for the changes have been added (for bug fixes/features)
Which issue(s) this PR fixes
NONE
Special notes for your reviewer
Does this PR introduce a user-facing change?
For user-facing changes, please add a concise, human-readable release note to
the release-note
(In particular, describe what changes users might need to make in their
application as a result of this pull request.)
What kind of change does this PR introduce?
documentation
What is the current behavior?
Users need to read the various probe
def.yml
filesWhat is the new behavior (if this is a feature change)?**
Users can read
docs/probes.md
(view the current status from this commit here)Walks the various probes def.yaml files and puts them in a single markdown document. This doesn't currently include the remediation, but neither does the existing checks.md document either.
In order to avoid duplicating yaml definitions, this existing ones were moved to an internal directory so they can be reused.
Which issue(s) this PR fixes
NONE
Special notes for your reviewer
Does this PR introduce a user-facing change?
For user-facing changes, please add a concise, human-readable release note to the
release-note
(In particular, describe what changes users might need to make in their application as a result of this pull request.)