From 0e65858a7b0262e16896aa54e3c5765813479b5a Mon Sep 17 00:00:00 2001 From: arewm Date: Fri, 26 Apr 2024 10:01:27 -0400 Subject: [PATCH 1/3] Initial doc layout with left navigation and page stubs Resolves: konflux-ci/docs#1 Signed-off-by: arewm --- .gitignore | 1 + docs/antora.yml | 7 +++++- docs/modules/ROOT/nav-root.adoc | 1 - .../ROOT/pages/advanced-how-tos/_nav.adoc | 8 +++++++ .../ROOT/pages/advanced-how-tos/index.adoc | 1 + .../pages/advanced-how-tos/installing.adoc | 1 + .../managing-compliance-with-ec.adoc | 1 + .../managing-multiple-versions.adoc | 1 + .../managing-security-fix.adoc | 1 + .../create-release-plan-admission.adoc | 1 + .../releasing/create-release-plan.adoc | 1 + .../advanced-how-tos/releasing/index.adoc | 1 + docs/modules/ROOT/pages/contribute/_nav.adoc | 1 + docs/modules/ROOT/pages/contribute/index.adoc | 1 + docs/modules/ROOT/pages/discover/_nav.adoc | 3 +++ docs/modules/ROOT/pages/discover/index.adoc | 1 + .../ROOT/pages/discover/slsa-conformity.adoc | 1 + .../ROOT/pages/getting-started/_nav.adoc | 3 +++ .../ROOT/pages/getting-started/cli.adoc | 1 + .../ROOT/pages/getting-started/index.adoc | 1 + docs/modules/ROOT/pages/glossary/_nav.adoc | 1 + docs/modules/ROOT/pages/glossary/index.adoc | 1 + docs/modules/ROOT/pages/how-tos/_nav.adoc | 22 +++++++++++++++++++ .../how-tos/configuring/component-nudges.adoc | 1 + .../configuring/configuration-as-code.adoc | 4 ++++ .../how-tos/configuring/creating-secrets.adoc | 1 + .../configuring/customizing-the-build.adoc | 1 + .../how-tos/configuring/hermetic-builds.adoc | 1 + .../ROOT/pages/how-tos/configuring/index.adoc | 1 + .../configuring/prefetching-dependencies.adoc | 7 ++++++ .../configuring/redundant-rebuilds.adoc | 4 ++++ docs/modules/ROOT/pages/how-tos/creating.adoc | 1 + docs/modules/ROOT/pages/how-tos/deleting.adoc | 1 + docs/modules/ROOT/pages/how-tos/index.adoc | 1 + .../ROOT/pages/how-tos/metadata/index.adoc | 1 + .../pages/how-tos/metadata/provenance.adoc | 4 ++++ .../ROOT/pages/how-tos/metadata/sboms.adoc | 1 + .../pages/how-tos/testing/build/index.adoc | 1 + .../pages/how-tos/testing/build/snyk.adoc | 6 +++++ .../ROOT/pages/how-tos/testing/index.adoc | 1 + .../how-tos/testing/integration/adding.adoc | 1 + .../how-tos/testing/integration/creating.adoc | 1 + .../how-tos/testing/integration/index.adoc | 1 + .../testing/integration/rerunning.adoc | 1 + .../ROOT/pages/how-tos/testing/overview.adoc | 4 ++++ docs/modules/ROOT/pages/index.adoc | 2 +- 46 files changed, 105 insertions(+), 3 deletions(-) delete mode 100644 docs/modules/ROOT/nav-root.adoc create mode 100644 docs/modules/ROOT/pages/advanced-how-tos/_nav.adoc create mode 100644 docs/modules/ROOT/pages/advanced-how-tos/index.adoc create mode 100644 docs/modules/ROOT/pages/advanced-how-tos/installing.adoc create mode 100644 docs/modules/ROOT/pages/advanced-how-tos/managing-compliance-with-ec.adoc create mode 100644 docs/modules/ROOT/pages/advanced-how-tos/managing-multiple-versions.adoc create mode 100644 docs/modules/ROOT/pages/advanced-how-tos/managing-security-fix.adoc create mode 100644 docs/modules/ROOT/pages/advanced-how-tos/releasing/create-release-plan-admission.adoc create mode 100644 docs/modules/ROOT/pages/advanced-how-tos/releasing/create-release-plan.adoc create mode 100644 docs/modules/ROOT/pages/advanced-how-tos/releasing/index.adoc create mode 100644 docs/modules/ROOT/pages/contribute/_nav.adoc create mode 100644 docs/modules/ROOT/pages/contribute/index.adoc create mode 100644 docs/modules/ROOT/pages/discover/_nav.adoc create mode 100644 docs/modules/ROOT/pages/discover/index.adoc create mode 100644 docs/modules/ROOT/pages/discover/slsa-conformity.adoc create mode 100644 docs/modules/ROOT/pages/getting-started/_nav.adoc create mode 100644 docs/modules/ROOT/pages/getting-started/cli.adoc create mode 100644 docs/modules/ROOT/pages/getting-started/index.adoc create mode 100644 docs/modules/ROOT/pages/glossary/_nav.adoc create mode 100644 docs/modules/ROOT/pages/glossary/index.adoc create mode 100644 docs/modules/ROOT/pages/how-tos/_nav.adoc create mode 100644 docs/modules/ROOT/pages/how-tos/configuring/component-nudges.adoc create mode 100644 docs/modules/ROOT/pages/how-tos/configuring/configuration-as-code.adoc create mode 100644 docs/modules/ROOT/pages/how-tos/configuring/creating-secrets.adoc create mode 100644 docs/modules/ROOT/pages/how-tos/configuring/customizing-the-build.adoc create mode 100644 docs/modules/ROOT/pages/how-tos/configuring/hermetic-builds.adoc create mode 100644 docs/modules/ROOT/pages/how-tos/configuring/index.adoc create mode 100644 docs/modules/ROOT/pages/how-tos/configuring/prefetching-dependencies.adoc create mode 100644 docs/modules/ROOT/pages/how-tos/configuring/redundant-rebuilds.adoc create mode 100644 docs/modules/ROOT/pages/how-tos/creating.adoc create mode 100644 docs/modules/ROOT/pages/how-tos/deleting.adoc create mode 100644 docs/modules/ROOT/pages/how-tos/index.adoc create mode 100644 docs/modules/ROOT/pages/how-tos/metadata/index.adoc create mode 100644 docs/modules/ROOT/pages/how-tos/metadata/provenance.adoc create mode 100644 docs/modules/ROOT/pages/how-tos/metadata/sboms.adoc create mode 100644 docs/modules/ROOT/pages/how-tos/testing/build/index.adoc create mode 100644 docs/modules/ROOT/pages/how-tos/testing/build/snyk.adoc create mode 100644 docs/modules/ROOT/pages/how-tos/testing/index.adoc create mode 100644 docs/modules/ROOT/pages/how-tos/testing/integration/adding.adoc create mode 100644 docs/modules/ROOT/pages/how-tos/testing/integration/creating.adoc create mode 100644 docs/modules/ROOT/pages/how-tos/testing/integration/index.adoc create mode 100644 docs/modules/ROOT/pages/how-tos/testing/integration/rerunning.adoc create mode 100644 docs/modules/ROOT/pages/how-tos/testing/overview.adoc diff --git a/.gitignore b/.gitignore index 07d7e51c..01813a21 100644 --- 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 index 7f297e81..71c847c0 100644 --- a/docs/antora.yml +++ b/docs/antora.yml @@ -2,7 +2,12 @@ name: ROOT 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 deleted file mode 100644 index 9f5a19ea..00000000 --- a/docs/modules/ROOT/nav-root.adoc +++ /dev/null @@ -1 +0,0 @@ -* Root navigation \ No newline at end of file diff --git a/docs/modules/ROOT/pages/advanced-how-tos/_nav.adoc b/docs/modules/ROOT/pages/advanced-how-tos/_nav.adoc new file mode 100644 index 00000000..2edec4f8 --- /dev/null +++ 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] +** xref:advanced-how-tos/managing-security-fix.adoc[Managing a security fix] +** xref:advanced-how-tos/managing-multiple-versions.adoc[Managing multiple software versions] +** 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] \ No newline at end of file diff --git a/docs/modules/ROOT/pages/advanced-how-tos/index.adoc b/docs/modules/ROOT/pages/advanced-how-tos/index.adoc new file mode 100644 index 00000000..f8db2e49 --- /dev/null +++ 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 new file mode 100644 index 00000000..8cbd55da --- /dev/null +++ b/docs/modules/ROOT/pages/advanced-how-tos/installing.adoc @@ -0,0 +1 @@ += Installing {ProductName} \ No newline at end of file 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 new file mode 100644 index 00000000..a5dc4eed --- /dev/null +++ b/docs/modules/ROOT/pages/advanced-how-tos/managing-compliance-with-ec.adoc @@ -0,0 +1 @@ += Managing compliance with Enterprise Contract \ No newline at end of file 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 new file mode 100644 index 00000000..00ed95ce --- /dev/null +++ b/docs/modules/ROOT/pages/advanced-how-tos/managing-multiple-versions.adoc @@ -0,0 +1 @@ += Managing multiple software versions \ No newline at end of file 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 new file mode 100644 index 00000000..26f12e8f --- /dev/null +++ b/docs/modules/ROOT/pages/advanced-how-tos/managing-security-fix.adoc @@ -0,0 +1 @@ += Managing a security fix \ No newline at end of file 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 new file mode 100644 index 00000000..21bbbcc8 --- /dev/null +++ b/docs/modules/ROOT/pages/advanced-how-tos/releasing/create-release-plan-admission.adoc @@ -0,0 +1 @@ += Creating a release plan admission \ No newline at end of file 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 new file mode 100644 index 00000000..ef095ea1 --- /dev/null +++ b/docs/modules/ROOT/pages/advanced-how-tos/releasing/create-release-plan.adoc @@ -0,0 +1 @@ += Creating a release plan \ No newline at end of file diff --git a/docs/modules/ROOT/pages/advanced-how-tos/releasing/index.adoc b/docs/modules/ROOT/pages/advanced-how-tos/releasing/index.adoc new file mode 100644 index 00000000..15f2e320 --- /dev/null +++ b/docs/modules/ROOT/pages/advanced-how-tos/releasing/index.adoc @@ -0,0 +1 @@ += Releasing an application \ No newline at end of file diff --git a/docs/modules/ROOT/pages/contribute/_nav.adoc b/docs/modules/ROOT/pages/contribute/_nav.adoc new file mode 100644 index 00000000..48291913 --- /dev/null +++ b/docs/modules/ROOT/pages/contribute/_nav.adoc @@ -0,0 +1 @@ +* xref:contribute/index.adoc[Contribute] \ No newline at end of file diff --git a/docs/modules/ROOT/pages/contribute/index.adoc b/docs/modules/ROOT/pages/contribute/index.adoc new file mode 100644 index 00000000..53e1ec4f --- /dev/null +++ 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 new file mode 100644 index 00000000..2375c7c0 --- /dev/null +++ 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] \ No newline at end of file diff --git a/docs/modules/ROOT/pages/discover/index.adoc b/docs/modules/ROOT/pages/discover/index.adoc new file mode 100644 index 00000000..04346a60 --- /dev/null +++ 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 new file mode 100644 index 00000000..9d99421a --- /dev/null +++ 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 new file mode 100644 index 00000000..3eb50f15 --- /dev/null +++ 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] \ No newline at end of file diff --git a/docs/modules/ROOT/pages/getting-started/cli.adoc b/docs/modules/ROOT/pages/getting-started/cli.adoc new file mode 100644 index 00000000..2d00617e --- /dev/null +++ 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 new file mode 100644 index 00000000..7a5d4282 --- /dev/null +++ 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 new file mode 100644 index 00000000..dd127649 --- /dev/null +++ b/docs/modules/ROOT/pages/glossary/_nav.adoc @@ -0,0 +1 @@ +* xref:glossary/index.adoc[Glossary] \ No newline at end of file diff --git a/docs/modules/ROOT/pages/glossary/index.adoc b/docs/modules/ROOT/pages/glossary/index.adoc new file mode 100644 index 00000000..7e114291 --- /dev/null +++ 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 new file mode 100644 index 00000000..a75e462a --- /dev/null +++ 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 your supply chain metadata] +*** 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] \ No newline at end of file diff --git a/docs/modules/ROOT/pages/how-tos/configuring/component-nudges.adoc b/docs/modules/ROOT/pages/how-tos/configuring/component-nudges.adoc new file mode 100644 index 00000000..37a7455f --- /dev/null +++ b/docs/modules/ROOT/pages/how-tos/configuring/component-nudges.adoc @@ -0,0 +1 @@ += Defining component relationships \ No newline at end of file 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 new file mode 100644 index 00000000..7e270487 --- /dev/null +++ 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? \ No newline at end of file diff --git a/docs/modules/ROOT/pages/how-tos/configuring/creating-secrets.adoc b/docs/modules/ROOT/pages/how-tos/configuring/creating-secrets.adoc new file mode 100644 index 00000000..594f83dc --- /dev/null +++ b/docs/modules/ROOT/pages/how-tos/configuring/creating-secrets.adoc @@ -0,0 +1 @@ += Creating secrets for your builds \ No newline at end of file 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 new file mode 100644 index 00000000..a20ba42d --- /dev/null +++ b/docs/modules/ROOT/pages/how-tos/configuring/customizing-the-build.adoc @@ -0,0 +1 @@ += Customizing the build pipeline \ No newline at end of file diff --git a/docs/modules/ROOT/pages/how-tos/configuring/hermetic-builds.adoc b/docs/modules/ROOT/pages/how-tos/configuring/hermetic-builds.adoc new file mode 100644 index 00000000..ece1160a --- /dev/null +++ b/docs/modules/ROOT/pages/how-tos/configuring/hermetic-builds.adoc @@ -0,0 +1 @@ += Enabling hermetic builds \ No newline at end of file diff --git a/docs/modules/ROOT/pages/how-tos/configuring/index.adoc b/docs/modules/ROOT/pages/how-tos/configuring/index.adoc new file mode 100644 index 00000000..cd3b3464 --- /dev/null +++ b/docs/modules/ROOT/pages/how-tos/configuring/index.adoc @@ -0,0 +1 @@ += Configuring your builds \ No newline at end of file diff --git a/docs/modules/ROOT/pages/how-tos/configuring/prefetching-dependencies.adoc b/docs/modules/ROOT/pages/how-tos/configuring/prefetching-dependencies.adoc new file mode 100644 index 00000000..e8dda6f9 --- /dev/null +++ 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? \ No newline at end of file diff --git a/docs/modules/ROOT/pages/how-tos/configuring/redundant-rebuilds.adoc b/docs/modules/ROOT/pages/how-tos/configuring/redundant-rebuilds.adoc new file mode 100644 index 00000000..a01bbcb9 --- /dev/null +++ b/docs/modules/ROOT/pages/how-tos/configuring/redundant-rebuilds.adoc @@ -0,0 +1,4 @@ += Preventing redundant rebuilds + ++ +NOTE: Is this builds or rebuilds? \ No newline at end of file diff --git a/docs/modules/ROOT/pages/how-tos/creating.adoc b/docs/modules/ROOT/pages/how-tos/creating.adoc new file mode 100644 index 00000000..e256595a --- /dev/null +++ b/docs/modules/ROOT/pages/how-tos/creating.adoc @@ -0,0 +1 @@ += Creating applications and components \ No newline at end of file diff --git a/docs/modules/ROOT/pages/how-tos/deleting.adoc b/docs/modules/ROOT/pages/how-tos/deleting.adoc new file mode 100644 index 00000000..2e599f13 --- /dev/null +++ b/docs/modules/ROOT/pages/how-tos/deleting.adoc @@ -0,0 +1 @@ += Deleting applications and components \ No newline at end of file diff --git a/docs/modules/ROOT/pages/how-tos/index.adoc b/docs/modules/ROOT/pages/how-tos/index.adoc new file mode 100644 index 00000000..ec146bcd --- /dev/null +++ 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 new file mode 100644 index 00000000..ff141dbe --- /dev/null +++ b/docs/modules/ROOT/pages/how-tos/metadata/index.adoc @@ -0,0 +1 @@ += Inspecting your supply chain metadata \ No newline at end of file diff --git a/docs/modules/ROOT/pages/how-tos/metadata/provenance.adoc b/docs/modules/ROOT/pages/how-tos/metadata/provenance.adoc new file mode 100644 index 00000000..e7fe60a1 --- /dev/null +++ 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. \ No newline at end of file diff --git a/docs/modules/ROOT/pages/how-tos/metadata/sboms.adoc b/docs/modules/ROOT/pages/how-tos/metadata/sboms.adoc new file mode 100644 index 00000000..f26ddf32 --- /dev/null +++ b/docs/modules/ROOT/pages/how-tos/metadata/sboms.adoc @@ -0,0 +1 @@ += Inspecting SBOMs \ No newline at end of file diff --git a/docs/modules/ROOT/pages/how-tos/testing/build/index.adoc b/docs/modules/ROOT/pages/how-tos/testing/build/index.adoc new file mode 100644 index 00000000..50ca6cfc --- /dev/null +++ b/docs/modules/ROOT/pages/how-tos/testing/build/index.adoc @@ -0,0 +1 @@ += Build-time tests \ No newline at end of file diff --git a/docs/modules/ROOT/pages/how-tos/testing/build/snyk.adoc b/docs/modules/ROOT/pages/how-tos/testing/build/snyk.adoc new file mode 100644 index 00000000..f070dbac --- /dev/null +++ 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. \ No newline at end of file diff --git a/docs/modules/ROOT/pages/how-tos/testing/index.adoc b/docs/modules/ROOT/pages/how-tos/testing/index.adoc new file mode 100644 index 00000000..b7ef8aed --- /dev/null +++ b/docs/modules/ROOT/pages/how-tos/testing/index.adoc @@ -0,0 +1 @@ += Testing your components and applications \ No newline at end of file diff --git a/docs/modules/ROOT/pages/how-tos/testing/integration/adding.adoc b/docs/modules/ROOT/pages/how-tos/testing/integration/adding.adoc new file mode 100644 index 00000000..ff9fc0bc --- /dev/null +++ b/docs/modules/ROOT/pages/how-tos/testing/integration/adding.adoc @@ -0,0 +1 @@ += Adding an integration test \ No newline at end of file diff --git a/docs/modules/ROOT/pages/how-tos/testing/integration/creating.adoc b/docs/modules/ROOT/pages/how-tos/testing/integration/creating.adoc new file mode 100644 index 00000000..54b84f06 --- /dev/null +++ b/docs/modules/ROOT/pages/how-tos/testing/integration/creating.adoc @@ -0,0 +1 @@ += Creating a custom integration test \ No newline at end of file diff --git a/docs/modules/ROOT/pages/how-tos/testing/integration/index.adoc b/docs/modules/ROOT/pages/how-tos/testing/integration/index.adoc new file mode 100644 index 00000000..c1a18026 --- /dev/null +++ b/docs/modules/ROOT/pages/how-tos/testing/integration/index.adoc @@ -0,0 +1 @@ += Integration tests \ No newline at end of file diff --git a/docs/modules/ROOT/pages/how-tos/testing/integration/rerunning.adoc b/docs/modules/ROOT/pages/how-tos/testing/integration/rerunning.adoc new file mode 100644 index 00000000..d27f4b7e --- /dev/null +++ b/docs/modules/ROOT/pages/how-tos/testing/integration/rerunning.adoc @@ -0,0 +1 @@ += Rerunning an integration test \ No newline at end of file diff --git a/docs/modules/ROOT/pages/how-tos/testing/overview.adoc b/docs/modules/ROOT/pages/how-tos/testing/overview.adoc new file mode 100644 index 00000000..14f67113 --- /dev/null +++ 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 \ No newline at end of file diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc index c57eff55..c695e4bc 100644 --- a/docs/modules/ROOT/pages/index.adoc +++ b/docs/modules/ROOT/pages/index.adoc @@ -1 +1 @@ -Hello World! \ No newline at end of file += {ProductName} \ No newline at end of file From f1fa5c0b6cc5c9c84010e4183c8c046a7119b1f3 Mon Sep 17 00:00:00 2001 From: arewm Date: Fri, 26 Apr 2024 10:26:50 -0400 Subject: [PATCH 2/3] Set the title This replaces the ROOT text in the navbar for example. Signed-off-by: arewm --- docs/antora.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/antora.yml b/docs/antora.yml index 71c847c0..70b53ace 100644 --- a/docs/antora.yml +++ b/docs/antora.yml @@ -1,5 +1,6 @@ --- name: ROOT +title: Konflux-CI version: ~ nav: - modules/ROOT/pages/discover/_nav.adoc From 96abcdd2d13b91cce18486521f83476d590fec46 Mon Sep 17 00:00:00 2001 From: arewm Date: Fri, 26 Apr 2024 13:24:02 -0400 Subject: [PATCH 3/3] address review comments Signed-off-by: arewm --- docs/modules/ROOT/pages/advanced-how-tos/_nav.adoc | 8 ++++---- docs/modules/ROOT/pages/how-tos/_nav.adoc | 2 +- docs/modules/ROOT/pages/how-tos/metadata/index.adoc | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/modules/ROOT/pages/advanced-how-tos/_nav.adoc b/docs/modules/ROOT/pages/advanced-how-tos/_nav.adoc index 2edec4f8..bef86978 100644 --- a/docs/modules/ROOT/pages/advanced-how-tos/_nav.adoc +++ b/docs/modules/ROOT/pages/advanced-how-tos/_nav.adoc @@ -1,8 +1,8 @@ * xref:advanced-how-tos/index.adoc[Advanced how-tos] -** xref:advanced-how-tos/installing.adoc[Installing] -** xref:advanced-how-tos/managing-security-fix.adoc[Managing a security fix] -** xref:advanced-how-tos/managing-multiple-versions.adoc[Managing multiple software versions] +** 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] \ No newline at end of file +*** 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] \ No newline at end of file diff --git a/docs/modules/ROOT/pages/how-tos/_nav.adoc b/docs/modules/ROOT/pages/how-tos/_nav.adoc index a75e462a..8d34179c 100644 --- a/docs/modules/ROOT/pages/how-tos/_nav.adoc +++ b/docs/modules/ROOT/pages/how-tos/_nav.adoc @@ -16,7 +16,7 @@ **** 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 your supply chain metadata] +** 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] \ No newline at end of file diff --git a/docs/modules/ROOT/pages/how-tos/metadata/index.adoc b/docs/modules/ROOT/pages/how-tos/metadata/index.adoc index ff141dbe..2135310e 100644 --- a/docs/modules/ROOT/pages/how-tos/metadata/index.adoc +++ b/docs/modules/ROOT/pages/how-tos/metadata/index.adoc @@ -1 +1 @@ -= Inspecting your supply chain metadata \ No newline at end of file += Inspecting provenance and attestations \ No newline at end of file