Merge pull request #419 from chronicleworks/fix/chroniclelinks

docs: added legacy links and reorganised installing section
chronicleworks · Nov 21, 2023 · c9a52fe · c9a52fe
2 parents 42dc02b + e52db61
commit c9a52fe
Show file tree

Hide file tree

Showing 8 changed files with 26 additions and 12 deletions.
diff --git a/docs/chronicle.md b/docs/chronicle.md
@@ -0,0 +1,3 @@
+# Chronicle Overview
+
+Click [here](./../) to access latest Chronicle documentation.
diff --git a/docs/cookbooks/chronicle/rancher.md b/docs/cookbooks/chronicle/rancher.md
@@ -0,0 +1,3 @@
+# Chronicle Rancher by SUSE Cookbook
+
+Click [here](./../../../rancher) to access the latest Chronicle cookbook.
diff --git a/docs/health-checks-and-testing.md b/docs/health-checks-and-testing.md
@@ -2,7 +2,7 @@
 
 ## Helm Testing
 
-See [Helm Testing](./helm_testing.md).
+See [Helm Testing](./helm-testing.md).
 
 ## Liveness Health Check
 

diff --git a/docs/helm-jwks-opa.md b/docs/helm-jwks-opa.md
@@ -111,7 +111,7 @@ URLs must be set for Chronicle to accept a user's authorization.
 
 **Note**: By default, if `auth.userinfo.url` is provided, `test.auth.token` is
 required. To learn more about testing with Helm and default settings, see
-this [Note on Default Settings](./helm_testing.md#note-on-default-settings).
+this [Note on Default Settings](./helm-testing.md#note-on-default-settings).
 
 ##### Claims fields
 
@@ -246,4 +246,4 @@ the `id-provider` container's logs where the `OidcController` notes its
 config on startup.
 
 For more on Chronicle Helm testing scenarios, see our documentation on
-[Helm Testing Scenarios](./helm_testing.md#testing-scenarios).
+[Helm Testing Scenarios](./helm-testing.md#testing-scenarios).
diff --git a/docs/helm-scenarios.md b/docs/helm-scenarios.md
@@ -44,7 +44,7 @@ anonymous requests, without an `Authorization:` header, also omit `required:`.
 
 **Note**: By default, if `auth.userinfo.url` is provided, `test.auth.token` is
 required. To learn more about testing with Helm and default settings, see
-this [Note on Default Settings](./helm_testing.md#note-on-default-settings).
+this [Note on Default Settings](./helm-testing.md#note-on-default-settings).
 
 ### OIDC but not OPA: allow everything, recording identity
 
@@ -140,4 +140,4 @@ opa:
 ```
 
 For more on Chronicle Helm testing scenarios, see our documentation on
-[Helm Testing Scenarios](./helm_testing.md#testing-scenarios).
+[Helm Testing Scenarios](./helm-testing.md#testing-scenarios).
diff --git a/docs/helm_testing.md → docs/helm-testing.md b/docs/helm_testing.md → docs/helm-testing.md
diff --git a/docs/index.md b/docs/index.md
@@ -1,4 +1,4 @@
-# Chronicle
+# Chronicle Overview
 
 Chronicle records provenance information of any physical or digital asset on a
 distributed ledger to ensure that it is tamper-proof; and is available with

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -42,16 +42,21 @@ nav:
       - Recording provenance: recording_provenance.md
       - Querying provenance: querying_provenance.md
       - Untyped Chronicle: untyped_chronicle.md
+      - Namespaces: namespaces.md
   - Testing:
       - Building your domain: building.md
       - Health Checks and Testing: health-checks-and-testing.md
-      - Helm Testing: helm_testing.md
+      - Helm Testing: helm-testing.md
   - Installing:
-      - Installing with SUSE Rancher: rancher.md
-      - Security settings via Helm: helm-jwks-opa.md
-      - Helm scenarios enumerated: helm-scenarios.md
-      - Other Helm Options: helm-options.md
-      - External PostgreSQL: external-postgres.md
+      - Rancher by SUSE Cookbook: rancher.md
+      - Configuring Helm:
+          - Security settings: helm-jwks-opa.md
+          - Security scenarios: helm-scenarios.md
+          - Misc Options: helm-options.md
+          - External PostgreSQL: external-postgres.md
+      - Configuring Sawtooth:
+          - Resetting Chronicle: resetting.md
+          - Connecting to Chronicle: connecting.md
   - Operating:
       - CLI: cli.md
       - Configuration options: config.md
@@ -60,3 +65,6 @@ nav:
       - Authorization checking: oidc-opa-flow.md
       - Importing data: importing.md
   - Upgrading: upgrading.md
+  - Legacy Links:
+      - Docs: chronicle.md
+      - Cookbook: cookbooks/chronicle/rancher.md