fix(docs): fix left navbar menu items

runatlantis · May 14, 2024 · 9d2d08a · 9d2d08a
1 parent dcaf541
commit 9d2d08a
Show file tree

Hide file tree

Showing 5 changed files with 89 additions and 45 deletions.
diff --git a/runatlantis.io/.vitepress/sidebars.ts b/runatlantis.io/.vitepress/sidebars.ts
@@ -31,58 +31,51 @@ const en = [
         collapsed: true,
         items: [
           { text: "Overview", link: "/docs/configuring-atlantis" },
-          "/docs/configuring-atlantis",
-          "/docs/server-configuration",
-          "/docs/server-side-repo-config",
-          "/docs/pre-workflow-hooks",
-          "/docs/post-workflow-hooks",
-          "/docs/policy-checking",
-          "/docs/custom-workflows",
-          "/docs/repo-level-atlantis-yaml",
-          "/docs/upgrading-atlantis-yaml",
-          "/docs/command-requirements",
-          "/docs/checkout-strategy",
-          "/docs/terraform-versions",
-          "/docs/terraform-cloud",
-          "/docs/using-slack-hooks",
-          "/docs/stats",
-          "/docs/faq",
+          { text: "Server Configuration", link: "/docs/server-configuration" },
+          { text: "Server Side Repo Config", link: "/docs/server-side-repo-config" },
+          { text: "Pre Workflow Hooks", link: "/docs/pre-workflow-hooks" },
+          { text: "Post Workflow Hooks", link: "/docs/post-workflow-hooks" },
+          { text: "Conftest Policy Checking", link: "/docs/policy-checking" },
+          { text: "Custom Workflows", link: "/docs/custom-workflows" },
+          { text: "Repo Level atlantis.yaml", link: "/docs/repo-level-atlantis-yaml" },
+          { text: "Upgrading atlantis.yaml", link: "/docs/upgrading-atlantis-yaml" },
+          { text: "Command Requirements", link: "/docs/command-requirements" },
+          { text: "Checkout Strategy", link: "/docs/checkout-strategy" },
+          { text: "Terraform Versions", link: "/docs/terraform-versions" },
+          { text: "Terraform Cloud", link: "/docs/terraform-cloud" },
+          { text: "Using Slack Hooks", link: "/docs/using-slack-hooks" },
+          { text: "Stats", link: "/docs/stats" },
+          { text: "FAQ", link: "/docs/faq" },
         ]
       },
       {
         text: "Using Atlantis",
         collapsed: true,
         items: [
           { text: "Overview", link: "/docs/using-atlantis" },
-          "/docs/api-endpoints",
+          { text: "API endpoints", link: "/docs/api-endpoints" },
         ]
       },
       {
         text: 'How Atlantis Works',
         collapsed: true,
         items: [
-          {
-              text: 'Overview',
-              link: '/docs/how-atlantis-works',
-          },
-          '/docs/locking',
-          '/docs/autoplanning',
-          '/docs/automerging',
-          '/docs/security',
+          { text: 'Overview', link: '/docs/how-atlantis-works', },
+          { text: 'Locking', link: '/docs/locking', },
+          { text: 'Autoplanning', link: '/docs/autoplanning', },
+          { text: 'Automerging', link: '/docs/automerging', },
+          { text: 'Security', link: '/docs/security', },
         ]
       },
       {
         text: 'Real-time Terraform Logs',
-        collapsed: true,
-        items: [
-          '/docs/streaming-logs',
-        ]
+        link: '/docs/streaming-logs',
       },
       {
         text: 'Troubleshooting',
         collapsed: true,
         items: [
-          '/docs/troubleshooting',
+          { text: 'HTTPS, SSL, TLS', 'link': '/docs/troubleshooting-https', },
         ]
       },
     ],
@@ -95,13 +88,13 @@ const en = [
       {
         text: 'Implementation Details',
         items: [
-            {text: "Events Controller", link: "/contributing/events-controller"},
+          { text: "Events Controller", link: "/contributing/events-controller" },
         ]
       },
-      {text: "Glossry", link: "/contributing/glossary"},
+      { text: "Glossry", link: "/contributing/glossary" },
     ]
 
   }
-];
+]
 
-export { en };
+export { en }
diff --git a/runatlantis.io/docs.md b/runatlantis.io/docs.md
@@ -8,6 +8,7 @@ where you can try our [Test Drive](./guide/test-drive.md) or [Run Atlantis Local
 :::
 
 ### Next Steps
+
 * [Installing Atlantis](./docs/installation-guide.md)&nbsp;&nbsp;–&nbsp;&nbsp;Get Atlantis up and running
 * [Configuring Atlantis](./docs/configuring-atlantis.md)&nbsp;&nbsp;–&nbsp;&nbsp;Configure how Atlantis works for your specific use-cases
 * [Using Atlantis](./docs/using-atlantis.md)&nbsp;&nbsp;–&nbsp;&nbsp;How do you use Atlantis?

diff --git a/runatlantis.io/docs/pre-workflow-hooks.md b/runatlantis.io/docs/pre-workflow-hooks.md
@@ -21,7 +21,7 @@ By default, `pre-workflow-hooks` do not prevent Atlantis from executing its
 workflows(`plan`, `apply`) even if a `run` command exits with an error. This
 behavior can be changed by setting the [fail-on-pre-workflow-hook-error](server-configuration.md#fail-on-pre-workflow-hook-error)
 flag in the Atlantis server configuration.
-::: 
+:::
 
 ## Atlantis Command Targetting
 
@@ -98,6 +98,7 @@ command](custom-workflows.md#custom-run-command).
 | shellArgs   | string | '-c'    | no       | The shell arguments to use for running the command |
 
 ::: tip Notes
+
 * `run` commands are executed with the following environment variables:
   * `BASE_REPO_NAME` - Name of the repository that the pull request will be merged into, ex. `atlantis`.
   * `BASE_REPO_OWNER` - Owner of the repository that the pull request will be merged into, ex. `runatlantis`.
@@ -109,7 +110,7 @@ command](custom-workflows.md#custom-run-command).
   * `PULL_NUM` - Pull request number or ID, ex. `2`.
   * `PULL_URL` - Pull request URL, ex. `https://github.com/runatlantis/atlantis/pull/2`.
   * `PULL_AUTHOR` - Username of the pull request author, ex. `acme-user`.
-  * `DIR` - The absolute path to the root of the cloned repository. 
+  * `DIR` - The absolute path to the root of the cloned repository.
   * `USER_NAME` - Username of the VCS user running command, ex. `acme-user`. During an autoplan, the user will be the Atlantis API user, ex. `atlantis`.
   * `COMMENT_ARGS` - Any additional flags passed in the comment on the pull request. Flags are separated by commas and
       every character is escaped, ex. `atlantis plan -- arg1 arg2` will result in `COMMENT_ARGS=\a\r\g\1,\a\r\g\2`.