Merge pull request #10 from arewm/doc-outline

arewm · web-flow · commit d0104e837155 · 2024-04-26T14:52:49.000-04:00
Initial doc layout with left navigation and page stubs
diff --git a/.gitignore b/.gitignore
@@ -26,6 +26,7 @@ tmp/
 # Antora working directories
 node_modules/
 build/
+!docs/modules/ROOT/**/build
 public/
 .idea/
 .cache
diff --git a/docs/antora.yml b/docs/antora.yml
@@ -1,8 +1,14 @@
 ---
 name: ROOT
+title: Konflux-CI
 version: ~
 nav:
-- modules/ROOT/nav-root.adoc
+- modules/ROOT/pages/discover/_nav.adoc
+- modules/ROOT/pages/getting-started/_nav.adoc
+- modules/ROOT/pages/how-tos/_nav.adoc
+- modules/ROOT/pages/advanced-how-tos/_nav.adoc
+- modules/ROOT/pages/glossary/_nav.adoc
+- modules/ROOT/pages/contribute/_nav.adoc
 
 asciidoc:
   attributes:
diff --git a/docs/modules/ROOT/nav-root.adoc b/docs/modules/ROOT/nav-root.adoc
diff --git a/docs/modules/ROOT/pages/advanced-how-tos/_nav.adoc b/docs/modules/ROOT/pages/advanced-how-tos/_nav.adoc
@@ -0,0 +1,8 @@
+* xref:advanced-how-tos/index.adoc[Advanced how-tos]
+** xref:advanced-how-tos/installing.adoc[Installing {ProductName}]
+** xref:advanced-how-tos/managing-compliance-with-ec.adoc[Managing compliance with EC]
+** xref:advanced-how-tos/releasing/index.adoc[Releasing an application]
+*** xref:advanced-how-tos/releasing/create-release-plan.adoc[Creating a release plan]
+*** xref:advanced-how-tos/releasing/create-release-plan-admission.adoc[Creating a release plan admission]
+** xref:advanced-how-tos/managing-multiple-versions.adoc[Managing multiple software versions]
+** xref:advanced-how-tos/managing-security-fix.adoc[Managing a security fix]
diff --git a/docs/modules/ROOT/pages/advanced-how-tos/index.adoc b/docs/modules/ROOT/pages/advanced-how-tos/index.adoc
@@ -0,0 +1 @@
+= How to do more than just building artifacts in {ProductName}
diff --git a/docs/modules/ROOT/pages/advanced-how-tos/installing.adoc b/docs/modules/ROOT/pages/advanced-how-tos/installing.adoc
@@ -0,0 +1 @@
+= Installing {ProductName}
diff --git a/docs/modules/ROOT/pages/advanced-how-tos/managing-compliance-with-ec.adoc b/docs/modules/ROOT/pages/advanced-how-tos/managing-compliance-with-ec.adoc
@@ -0,0 +1 @@
+= Managing compliance with Enterprise Contract
diff --git a/docs/modules/ROOT/pages/advanced-how-tos/managing-multiple-versions.adoc b/docs/modules/ROOT/pages/advanced-how-tos/managing-multiple-versions.adoc
@@ -0,0 +1 @@
+= Managing multiple software versions
diff --git a/docs/modules/ROOT/pages/advanced-how-tos/managing-security-fix.adoc b/docs/modules/ROOT/pages/advanced-how-tos/managing-security-fix.adoc
@@ -0,0 +1 @@
+= Managing a security fix
diff --git a/docs/modules/ROOT/pages/advanced-how-tos/releasing/create-release-plan-admission.adoc b/docs/modules/ROOT/pages/advanced-how-tos/releasing/create-release-plan-admission.adoc
@@ -0,0 +1 @@
+= Creating a release plan admission
diff --git a/docs/modules/ROOT/pages/advanced-how-tos/releasing/create-release-plan.adoc b/docs/modules/ROOT/pages/advanced-how-tos/releasing/create-release-plan.adoc
@@ -0,0 +1 @@
+= Creating a release plan
diff --git a/docs/modules/ROOT/pages/advanced-how-tos/releasing/index.adoc b/docs/modules/ROOT/pages/advanced-how-tos/releasing/index.adoc
@@ -0,0 +1 @@
+= Releasing an application
diff --git a/docs/modules/ROOT/pages/contribute/_nav.adoc b/docs/modules/ROOT/pages/contribute/_nav.adoc
@@ -0,0 +1 @@
+* xref:contribute/index.adoc[Contribute]
diff --git a/docs/modules/ROOT/pages/contribute/index.adoc b/docs/modules/ROOT/pages/contribute/index.adoc
@@ -0,0 +1 @@
+= Contribute to {ProductName}
diff --git a/docs/modules/ROOT/pages/discover/_nav.adoc b/docs/modules/ROOT/pages/discover/_nav.adoc
@@ -0,0 +1,3 @@
+* Discover
+** xref:discover/index.adoc[Why {ProductName}]
+** xref:discover/slsa-conformity.adoc[Supply chain security through SLSA conformity]
diff --git a/docs/modules/ROOT/pages/discover/index.adoc b/docs/modules/ROOT/pages/discover/index.adoc
@@ -0,0 +1 @@
+= Discover {ProductName}
diff --git a/docs/modules/ROOT/pages/discover/slsa-conformity.adoc b/docs/modules/ROOT/pages/discover/slsa-conformity.adoc
@@ -0,0 +1 @@
+= Supply chain security through SLSA conformity
diff --git a/docs/modules/ROOT/pages/getting-started/_nav.adoc b/docs/modules/ROOT/pages/getting-started/_nav.adoc
@@ -0,0 +1,3 @@
+* Getting started
+** xref:getting-started/index.adoc[Getting started with {ProductName}]
+** xref:getting-started/cli.adoc[Getting started with the CLI]
diff --git a/docs/modules/ROOT/pages/getting-started/cli.adoc b/docs/modules/ROOT/pages/getting-started/cli.adoc
@@ -0,0 +1 @@
+= Getting started with the CLI
diff --git a/docs/modules/ROOT/pages/getting-started/index.adoc b/docs/modules/ROOT/pages/getting-started/index.adoc
@@ -0,0 +1 @@
+= Getting started with {ProductName}
diff --git a/docs/modules/ROOT/pages/glossary/_nav.adoc b/docs/modules/ROOT/pages/glossary/_nav.adoc
@@ -0,0 +1 @@
+* xref:glossary/index.adoc[Glossary]
diff --git a/docs/modules/ROOT/pages/glossary/index.adoc b/docs/modules/ROOT/pages/glossary/index.adoc
@@ -0,0 +1 @@
+= Glossary of terms related to {ProductName}
diff --git a/docs/modules/ROOT/pages/how-tos/_nav.adoc b/docs/modules/ROOT/pages/how-tos/_nav.adoc
@@ -0,0 +1,22 @@
+* xref:how-tos/index.adoc[How-tos]
+** xref:how-tos/creating.adoc[Creating applications and components]
+** xref:how-tos/configuring/index.adoc[Configuring your builds]
+*** xref:how-tos/configuring/customizing-the-build.adoc[Customizing the build pipeline]
+*** xref:how-tos/configuring/creating-secrets.adoc[Creating secrets for your builds]
+*** xref:how-tos/configuring/configuration-as-code.adoc[Configuration as code]
+*** xref:how-tos/configuring/hermetic-builds.adoc[Enabling hermetic builds]
+*** xref:how-tos/configuring/prefetching-dependencies.adoc[Prefetching package manage dependencies]
+*** xref:how-tos/configuring/component-nudges.adoc[Defining component relationships]
+*** xref:how-tos/configuring/redundant-rebuilds.adoc[Preventing redundant rebuilds]
+** xref:how-tos/testing/index.adoc[Testing your components and applications]
+*** xref:how-tos/testing/overview.adoc[Overview of Konflux tests]
+*** xref:how-tos/testing/build/index.adoc[Build-time tests]
+**** xref:how-tos/testing/build/snyk.adoc[Enabling Snyk]
+*** xref:how-tos/testing/integration/index.adoc[Integration tests]
+**** xref:how-tos/testing/integration/adding.adoc[Adding an integration test]
+**** xref:how-tos/testing/integration/creating.adoc[Creating a custom integration test]
+**** xref:how-tos/testing/integration/rerunning.adoc[Rerunning an integration test]
+** xref:how-tos/metadata/index.adoc[Inspecting provenance and attestations]
+*** xref:how-tos/metadata/sboms.adoc[Inspecting SBOMs]
+*** xref:how-tos/metadata/provenance.adoc[Downloading the SLSA provenance]
+** xref:how-tos/deleting.adoc[Deleting applications and components]
diff --git a/docs/modules/ROOT/pages/how-tos/configuring/component-nudges.adoc b/docs/modules/ROOT/pages/how-tos/configuring/component-nudges.adoc
@@ -0,0 +1 @@
+= Defining component relationships
diff --git a/docs/modules/ROOT/pages/how-tos/configuring/configuration-as-code.adoc b/docs/modules/ROOT/pages/how-tos/configuring/configuration-as-code.adoc
@@ -0,0 +1,4 @@
+= Configuration as code
+
++
+NOTE: Is this topic needed or can it be rolled into index.adoc?
diff --git a/docs/modules/ROOT/pages/how-tos/configuring/creating-secrets.adoc b/docs/modules/ROOT/pages/how-tos/configuring/creating-secrets.adoc
@@ -0,0 +1 @@
+= Creating secrets for your builds
diff --git a/docs/modules/ROOT/pages/how-tos/configuring/customizing-the-build.adoc b/docs/modules/ROOT/pages/how-tos/configuring/customizing-the-build.adoc
@@ -0,0 +1 @@
+= Customizing the build pipeline
diff --git a/docs/modules/ROOT/pages/how-tos/configuring/hermetic-builds.adoc b/docs/modules/ROOT/pages/how-tos/configuring/hermetic-builds.adoc
@@ -0,0 +1 @@
+= Enabling hermetic builds
diff --git a/docs/modules/ROOT/pages/how-tos/configuring/index.adoc b/docs/modules/ROOT/pages/how-tos/configuring/index.adoc
@@ -0,0 +1 @@
+= Configuring your builds
diff --git a/docs/modules/ROOT/pages/how-tos/configuring/prefetching-dependencies.adoc b/docs/modules/ROOT/pages/how-tos/configuring/prefetching-dependencies.adoc
@@ -0,0 +1,7 @@
+= Prefetching package manager dependencies for hermetic builds
+
++
+NOTE: We may want to rephrase this to word for more accurate SBOM information
+
++
+NOTE: Should this be a subtopic for hermetic or a sibling to it?
diff --git a/docs/modules/ROOT/pages/how-tos/configuring/redundant-rebuilds.adoc b/docs/modules/ROOT/pages/how-tos/configuring/redundant-rebuilds.adoc
@@ -0,0 +1,4 @@
+= Preventing redundant rebuilds
+
++
+NOTE: Is this builds or rebuilds?
diff --git a/docs/modules/ROOT/pages/how-tos/creating.adoc b/docs/modules/ROOT/pages/how-tos/creating.adoc
@@ -0,0 +1 @@
+= Creating applications and components
diff --git a/docs/modules/ROOT/pages/how-tos/deleting.adoc b/docs/modules/ROOT/pages/how-tos/deleting.adoc
@@ -0,0 +1 @@
+= Deleting applications and components
diff --git a/docs/modules/ROOT/pages/how-tos/index.adoc b/docs/modules/ROOT/pages/how-tos/index.adoc
@@ -0,0 +1 @@
+= How to build artifacts in {ProductName}
diff --git a/docs/modules/ROOT/pages/how-tos/metadata/index.adoc b/docs/modules/ROOT/pages/how-tos/metadata/index.adoc
@@ -0,0 +1 @@
+= Inspecting provenance and attestations
diff --git a/docs/modules/ROOT/pages/how-tos/metadata/provenance.adoc b/docs/modules/ROOT/pages/how-tos/metadata/provenance.adoc
@@ -0,0 +1,4 @@
+= Downloading the SLSA provenance
+
++
+NOTE:  We may want to make the action consistent with SBOMs.
diff --git a/docs/modules/ROOT/pages/how-tos/metadata/sboms.adoc b/docs/modules/ROOT/pages/how-tos/metadata/sboms.adoc
@@ -0,0 +1 @@
+= Inspecting SBOMs
diff --git a/docs/modules/ROOT/pages/how-tos/testing/build/index.adoc b/docs/modules/ROOT/pages/how-tos/testing/build/index.adoc
@@ -0,0 +1 @@
+= Build-time tests
diff --git a/docs/modules/ROOT/pages/how-tos/testing/build/snyk.adoc b/docs/modules/ROOT/pages/how-tos/testing/build/snyk.adoc
@@ -0,0 +1,6 @@
+= Enabling Snyk
+
+While a Snky test is available to run a build time in the default pipelines, additional configuration is needed to enable the test. This is an example of a build-time test that requires the configuration of a custom secret to be able to run.
+
++
+NOTE:  We may want to consider generalizing this topic.
diff --git a/docs/modules/ROOT/pages/how-tos/testing/index.adoc b/docs/modules/ROOT/pages/how-tos/testing/index.adoc
@@ -0,0 +1 @@
+= Testing your components and applications
diff --git a/docs/modules/ROOT/pages/how-tos/testing/integration/adding.adoc b/docs/modules/ROOT/pages/how-tos/testing/integration/adding.adoc
@@ -0,0 +1 @@
+= Adding an integration test
diff --git a/docs/modules/ROOT/pages/how-tos/testing/integration/creating.adoc b/docs/modules/ROOT/pages/how-tos/testing/integration/creating.adoc
@@ -0,0 +1 @@
+= Creating a custom integration test
diff --git a/docs/modules/ROOT/pages/how-tos/testing/integration/index.adoc b/docs/modules/ROOT/pages/how-tos/testing/integration/index.adoc
@@ -0,0 +1 @@
+= Integration tests
diff --git a/docs/modules/ROOT/pages/how-tos/testing/integration/rerunning.adoc b/docs/modules/ROOT/pages/how-tos/testing/integration/rerunning.adoc
@@ -0,0 +1 @@
+= Rerunning an integration test
diff --git a/docs/modules/ROOT/pages/how-tos/testing/overview.adoc b/docs/modules/ROOT/pages/how-tos/testing/overview.adoc
@@ -0,0 +1,4 @@
+= Overview of {ProductName} tests
+
++
+NOTE: This might just be merged into the section page for testing components and applications
diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc
@@ -1 +1 @@
-Hello World!
+= {ProductName}
