update action and docs

.github/workflows/publish.yml

@@ -1,19 +1,53 @@
-name: Publish Site
+name: documentation
+
 on:
+  pull_request:
+    branches: [main]
   push:
-    branches:
-      - main
+    branches: [main]
+
 jobs:
-  build-deploy:
+  checks:
+    if: github.event_name != 'push'
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout Repo
-        uses: actions/checkout@master
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v1
         with:
-          submodules: true
-
-      - name: Publish Site
-        uses: chabad360/hugo-gh-pages@master
+          node-version: '12.x'
+      - name: Test Build
+        run: |
+          if [ -e yarn.lock ]; then
+          yarn install --frozen-lockfile
+          elif [ -e package-lock.json ]; then
+          npm ci
+          else
+          npm i
+          fi
+          npm run build
+  gh-release:
+    if: github.event_name != 'pull_request'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v1
+        with:
+          node-version: '12.x'
+      - uses: webfactory/[email protected]
         with:
-          githubToken: ${{ secrets.GITHUB_TOKEN }}
-          hugoVersion: extended_0.82.0
+          ssh-private-key: ${{ secrets.GH_PAGES_DEPLOY }}
+      - name: Release to GitHub Pages
+        env:
+          USE_SSH: true
+          GIT_USER: git
+        run: |
+          git config --global user.email "[email protected]"
+          git config --global user.name "gh-actions"
+          if [ -e yarn.lock ]; then
+          yarn install --frozen-lockfile
+          elif [ -e package-lock.json ]; then
+          npm ci
+          else
+          npm i
+          fi
+          npm run deploy

README.md

@@ -1,4 +1,4 @@
-# Website
+# harvesterhci.io
 
 This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
 

docs/authentication.md

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 4
+sidebar_position: 30
 ---
 # Authentication
 

docs/development/_category_.json

@@ -0,0 +1,4 @@
+{
+  "label": "Development",
+  "position": 90
+}

docs/dev-mode.md → docs/development/dev-mode.md

@@ -1,7 +1,7 @@
 ---
 sidebar_position: 9
 ---
-# Developer Mode Installation (Dev mode)
+# Developer Mode Installation
 
 Developer mode (dev mode) is intended to be used for testing and development purposes.
 

docs/harvester-network.md

@@ -1,15 +1,8 @@
 ---
-sidebar_position: 7
+sidebar_position: 40
 ---
-# Introduction of The Harvester network
-
-## Table of Contents
-  * [Summary](#summary)
-  * [Implementation](#implementation)
-    * [Management Network](#management-network)
-    * [VLAN](#vlan)
-  * [Enabling VLAN in the Harvester UI](#enabling-vlan-in-the-harvester-ui)
 
+# Harvester Network
 
 ## Summary
 [Harvester](https://github.com/harvester/harvester) is built on Kubernetes, which uses [CNI](https://github.com/containernetworking/cni) as an interface between network providers and Kubernetes pod networking. Naturally, we implement the Harvester network based on CNI. Moreover, the [Harvester UI](https://github.com/harvester/harvester-ui) integrates the Harvester network to provide a user-friendly way to configure networks for VMs.

docs/import-image.md

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 5
+sidebar_position: 60
 ---
 # Import Images
 

docs/installation/_category_.json

@@ -1,4 +1,4 @@
 {
   "label": "Installation",
-  "position": 2
+  "position": 10
 }

docs/rancher-intergration/_category_.json

@@ -1,4 +1,4 @@
 {
   "label": "Rancher Intergration",
-  "position": 8
+  "position": 80
 }

docs/upgrade.md

@@ -1,20 +1,19 @@
 ---
-sidebar_position: 3
+sidebar_position: 30
 ---
 # Upgrading Harvester
 
 > Available as of v0.2.0
 
 Harvester provides two ways to upgrade.
 
->:warning: Notes:
->- Upgrading from v0.1.0 is not supported.
->- Upgrading from/to any RC releases is not supported.
->- Due to pending OS changes in the roadmap, the upgradability to the GA release cannot be guaranteed at this moment.
->- Zero downtime upgrade is supported when the Harvester cluster includes 3 or more nodes. If the cluster has less than 3 nodes, you can still perform upgrades but there'll be downtime during the upgrade.
->- Upgrade nodes one by one.
-
-**NOTE: Due to pending OS changes in the roadmap, the upgradability to the GA release cannot be guaranteed at this moment.**
+:::note
+- Upgrading from v0.1.0 is not supported.
+- Upgrading from/to any RC releases is not supported.
+- Due to pending OS changes in the roadmap, the upgradability to the GA release cannot be guaranteed at this moment.
+- Zero downtime upgrade is supported when the Harvester cluster includes 3 or more nodes. If the cluster has less than 3 nodes, you can still perform upgrades but there'll be downtime during the upgrade.
+- Upgrade nodes one by one.
+:::
 
 ## Upgrade using the ISO image
 

docs/vm-management/_category_.json

@@ -1,4 +1,4 @@
 {
   "label": "VM Management",
-  "position": 6
+  "position": 70
 }

docusaurus.config.js

@@ -8,7 +8,7 @@ module.exports = {
   onBrokenMarkdownLinks: 'warn',
   favicon: 'img/favicon.ico',
   organizationName: 'harvester', // Usually your GitHub org/user name.
-  projectName: 'harvesterhci.io', // Usually your repo name.
+  projectName: 'harvester.github.io', // Usually your repo name.
   themeConfig: {
     colorMode: {
       // "light" | "dark"