move backups to guides; refine more guides;

openziti · May 13, 2024 · 87f7ac6 · 87f7ac6
1 parent d40485d
commit 87f7ac6
Show file tree

Hide file tree

Showing 7 changed files with 14 additions and 22 deletions.
diff --git a/docusaurus/docs/guides/deployments/10-linux/10-controller/10-deploy.mdx b/docusaurus/docs/guides/deployments/10-linux/10-controller/10-deploy.mdx
@@ -52,7 +52,7 @@ You can generate a configuration by enabling bootstrapping during an interactive
 
 The controller service will generate a root CA and issue an intermediate CA cert during the first startup.
 
-The controller needs a CA to issue certificates for edge identities during enrollment. This CA is known as the edge signer. It's a good idea to secure the root in a different location and use an intermediate CA for this purpose. This allows you to recover in a scenario where the intermediate was lost without changing the root of trust and invalidating all edge enrollments. Refer to [the article about backing up the controller](/reference/backup/10-controller.mdx) for more information.
+The controller needs a CA to issue certificates for edge identities during enrollment. This CA is known as the edge signer. It's a good idea to secure the root in a different location and use an intermediate CA for this purpose. This allows you to recover in a scenario where the intermediate was lost without changing the root of trust and invalidating all edge enrollments. Refer to [the article about backing up the controller](/guides/deployments/10-linux/10-controller/60-backup.mdx) for more information.
 
 Disable bootstrapping a PKI by setting `ZITI_BOOTSTRAP_PKI=false` in `/opt/openziti/etc/controller/service.env`.
 

diff --git a/...s/docs/reference/backup/10-controller.mdx → ...ents/10-linux/10-controller/60-backup.mdx b/...s/docs/reference/backup/10-controller.mdx → ...ents/10-linux/10-controller/60-backup.mdx
@@ -1,6 +1,6 @@
 ---
-title: Controller Backup
-sidebar_label: Controller
+title: Controller Backup and Recovery
+sidebar_label: Backup
 ---
 
 ## Backup

diff --git a/...aurus/docs/reference/backup/20-router.mdx → ...loyments/10-linux/20-router/60-backup.mdx b/...aurus/docs/reference/backup/20-router.mdx → ...loyments/10-linux/20-router/60-backup.mdx
@@ -1,6 +1,6 @@
 ---
-title: Router Backup
-sidebar_label: Router
+title: Router Backup and Recovery
+sidebar_label: Backup
 ---
 
 

diff --git a/docusaurus/docs/guides/index.md b/docusaurus/docs/guides/index.md
@@ -5,13 +5,11 @@ sidebar_position: 10
 
 This section contains operational guidance for specific tasks such as deploying a controller with Helm or as a Linux system service, backing up the controller's database, and migrating controller or router configurations.
 
-## Add or Request New Guides
+## What is a Guide?
+
+A guide is like a recipe. It's a type of documentation that is more advanced and solution-focused than other types. A guide is prescriptive and procedural. For example, "How to deploy a controller with Helm."
 
 There's lots of room in here for new guides! Want guidance before you submit? Want someone else to submit? No problem. Follow the link to create a GitHub issue, label it "how-to", and tell us what you are working on. 
 
 * [Request a new guide or find guide requests](https://github.com/openziti/ziti-doc/issues?q=is%3Aissue+is%3Aopen+label%3Ahow-to+)
 * [Where in GitHub to add or edit a guide](https://github.com/openziti/ziti-doc/tree/main/docusaurus/docs/guides)
-
-## What is a Guide?
-
-A guide is like a recipe. It's a type of documentation that is more advanced and solution-focused than other types. A guide is prescriptive and procedural. For example, "How to deploy a controller with Helm."
diff --git a/docusaurus/docs/reference/backup/_category_.yml b/docusaurus/docs/reference/backup/_category_.yml
diff --git a/docusaurus/docs/reference/tunnelers/60-linux/50-linux-tunnel-troubleshooting.mdx b/docusaurus/docs/reference/tunnelers/60-linux/50-linux-tunnel-troubleshooting.mdx
@@ -15,12 +15,11 @@ The tunneler obeys the value of `logLevel` in `/var/lib/ziti/config.json`. The i
 
 Create a log file from the current systemd service invocation to share with collaborators.
 
-```bash
+```text
 ZITI_VERSION=$(ziti-edge-tunnel version);
-journalctl _SYSTEMD_INVOCATION_ID=$(
-  systemctl show -p InvocationID --value ziti-edge-tunnel-default.service) -l --no-pager \
-  | tee /tmp/ziti-edge-tunnel-single-${ZITI_VERSION#v}.log \
-  | gzip > /tmp/ziti-edge-tunnel-single-${ZITI_VERSION#v}.log.gz
+journalctl _SYSTEMD_INVOCATION_ID=$(systemctl show -p InvocationID --value ziti-edge-tunnel-default.service) -l --no-pager \
+| tee /tmp/ziti-edge-tunnel-single-${ZITI_VERSION#v}.log \
+| gzip > /tmp/ziti-edge-tunnel-single-${ZITI_VERSION#v}.log.gz
 ```
 
 ## Systemd service won't start or keeps restarting

diff --git a/docusaurus/docusaurus.config.js b/docusaurus/docusaurus.config.js
@@ -147,8 +147,8 @@ const config = {
             from: ['/docs/guides/Local_Gateway/EdgeRouter']
           },
           {
-            to: '/docs/reference/backup/controller',
-            from: ['/docs/guides/database-backup']
+            to: '/docs/guides/deployments/linux/controller/backup',
+            from: ['/docs/guides/database-backup', '/docs/reference/backup/controller']
           },
           {
             to: '/docs/reference/tunnelers/nginx',