chore(docs): re-organize docs for docs website consumption (#495)

* chore(docs): re-organize docs for docs website consumption Signed-off-by: Brandt Keller <brandt.keller@defenseunicorns.com> * chore(docs): remove root sbudir readme * chore(docs): add level 1 subdirectory readmes --------- Signed-off-by: Brandt Keller <brandt.keller@defenseunicorns.com> Co-authored-by: Andy Mills <61879371+CloudBeard@users.noreply.github.com>
defenseunicorns · Jun 27, 2024 · 24c24f0 · 24c24f0
1 parent 471e9c5
commit 24c24f0
Show file tree

Hide file tree

Showing 18 changed files with 7 additions and 1 deletion.
diff --git a/docs/cli-commands/README.md b/docs/cli-commands/README.md
@@ -0,0 +1 @@
+# CLI Commands
diff --git a/docs/evaluate.md → docs/cli-commands/evaluate.md b/docs/evaluate.md → docs/cli-commands/evaluate.md
diff --git a/docs/oscal-generation.md → docs/cli-commands/generate/component.md b/docs/oscal-generation.md → 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 → docs/cli-commands/tools/compose.md b/docs/commands/tools/compose.md → docs/cli-commands/tools/compose.md
diff --git a/docs/community-and-contribution/README.md b/docs/community-and-contribution/README.md
@@ -0,0 +1 @@
+# Community and Contribution
diff --git a/docs/dependency-updates.md → ...ty-and-contribution/dependency-updates.md b/docs/dependency-updates.md → ...ty-and-contribution/dependency-updates.md
diff --git a/docs/release-process.md → ...unity-and-contribution/release-process.md b/docs/release-process.md → ...unity-and-contribution/release-process.md
diff --git a/docs/triage-label.md → ...ommunity-and-contribution/triage-label.md b/docs/triage-label.md → ...ommunity-and-contribution/triage-label.md
diff --git a/docs/oscal/README.md b/docs/oscal/README.md
@@ -0,0 +1 @@
+# Open Security Controls Assessment Language
diff --git a/docs/assessment-results.md → docs/oscal/models/assessment-results.md b/docs/assessment-results.md → docs/oscal/models/assessment-results.md
diff --git a/docs/oscal-validation-links.md → docs/oscal/oscal-validation-links.md b/docs/oscal-validation-links.md → docs/oscal/oscal-validation-links.md
diff --git a/docs/reference/README.md b/docs/reference/README.md
@@ -0,0 +1 @@
+# Validation Reference
diff --git a/docs/reference/domains/README.md b/docs/reference/domains/README.md
@@ -0,0 +1 @@
+# Domains
diff --git a/docs/kubernetes-domain.md → docs/reference/domains/kubernetes-domain.md b/docs/kubernetes-domain.md → docs/reference/domains/kubernetes-domain.md
diff --git a/docs/reference/providers/README.md b/docs/reference/providers/README.md
@@ -0,0 +1 @@
+# Providers
diff --git a/docs/kyverno-provider.md → docs/reference/providers/kyverno-provider.md b/docs/kyverno-provider.md → docs/reference/providers/kyverno-provider.md
diff --git a/docs/opa-provider.md → docs/reference/providers/opa-provider.md b/docs/opa-provider.md → docs/reference/providers/opa-provider.md
diff --git a/docs/version-specification.md → docs/reference/version-specification.md b/docs/version-specification.md → docs/reference/version-specification.md