Merge pull request #647 from wzshiming/docs/menu

Update menu of site
kubernetes-sigs · Jun 12, 2023 · 746a9fd · 746a9fd
2 parents 25f4d02 + e7924a3
commit 746a9fd
Show file tree

Hide file tree

Showing 32 changed files with 357 additions and 59 deletions.
diff --git a/site/assets/_custom.scss b/site/assets/_custom.scss
@@ -18,3 +18,11 @@ code {
     border-radius: .25rem;
     font-size: .875em;
 }
+
+a.active {
+    color: var(--color-link);
+}
+
+a.ancestor {
+    color: var(--color-visited-link);
+}
diff --git a/site/config.yaml b/site/config.yaml
@@ -46,10 +46,6 @@ params:
   # /static/logo.png then the path would be logo.png
   BookLogo: /favicon.png
 
-  # (Optional, default none) Set leaf bundle to render as side menu
-  # When not specified file structure and weights will be used
-  BookMenuBundle: /menu
-
   # (Optional, default docs) Specify root page to render child pages as menu.
   # Page is resoled by .GetPage function: https://gohugo.io/functions/getpage/
   # For backward compatibility you can set '*' to render all sections to menu. Acts same as '/'
@@ -100,3 +96,144 @@ params:
   # /!\ This is an experimental feature, might be removed or changed at any time
   # (Optional, experimental, default false) Enables a drop-down menu for translations only if a translation is present.
   BookTranslatedOnly: false
+
+menu:
+  before:
+    - identifier: home
+      pageRef: "/"
+
+  main:
+    # User Guide
+    - identifier: user-guide
+      pageRef: "/docs/user"
+      weight: 10
+      params:
+        collapse: never
+    # Design
+    - identifier: design
+      title: Design
+      weight: 20
+    # Contributing
+    - identifier: contributing
+      pageRef: "/docs/contributing"
+      weight: 30
+
+    # User Guide Children
+    - identifier: all-in-one-image
+      pageRef: "/docs/user/all-in-one-image"
+      weight: 1010
+      parent: user-guide
+    - identifier: installation
+      pageRef: "/docs/user/installation"
+      weight: 1020
+      parent: user-guide
+    - identifier: kwok-in-cluster
+      pageRef: "/docs/user/kwok-in-cluster"
+      weight: 1030
+      parent: user-guide
+    - identifier: kwok-out-cluster
+      pageRef: "/docs/user/kwok-out-cluster"
+      weight: 1040
+      parent: user-guide
+    - identifier: kwokctl-manage-cluster
+      pageRef: "/docs/user/kwokctl-manage-cluster"
+      weight: 1050
+      parent: user-guide
+    - identifier: manage-nodes-and-pods
+      pageRef: "/docs/user/kwok-manage-nodes-and-pods"
+      weight: 1060
+      parent: user-guide
+
+    - identifier: kwokctl-advanced-usage
+      title: "`kwokctl` Advanced Usage"
+      weight: 200010
+      parent: user-guide
+    - identifier: snapshots
+      pageRef: "/docs/user/kwokctl-snapshot"
+      parent: kwokctl-advanced-usage
+    - identifier: metrics
+      pageRef: "/docs/user/kwokctl-metrics"
+      parent: kwokctl-advanced-usage
+    - identifier: auditing
+      pageRef: "/docs/user/kwokctl-auditing"
+      parent: kwokctl-advanced-usage
+    - identifier: authorization
+      pageRef: "/docs/user/kwokctl-authorization"
+      parent: kwokctl-advanced-usage
+    - identifier: admission
+      pageRef: "/docs/user/kwokctl-admission"
+      parent: kwokctl-advanced-usage
+    - identifier: platform-specific-binaries
+      pageRef: "/docs/user/kwokctl-platform-specific-binaries"
+      parent: kwokctl-advanced-usage
+
+    - identifier: tools
+      title: Tools
+      weight: 200020
+      parent: user-guide
+    - identifier: kwok
+      title: '`kwok` CLI'
+      pageRef: "/docs/generated/kwok"
+      parent: tools
+    - identifier: kwokctl
+      title: '`kwokctl` CLI'
+      pageRef: "/docs/generated/kwokctl"
+      parent: tools
+
+    - identifier: configuration
+      pageRef: "/docs/user/configuration"
+      weight: 200030
+      parent: user-guide
+    - identifier: api-reference
+      pageRef: "/docs/generated/apis"
+      parent: configuration
+    - identifier: stages
+      pageRef: "/docs/user/stages-configuration"
+      parent: configuration
+    - identifier: port-forward
+      pageRef: "/docs/user/port-forward-configuration"
+      parent: configuration
+    - identifier: exec
+      pageRef: "/docs/user/exec-configuration"
+      parent: configuration
+    - identifier: logs
+      pageRef: "/docs/user/logs-configuration"
+      parent: configuration
+    - identifier: attach
+      pageRef: "/docs/user/attach-configuration"
+      parent: configuration
+
+    # Design Children
+    - identifier: introduction
+      pageRef: "/docs/design/introduction"
+      weight: 2010
+      parent: design
+    - identifier: architecture
+      pageRef: "/docs/design/architecture"
+      weight: 2020
+      parent: design
+
+    # Contributing Children
+    - identifier: documentation
+      pageRef: "/docs/contributing/documentation"
+      parent: contributing
+    - identifier: development
+      pageRef: "/docs/contributing/development"
+      parent: contributing
+
+  after:
+    - identifier: blog
+      pageRef: "/posts"
+      weight: 10
+    - identifier: adopters
+      title: Adopters
+      pageRef: "/docs/adopters"
+      weight: 20
+    - identifier: roadmap
+      title: Roadmap ⛓
+      url: https://github.com/orgs/kubernetes-sigs/projects/21
+      weight: 30
+    - identifier: source-code
+      title: Source Code ⛓
+      url: https://github.com/kubernetes-sigs/kwok
+      weight: 40
diff --git a/site/content/en/_index.md b/site/content/en/_index.md
@@ -1,6 +1,5 @@
 ---
 title: Home
