scorecard/docs
Spencer Schrock 0d57c0224a
📖 Generate probe markdown documentation (#4184)
* 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 <sschrock@google.com>

* fix linter

Signed-off-by: Spencer Schrock <sschrock@google.com>

* 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 <sschrock@google.com>

* fix license for new yaml package

Signed-off-by: Spencer Schrock <sschrock@google.com>

---------

Signed-off-by: Spencer Schrock <sschrock@google.com>
2024-06-20 21:05:06 +00:00
..
checks 📖 Improve the REUSE parts of the License check (#4155) 2024-06-12 16:19:35 +00:00
design 📖 Update Branch-Protection admin and non-admin requirements (#2772) 2023-07-07 15:29:33 -04:00
probes/internal/generate 📖 Generate probe markdown documentation (#4184) 2024-06-20 21:05:06 +00:00
beginner-checks.md 📖 Add beginner's guide to scorecard checks docs (#3617) 2023-11-29 21:17:56 +00:00
checks.md 📖 Improve the REUSE parts of the License check (#4155) 2024-06-12 16:19:35 +00:00
faq.md 📖 docs: update website (#4041) 2024-04-18 16:36:01 -07:00
probes.md 📖 Generate probe markdown documentation (#4184) 2024-06-20 21:05:06 +00:00
repositories.md docs: Add repository guidelines e.g., for project donations (#4123) 2024-05-30 12:40:14 +00:00