From 24c24f0c8b5f40cd436c77e665fc068012ae41dc Mon Sep 17 00:00:00 2001 From: Brandt Keller <43887158+brandtkeller@users.noreply.github.com> Date: Thu, 27 Jun 2024 14:08:11 -0700 Subject: [PATCH] chore(docs): re-organize docs for docs website consumption (#495) * chore(docs): re-organize docs for docs website consumption Signed-off-by: Brandt Keller * chore(docs): remove root sbudir readme * chore(docs): add level 1 subdirectory readmes --------- Signed-off-by: Brandt Keller Co-authored-by: Andy Mills <61879371+CloudBeard@users.noreply.github.com> --- docs/cli-commands/README.md | 1 + docs/{ => cli-commands}/evaluate.md | 0 .../{oscal-generation.md => cli-commands/generate/component.md} | 2 +- docs/{commands => cli-commands}/tools/compose.md | 0 docs/community-and-contribution/README.md | 1 + docs/{ => community-and-contribution}/dependency-updates.md | 0 docs/{ => community-and-contribution}/release-process.md | 0 docs/{ => community-and-contribution}/triage-label.md | 0 docs/oscal/README.md | 1 + docs/{ => oscal/models}/assessment-results.md | 0 docs/{ => oscal}/oscal-validation-links.md | 0 docs/reference/README.md | 1 + docs/reference/domains/README.md | 1 + docs/{ => reference/domains}/kubernetes-domain.md | 0 docs/reference/providers/README.md | 1 + docs/{ => reference/providers}/kyverno-provider.md | 0 docs/{ => reference/providers}/opa-provider.md | 0 docs/{ => reference}/version-specification.md | 0 18 files changed, 7 insertions(+), 1 deletion(-) create mode 100644 docs/cli-commands/README.md rename docs/{ => cli-commands}/evaluate.md (100%) rename docs/{oscal-generation.md => cli-commands/generate/component.md} (99%) rename docs/{commands => cli-commands}/tools/compose.md (100%) create mode 100644 docs/community-and-contribution/README.md rename docs/{ => community-and-contribution}/dependency-updates.md (100%) rename docs/{ => community-and-contribution}/release-process.md (100%) rename docs/{ => community-and-contribution}/triage-label.md (100%) create mode 100644 docs/oscal/README.md rename docs/{ => oscal/models}/assessment-results.md (100%) rename docs/{ => oscal}/oscal-validation-links.md (100%) create mode 100644 docs/reference/README.md create mode 100644 docs/reference/domains/README.md rename docs/{ => reference/domains}/kubernetes-domain.md (100%) create mode 100644 docs/reference/providers/README.md rename docs/{ => reference/providers}/kyverno-provider.md (100%) rename docs/{ => reference/providers}/opa-provider.md (100%) rename docs/{ => reference}/version-specification.md (100%) diff --git a/docs/cli-commands/README.md b/docs/cli-commands/README.md new file mode 100644 index 00000000..5f3cfa74 --- /dev/null +++ b/docs/cli-commands/README.md @@ -0,0 +1 @@ +# CLI Commands \ No newline at end of file diff --git a/docs/evaluate.md b/docs/cli-commands/evaluate.md similarity index 100% rename from docs/evaluate.md rename to docs/cli-commands/evaluate.md diff --git a/docs/oscal-generation.md b/docs/cli-commands/generate/component.md similarity index 99% rename from docs/oscal-generation.md rename to docs/cli-commands/generate/component.md index e0e9acf5..ec0e0d59 100644 --- a/docs/oscal-generation.md +++ b/docs/cli-commands/generate/component.md @@ -1,4 +1,4 @@ -# OSCAL Generation +# Component Lula can generate OSCAL templates to help with authoring OSCAL artifacts. These generation processes help with initial build and maintenance of OSCAL artifacts and keeps with the vision of modular compliance artifacts that live with the source code. diff --git a/docs/commands/tools/compose.md b/docs/cli-commands/tools/compose.md similarity index 100% rename from docs/commands/tools/compose.md rename to docs/cli-commands/tools/compose.md diff --git a/docs/community-and-contribution/README.md b/docs/community-and-contribution/README.md new file mode 100644 index 00000000..8cc522fb --- /dev/null +++ b/docs/community-and-contribution/README.md @@ -0,0 +1 @@ +# Community and Contribution \ No newline at end of file diff --git a/docs/dependency-updates.md b/docs/community-and-contribution/dependency-updates.md similarity index 100% rename from docs/dependency-updates.md rename to docs/community-and-contribution/dependency-updates.md diff --git a/docs/release-process.md b/docs/community-and-contribution/release-process.md similarity index 100% rename from docs/release-process.md rename to docs/community-and-contribution/release-process.md diff --git a/docs/triage-label.md b/docs/community-and-contribution/triage-label.md similarity index 100% rename from docs/triage-label.md rename to docs/community-and-contribution/triage-label.md diff --git a/docs/oscal/README.md b/docs/oscal/README.md new file mode 100644 index 00000000..bac7556d --- /dev/null +++ b/docs/oscal/README.md @@ -0,0 +1 @@ +# Open Security Controls Assessment Language \ No newline at end of file diff --git a/docs/assessment-results.md b/docs/oscal/models/assessment-results.md similarity index 100% rename from docs/assessment-results.md rename to docs/oscal/models/assessment-results.md diff --git a/docs/oscal-validation-links.md b/docs/oscal/oscal-validation-links.md similarity index 100% rename from docs/oscal-validation-links.md rename to docs/oscal/oscal-validation-links.md diff --git a/docs/reference/README.md b/docs/reference/README.md new file mode 100644 index 00000000..cf89fcc7 --- /dev/null +++ b/docs/reference/README.md @@ -0,0 +1 @@ +# Validation Reference \ No newline at end of file diff --git a/docs/reference/domains/README.md b/docs/reference/domains/README.md new file mode 100644 index 00000000..01c80935 --- /dev/null +++ b/docs/reference/domains/README.md @@ -0,0 +1 @@ +# Domains \ No newline at end of file diff --git a/docs/kubernetes-domain.md b/docs/reference/domains/kubernetes-domain.md similarity index 100% rename from docs/kubernetes-domain.md rename to docs/reference/domains/kubernetes-domain.md diff --git a/docs/reference/providers/README.md b/docs/reference/providers/README.md new file mode 100644 index 00000000..561a124f --- /dev/null +++ b/docs/reference/providers/README.md @@ -0,0 +1 @@ +# Providers \ No newline at end of file diff --git a/docs/kyverno-provider.md b/docs/reference/providers/kyverno-provider.md similarity index 100% rename from docs/kyverno-provider.md rename to docs/reference/providers/kyverno-provider.md diff --git a/docs/opa-provider.md b/docs/reference/providers/opa-provider.md similarity index 100% rename from docs/opa-provider.md rename to docs/reference/providers/opa-provider.md diff --git a/docs/version-specification.md b/docs/reference/version-specification.md similarity index 100% rename from docs/version-specification.md rename to docs/reference/version-specification.md