Add docs website publishing (#39)

* Update pipeline

* Add base to vitepress config

* Update README

Author: devpro

.github/workflows/ci.yml

@@ -1,10 +1,7 @@
-# ---------------------------------------------------------
-# Title: Continuous Integration
-#
-# Uses:
+# title: Continuous Integration
+# uses:
 #   - https://github.com/helm/chart-testing-action
 #   - https://github.com/helm/kind-action
-# ---------------------------------------------------------
 
 name: CI
 

.github/workflows/pkg.yml

@@ -1,14 +1,11 @@
-# ---------------------------------------------------------------------------------------
-# Title: Continuous Delivery (Packaging)
-#
-# Requirements:
+# title: Continuous Delivery (Packaging)
+# requirements:
 #   - Create manually "gh-pages" branch
 #   - Maintain pages files in "gh-pages" branch: index.tpl, placeholder.png
-#
-# Uses:
+# uses:
 #   - https://github.com/helm/chart-releaser-action
 #   - https://github.com/halkeye/helm-repo-html
-# ---------------------------------------------------------------------------------------
+#   - https://github.com/actions/configure-pages
 
 name: PKG
 
@@ -23,6 +20,10 @@ permissions:
   pages: write
   id-token: write
 
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
 jobs:
   build:
     runs-on: ubuntu-latest
@@ -38,9 +39,14 @@ jobs:
           cache: npm
       - name: Install Node.js dependencies
         run: npm install
+      # ref. https://vitepress.dev/guide/deploy#github-pages
       - name: Build with VitePress
         run: npm run docs:build
-      # https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address
+      - uses: actions/upload-artifact@v4
+        with:
+          name: docs
+          path: docs/.vitepress/dist/
+      # ref. https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address
       - name: Configure Git
         run: |
           git config user.name "$GITHUB_ACTOR"
@@ -61,6 +67,14 @@ jobs:
         uses: actions/checkout@v4
         with:
           ref: gh-pages
+      - uses: actions/download-artifact@v4
+        with:
+          name: docs
+          path: docs
+      - name: DEBUG
+        run: |
+          ls -alrt .
+          ls -alrt docs
       - name: Setup Go environment
         uses: actions/setup-go@v5
       - name: Generate index.html
@@ -76,16 +90,18 @@ jobs:
           destination: ./_site
       - name: Copy docs to website folder
         run: |
-          mkdir -p _site/docs
-          cp -r docs/.vitepress/dist/* _site/docs/
+          id
+          ls -alrt ./_site
+          sudo mkdir -p ./_site/docs
+          sudo cp -r docs/* ./_site/docs/
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
   deploy:
+    runs-on: ubuntu-latest
+    needs: build
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
-    runs-on: ubuntu-latest
-    needs: build
     steps:
       - name: Deploy to GitHub Pages
         id: deployment

README.md

@@ -6,7 +6,7 @@
 This repository provides a list of community, vendor and home Helm charts to easily configure and run workloads in Kubernetes clusters.
 Feel free to [contribute](CONTRIBUTING.md)!
 
-Latest chart versions are available from [devpro.github.io/helm-charts](https://devpro.github.io/helm-charts/).
+Get started with the [documentation](https://devpro.github.io/helm-charts/docs/).
 
 ## Usage
 

docs/.vitepress/config.mts

@@ -5,6 +5,7 @@ import { generateSidebar } from 'vitepress-sidebar'
 export default defineConfig({
   title: "Devpro Helm Chart Guide",
   description: "A guide to make the best use of Helm charts to manage workload in Kubernetes clusters",
+  base: '/helm-charts/docs/',
   themeConfig: {
     // https://vitepress.dev/reference/default-theme-config
     nav: [