-type: docs
 ---
 
 # `KWOK` (`K`ubernetes `W`ith`O`ut `K`ubelet)
@@ -49,8 +48,8 @@ The animation below shows a test process to work with the latest version of `kwo
 
 <img width="700px" src="/img/demo/manage-clusters.svg">
 
-Welcome to [get started]({{< relref "/docs/user/getting-started" >}}) with the installation, basic usage, custom configuration,
-and [contribution to KWOK]({{< relref "/docs/contributing/getting-started" >}}).
+Welcome to [get started][user guide] with the installation, basic usage, custom configuration,
+and [contribution to KWOK][contributor guide].
 
 ## `kwokctl` Runtime and OS Support
 
@@ -85,7 +84,8 @@ Participation in the Kubernetes community is governed by the [Kubernetes Code of
 [kind]: https://github.com/kubernetes-sigs/kind
 [kubemark]: https://github.com/kubernetes/kubernetes/tree/master/test/kubemark
 [community page]: https://kubernetes.io/community/
-[contributor guide]: {{< relref "/docs/contributing/getting-started" >}}
+[user guide]: {{< relref "/docs/user" >}}
+[contributor guide]: {{< relref "/docs/contributing" >}}
 [code of conduct]: https://github.com/kubernetes-sigs/kwok/blob/main/code-of-conduct.md
 [sigs.k8s.io/kwok]: https://sigs.k8s.io/kwok/
 [#kwok]: https://kubernetes.slack.com/messages/kwok/

diff --git a/site/content/en/docs/adopters/_index.md b/site/content/en/docs/adopters/_index.md
@@ -1,3 +1,8 @@
+---
+title: Adopters
+bookToc: false
+---
+
 # Adopters
 
 We are frequently asked who is using of KWOK and how. We would like to share the list of adopters below.

diff --git a/...t/en/docs/contributing/getting-started.md → site/content/en/docs/contributing/_index.md b/...t/en/docs/contributing/getting-started.md → site/content/en/docs/contributing/_index.md
@@ -1,3 +1,9 @@
+---
+title: Contributing
+aliases:
+  - /docs/contributing/getting-started
+---
+
 # Getting Started
 
 {{< hint "info" >}}

diff --git a/site/content/en/docs/contributing/development.md b/site/content/en/docs/contributing/development.md
@@ -1,3 +1,7 @@
+---
+title: Development
+---
+
 # Development
 
 {{< hint "info" >}}

diff --git a/site/content/en/docs/contributing/documentation.md b/site/content/en/docs/contributing/documentation.md
@@ -1,3 +1,7 @@
+---
+title: Documentation
+---
+
 # Documentation
 
 {{< hint "info" >}}

diff --git a/site/content/en/docs/design/architecture.md b/site/content/en/docs/design/architecture.md
@@ -1,3 +1,7 @@
+---
+title: Architecture
+---
+
 # Architecture
 
 {{< hint "info" >}}

diff --git a/site/content/en/docs/design/introduction.md b/site/content/en/docs/design/introduction.md
@@ -1,3 +1,7 @@
+---
+title: Introduction
+---
+
 # Introduction
 
 {{< hint "info" >}}

diff --git a/site/content/en/docs/user/getting-started.md → site/content/en/docs/user/_index.md b/site/content/en/docs/user/getting-started.md → site/content/en/docs/user/_index.md
@@ -1,3 +1,9 @@
+---
+title: User Guide
+aliases:
+  - /docs/user/getting-started
+---
+
 # Getting Started
 
 {{< hint "info" >}}
@@ -34,7 +40,7 @@ If any special concerns, you can configure KWOK with options and stages.
 
 I hope this helps you get started with KWOK! Good luck and have fun!
 
-[Install]: {{< relref "/docs/user/install" >}}
+[Install]: {{< relref "/docs/user/installation" >}}
 [`kwok` Manages Nodes and Pods]: {{< relref "/docs/user/kwok-manage-nodes-and-pods" >}}
 [`kwok` in Cluster]: {{< relref "/docs/user/kwok-in-cluster" >}}
 [`kwok` out of Cluster]: {{< relref "/docs/user/kwok-out-cluster" >}}

diff --git a/site/content/en/docs/user/all-in-one-image.md b/site/content/en/docs/user/all-in-one-image.md
@@ -1,3 +1,7 @@
+---
+title: All-in-one Image
+---
+
 # Run cluster with all-in-one image
 
 {{< hint "info" >}}

diff --git a/site/content/en/docs/user/attach-configuration.md b/site/content/en/docs/user/attach-configuration.md
@@ -1,3 +1,7 @@
+---
+title: Attach
+---
+
 # Attach Configuration
 
 {{< hint "info" >}}

diff --git a/site/content/en/docs/user/configuration.md b/site/content/en/docs/user/configuration.md
@@ -1,3 +1,7 @@
+---
+title: Configuration
+---
+
 # Configuration
 
 {{< hint "info" >}}

diff --git a/site/content/en/docs/user/exec-configuration.md b/site/content/en/docs/user/exec-configuration.md
@@ -1,3 +1,7 @@
+---
+title: Exec
+---
+
 # Exec Configuration
 
 {{< hint "info" >}}

diff --git a/site/content/en/docs/user/install.md → site/content/en/docs/user/installation.md b/site/content/en/docs/user/install.md → site/content/en/docs/user/installation.md
@@ -1,4 +1,10 @@
-# Install
+---
+title: Installation
+aliases:
+  - /docs/user/install/
+---
+
+# Installation
 
 {{< hint "info" >}}
 
@@ -16,7 +22,7 @@ this will install the latest version of `kwokctl` and `kwok` binaries.
 brew install kwok
 ```
 
