chore: fix text formatting for ssh page (#104)

* fix heading formatting for ssh ux * add node_modules caching in github workflow * Update build.yml * Update build.yml
zeropsio · Nov 28, 2024 · 25e6607 · 25e6607
1 parent 9d35523
commit 25e6607
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 13 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -27,16 +27,37 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-yarn-
 
-      - name: Node.js 18
+      - uses: actions/cache@v4
+        id: node-modules-cache
+        with:
+          path: node_modules
+          key: ${{ runner.os }}-node_modules-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-node_modules-
+
+      - uses: actions/cache@v4
+        id: build-cache
+        with:
+          path: apps/docs/build/~
+          key: ${{ runner.os }}-docs-build-${{ hashFiles('apps/docs/**/*') }}
+          restore-keys: |
+            ${{ runner.os }}-docs-build-
+
+      - uses: actions/cache@v4
+        id: turbo-cache
+        with:
+          path: .turbo
+          key: ${{ runner.os }}-turbo-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-turbo-
+
+      - name: Node.js 20
         uses: actions/setup-node@v3
         with:
-          node-version: '18'
+          node-version: '20'
 
       - name: Install Dependencies
         run: yarn install --frozen-lockfile
 
       - name: Run Build
         run: yarn build
-
-      # - name: Run Lint
-      #   run: yarn lint
diff --git a/apps/docs/content/references/ssh.mdx b/apps/docs/content/references/ssh.mdx
@@ -8,20 +8,20 @@ SSH access is available only for runtime services and web servers.
 Database services, message brokers, and object storage are not accessible via SSH.
 :::
 
-# Prerequisites
+## Prerequisites
 
 Before establishing an SSH connection to your runtime service, you must first connect to the [Zerops VPN](/references/vpn).
 
-# Setting Up Your Connection
+## Setting Up Your Connection
 
-## 1. Configure VPN Access
+### 1. Configure VPN Access
 
 The [Zerops CLI (zCLI)](/references/cli) comes bundled with the [Zerops VPN](/references/vpn) client. To connect to your [Zerops project](/features/infrastructure#project):
 
 1. [Install and configure zCLI](/references/cli)
 2. [Initialize the Zerops VPN connection](/references/vpn#start-the-vpn)
 
-## 2. Establish SSH Connection
+### 2. Establish SSH Connection
 
 Once your VPN session is active, you can connect to any [service](/features/infrastructure#services--containers) using its hostname:
 
@@ -45,7 +45,7 @@ Are you sure you want to continue connecting (yes/no/[fingerprint])?
 
 Type `yes` to trust the host and prevent future prompts.
 
-# Advanced Connection Options
+## Advanced Connection Options
 
 <p align="center">
  <img src="/img/screenshots/ssh.png" alt="image" width="100%" height="auto" style={{ borderRadius: 0.5 + 'rem' }} />
@@ -68,7 +68,7 @@ ssh node-id-1.runtime.app.zerops
 When using [HA mode](/features/scaling-ha), connecting to the service hostname will route you to a random container within that service.
 :::
 
-# Container Naming Conventions
+## Container Naming Conventions
 
 Each container in your project has a unique hostname following these patterns:
 
@@ -85,9 +85,9 @@ When your application [scales horizontally](https://docs.zerops.io/features/scal
 Never connect to containers using their local IP addresses, as these addresses are dynamic and may change.
 :::
 
-# Important Considerations
+## Important Considerations
 
-## Non-Persistent Changes
+### Non-Persistent Changes
 
 SSH connections should not be used for making persistent changes to your service: