🎨 Refactor: docs

Signed-off-by: bitliu <[email protected]>
Xunzhuo · Oct 9, 2023 · ee22388 · ee22388
1 parent 1e73685
commit ee22388
Show file tree

Hide file tree

Showing 365 changed files with 3,484 additions and 3,202 deletions.
diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
@@ -1,47 +1,67 @@
-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
     steps:
-      - name: Check out code
-        uses: actions/checkout@v4
+    - name: Check out code
+      uses: actions/checkout@v4
 
-      - name: Run markdown linter
-        uses: nosborn/[email protected]
-        with:
-          files: docs/*
-          config_file: ".github/markdown_lint_config.json"
+    - name: Run markdown linter
+      uses: nosborn/[email protected]
+      with:
+        files: site/content/*
+        config_file: ".github/markdown_lint_config.json"
 
   docs-build:
     runs-on: ubuntu-latest
     needs: docs-lint
+    permissions:
+      contents: write
     steps:
-      - uses: actions/checkout@v4
-      - uses: ./tools/github-actions/setup-deps
+    - name: Git checkout
+      uses: actions/checkout@v3
+      with:
+        submodules: true
+
+    - name: Setup Hugo
+      uses: peaceiris/actions-hugo@v2
+      with:
+        hugo-version: 'latest'
+        extended: true
+
+    - 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
-          # Duration after which artifact will expire in days.
-          # retention-days: # optional, default is 1
+    # Upload docs for GitHub Pages
+    - name: Upload GitHub Pages artifact
+      uses: actions/[email protected]
+      with:
+        # Path of the directory containing the static assets.
+        path: site/public
+        # Duration after which artifact will expire in days.
+        # retention-days: # optional, default is 1
 
   # This workflow contains a single job called "build"
   docs-publish:
@@ -61,6 +81,6 @@ jobs:
       url: ${{ steps.deployment.outputs.page_url }}
 
     steps:
-      - name: Deploy to GitHub Pages
-        id: deployment
-        uses: actions/[email protected]
+    - name: Deploy to GitHub Pages
+      id: deployment
+      uses: actions/[email protected]
diff --git a/GOALS.md b/GOALS.md
@@ -8,6 +8,7 @@ fundamental interactions.
 ## Objectives
 
 ### Expressive API
+
 The Envoy Gateway project will expose a simple and expressive API, with defaults set for many capabilities.
 
 The API will be the Kubernetes-native [Gateway API][], plus Envoy-specific extensions and extension points.  This
@@ -23,6 +24,7 @@ This expressive API will not be implemented by Envoy Proxy, but rather an offici
 on top.
 
 ### Batteries included
+
 Envoy Gateway will simplify how Envoy is deployed and managed, allowing application developers to focus on
 delivering core business value.
 
@@ -37,13 +39,15 @@ will enjoy a simplified management model that doesn't require extensive knowledg
 operate.
 
 ### All environments
+
 Envoy Gateway will support running natively in Kubernetes environments as well as non-Kubernetes deployments.
 
 Initially, Kubernetes will receive the most focus, with the aim of having Envoy Gateway become the de facto
 standard for Kubernetes ingress supporting the [Gateway API][].
 Additional goals include multi-cluster support and various runtime environments.
 
 ### Extensibility
+
 Vendors will have the ability to provide value-added products built on the Envoy Gateway foundation.
 
 It will remain easy for end-users to leverage common Envoy Proxy extension points such as providing an implementation
@@ -57,21 +61,26 @@ allowing vendors to shift to a higher management plane layer.
 ## Non-objectives
 
 ### Cannibalize vendor models
+
 Vendors need to have the ability to drive commercial value, so the goal is not to cannibalize any existing vendor
 monetization model, though some vendors may be affected by it.
 
 ### Disrupt current Envoy usage patterns
+
 Envoy Gateway is purely an additive convenience layer and is not meant to disrupt any usage pattern of any user
 with Envoy Proxy, xDS, or go-control-plane.
 
 ## Personas
+
 _In order of priority_
 
 ### 1. Application developer
+
 The application developer spends the majority of their time developing business logic code.  They require the ability to
 manage access to their application.
 
 ### 2. Infrastructure administrators
+
 The infrastructure administrators are responsible for the installation, maintenance, and operation of
 API gateways appliances in infrastructure, such as CRDs, roles, service accounts, certificates, etc.
 Infrastructure administrators support the needs of application developers by managing instances of Envoy Gateway.

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/CODE_OF_CONDUCT.md b/docs/latest/dev/CODE_OF_CONDUCT.md
diff --git a/docs/latest/dev/GOALS.md b/docs/latest/dev/GOALS.md
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/presentations.md b/docs/latest/presentations.md
diff --git a/docs/latest/releases.rst b/docs/latest/releases.rst