-## Go Install
+## Install with Golang
 
 also, you can install `kwokctl` and `kwok` binaries via [golang].
 

diff --git a/site/content/en/docs/user/kwok-in-cluster.md b/site/content/en/docs/user/kwok-in-cluster.md
@@ -1,3 +1,7 @@
+---
+title: "`kwok` in Cluster"
+---
+
 # Deploy `kwok` in a Cluster
 
 {{< hint "info" >}}

diff --git a/site/content/en/docs/user/kwok-manage-nodes-and-pods.md b/site/content/en/docs/user/kwok-manage-nodes-and-pods.md
@@ -1,3 +1,7 @@
+---
+title: Manage Nodes and Pods
+---
+
 # Manage nodes and pods with `kwok`
 
 {{< hint "info" >}}

diff --git a/site/content/en/docs/user/kwok-out-cluster.md b/site/content/en/docs/user/kwok-out-cluster.md
@@ -1,4 +1,5 @@
 ---
+title: "`kwok` out of Cluster"
 aliases:
   - /docs/user/kwok-in-local/
 ---
@@ -42,4 +43,4 @@ Finally, you can see the `kwok` is running out of cluster for the Kubernetes clu
 Now, you can use `kwok` to [manage nodes and pods] in the Kubernetes cluster.
 
 [manage nodes and pods]: {{< relref "/docs/user/kwok-manage-nodes-and-pods" >}}
-[install]: {{< relref "/docs/user/install" >}}
+[install]: {{< relref "/docs/user/installation" >}}
diff --git a/site/content/en/docs/user/kwokctl-admission.md b/site/content/en/docs/user/kwokctl-admission.md
@@ -1,3 +1,7 @@
+---
+title: "Admission"
+---
+
 # `kwokctl` Admission
 
 {{< hint "info" >}}

diff --git a/site/content/en/docs/user/kwokctl-auditing.md b/site/content/en/docs/user/kwokctl-auditing.md
@@ -1,3 +1,7 @@
+---
+title: "Auditing"
+---
+
 # `kwokctl` Auditing
 
 {{< hint "info" >}}

diff --git a/site/content/en/docs/user/kwokctl-authorization.md b/site/content/en/docs/user/kwokctl-authorization.md
@@ -1,3 +1,7 @@
+---
+title: "Authorization"
+---
+
 # `kwokctl` Authorization
 
 {{< hint "info" >}}

diff --git a/site/content/en/docs/user/kwokctl-manage-cluster.md b/site/content/en/docs/user/kwokctl-manage-cluster.md
@@ -1,3 +1,7 @@
+---
+title: "`kwokctl` Manage Clusters"
+---
+
 # Create a Cluster with `kwokctl`
 
 {{< hint "info" >}}
@@ -58,4 +62,4 @@ Cluster "kwok-kwok" deleted
 Now, you can use `kwok` to [manage nodes and pods] in the Kubernetes cluster.
 
 [manage nodes and pods]: {{< relref "/docs/user/kwok-manage-nodes-and-pods" >}}
-[install]: {{< relref "/docs/user/install" >}}
+[install]: {{< relref "/docs/user/installation" >}}
diff --git a/site/content/en/docs/user/kwokctl-metrics.md b/site/content/en/docs/user/kwokctl-metrics.md
@@ -1,3 +1,7 @@
+---
+title: "Metrics"
+---
+
 # `kwokctl` Metrics
 
 {{< hint "info" >}}