📖 Generate probe markdown documentation #4184
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. Signed-off-by: Spencer Schrock <[email protected]>
Signed-off-by: Spencer Schrock <[email protected]>
Note: There is no validate-docs step for the probes code, as the def.yml fields are validated elsewhere currently in the unit tests. Signed-off-by: Spencer Schrock <[email protected]>
Signed-off-by: Spencer Schrock <[email protected]>
raghavkaul
approved these changes
Jun 20, 2024
raghavkaul
pushed a commit
to raghavkaul/scorecard
that referenced
this pull request
Jul 1, 2024
* generate probe markdown documentation 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. Signed-off-by: Spencer Schrock <[email protected]> * fix linter Signed-off-by: Spencer Schrock <[email protected]> * add probe doc generation to Makefile Note: There is no validate-docs step for the probes code, as the def.yml fields are validated elsewhere currently in the unit tests. Signed-off-by: Spencer Schrock <[email protected]> * fix license for new yaml package Signed-off-by: Spencer Schrock <[email protected]> --------- Signed-off-by: Spencer Schrock <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What kind of change does this PR introduce?
documentation
What is the current behavior?
Users need to read the various probe
def.ymlfilesWhat 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.)