🎨 Refactor: docs

Signed-off-by: bitliu <[email protected]>
envoyproxy · Oct 8, 2023 · 95bb2e6 · 95bb2e6
1 parent 1e73685
commit 95bb2e6
Show file tree

Hide file tree

Showing 347 changed files with 2,140 additions and 2,458 deletions.
diff --git a/.github/workflows/docs.yaml → .github/workflows/hugo-docs.yaml b/.github/workflows/docs.yaml → .github/workflows/hugo-docs.yaml
@@ -1,45 +1,52 @@
-name: Docs
+name: Hugo Docs
 on:
   push:
     branches:
-      - "main"
+    - "main"
+    - "release/v*"
     paths-ignore:
-      - "**/*.png"
+    - "**/*.png"
   pull_request:
     branches:
-      - "main"
+    - "main"
+    - "release/v*"
     paths-ignore:
-      - "**/*.png"
+    - "**/*.png"
 
 jobs:
-  docs-lint:
-    runs-on: ubuntu-22.04
+  docs-build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
     steps:
-      - name: Check out code
-        uses: actions/checkout@v4
+      - name: Git checkout
+        uses: actions/checkout@v3
+        with:
+          submodules: true
 
-      - name: Run markdown linter
-        uses: nosborn/[email protected]
+      - name: Setup hugo
+        uses: peaceiris/actions-hugo@v2
         with:
-          files: docs/*
-          config_file: ".github/markdown_lint_config.json"
+          hugo-version: 'latest'
+          extended: true
 
-  docs-build:
-    runs-on: ubuntu-latest
-    needs: docs-lint
-    steps:
-      - uses: actions/checkout@v4
-      - uses: ./tools/github-actions/setup-deps
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+
+      - name: Install Site Dependencies
+        run: cd site && npm install
 
-      - name: Generate EG Pages
-        run: make docs
+      - name: Build Site
+        run: cd site && npm run build:production
 
       # Upload docs for GitHub Pages
       - name: Upload GitHub Pages artifact
         uses: actions/[email protected]
         with:
           # Path of the directory containing the static assets.
-          path: docs/html
+          path: site/public
           # Duration after which artifact will expire in days.
           # retention-days: # optional, default is 1
 

diff --git a/GOALS.md b/GOALS.md
@@ -1,4 +1,7 @@
-# Goals
+---
+title: "Goals"
+---
+
 
 The high-level goal of the Envoy Gateway project is to attract more users to Envoy by lowering barriers to adoption
 through expressive, extensible, role-oriented APIs that support a multitude of ingress and L7/L4 traffic routing

diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/latest/about_docs.rst b/docs/latest/about_docs.rst
diff --git a/docs/latest/api_docs.rst b/docs/latest/api_docs.rst
diff --git a/docs/latest/conf.py b/docs/latest/conf.py
diff --git a/docs/latest/design_docs.rst b/docs/latest/design_docs.rst
diff --git a/docs/latest/dev_docs.rst b/docs/latest/dev_docs.rst
diff --git a/docs/latest/get_involved.rst b/docs/latest/get_involved.rst
diff --git a/docs/latest/helm.rst b/docs/latest/helm.rst
diff --git a/docs/latest/index.rst b/docs/latest/index.rst
diff --git a/docs/latest/intro/compatibility.rst b/docs/latest/intro/compatibility.rst
diff --git a/docs/latest/releases.rst b/docs/latest/releases.rst
diff --git a/docs/latest/releases/README.md b/docs/latest/releases/README.md
diff --git a/docs/latest/releases/v0.2.md b/docs/latest/releases/v0.2.md