From 6709e2d7f878003b1c659bdef3e6c365e087bd93 Mon Sep 17 00:00:00 2001 From: Shiming Zhang Date: Thu, 8 Aug 2024 14:30:24 +0800 Subject: [PATCH] Update docs --- netlify.toml | 2 +- site/.gitignore | 1 + site/config.yaml | 41 ++++++++++--------- site/content/en/docs/user/kwok-in-cluster.md | 8 ++-- site/content/en/docs/user/kwokctl-auditing.md | 3 +- .../kwokctl-platform-specific-binaries.md | 2 + site/layouts/partials/docs/menu.html | 2 +- site/layouts/shortcodes/code-sample.html | 2 +- 8 files changed, 32 insertions(+), 29 deletions(-) diff --git a/netlify.toml b/netlify.toml index 5ae7f626c7..c3785c63f1 100644 --- a/netlify.toml +++ b/netlify.toml @@ -5,7 +5,7 @@ publish = "public/" command = "make build" [build.environment] -HUGO_VERSION = "0.125.7" +HUGO_VERSION = "0.131.0" [context.production.environment] # this controls our robots.txt diff --git a/site/.gitignore b/site/.gitignore index d52271becf..d667afe062 100644 --- a/site/.gitignore +++ b/site/.gitignore @@ -3,3 +3,4 @@ /resources /*.lock /public +_vendor \ No newline at end of file diff --git a/site/config.yaml b/site/config.yaml index 0586060819..a691407a98 100644 --- a/site/config.yaml +++ b/site/config.yaml @@ -9,7 +9,6 @@ disablePathToLower: false enableGitInfo: true disableKinds: - taxonomy -- taxonomyTerm permalinks: posts: "/:section/:year/:month/:day/:slug/" @@ -161,44 +160,48 @@ menu: weight: 1060 parent: user-guide - - identifier: kwokctl-advanced-usage - title: "`kwokctl` Advanced Usage" - weight: 200010 + - identifier: examples + title: Examples parent: user-guide + - identifier: kwokctl-advanced + title: "`kwokctl` Advanced" + weight: 200010 + parent: examples - identifier: snapshots pageRef: "/docs/user/kwokctl-snapshot" - parent: kwokctl-advanced-usage + parent: kwokctl-advanced - identifier: auditing pageRef: "/docs/user/kwokctl-auditing" - parent: kwokctl-advanced-usage + parent: kwokctl-advanced - identifier: authorization pageRef: "/docs/user/kwokctl-authorization" - parent: kwokctl-advanced-usage + parent: kwokctl-advanced - identifier: admission pageRef: "/docs/user/kwokctl-admission" - parent: kwokctl-advanced-usage + parent: kwokctl-advanced - identifier: platform-specific-binaries pageRef: "/docs/user/kwokctl-platform-specific-binaries" - parent: kwokctl-advanced-usage + parent: kwokctl-advanced - - identifier: examples - title: Examples - parent: kwokctl-advanced-usage + - identifier: kwokctl-integration + title: "`kwokctl` Integration" + weight: 200020 + parent: examples - identifier: argo pageRef: "/docs/examples/argo" - parent: examples + parent: kwokctl-integration - identifier: linkerd pageRef: "/docs/examples/linkerd" - parent: examples + parent: kwokctl-integration - identifier: istio pageRef: "/docs/examples/istio" - parent: examples + parent: kwokctl-integration - identifier: metrics-server pageRef: "/docs/examples/metrics-server" - parent: examples + parent: kwokctl-integration - identifier: metrics pageRef: "/docs/examples/prometheus" - parent: examples + parent: kwokctl-integration - identifier: tools title: Tools @@ -329,10 +332,10 @@ menu: pageRef: "/docs/adopters" weight: 20 - identifier: roadmap - title: Roadmap ⛓ + title: Roadmap ↩ url: https://github.com/orgs/kubernetes-sigs/projects/21 weight: 30 - identifier: source-code - title: Source Code ⛓ + title: Source Code ↩ url: https://github.com/kubernetes-sigs/kwok weight: 40 diff --git a/site/content/en/docs/user/kwok-in-cluster.md b/site/content/en/docs/user/kwok-in-cluster.md index de0f615761..ce20a6ab29 100644 --- a/site/content/en/docs/user/kwok-in-cluster.md +++ b/site/content/en/docs/user/kwok-in-cluster.md @@ -53,12 +53,12 @@ The above configuration sets the CPU and memory usage of all the containers mana To override the defaults, you can add annotation `"kwok.x-k8s.io/usage-cpu"` (for cpu usage) and `"kwok.x-k8s.io/usage-memory"` (for memory usage) with any quantity value you want to the fake pods. -The resource usage simulation used above is annotation-based and the configuration is available at [here][resource usage from annotation]. -For the explanation of how it works and more complex resource usage simulation methods, please refer to [ResourceUsage configuration]. +The resource usage simulation used above is annotation-based and the configuration is available at [here](https://github.com/kubernetes-sigs/kwok/tree/main/kustomize/metrics/usage). +For the explanation of how it works and more complex resource usage simulation methods, please refer to [ResourceUsage configuration]({{< relref "/docs/user/resource-usage-configuration" >}}). {{< /tab >}} -{{< tab "Helm Chart (WIP)" >}} +{{< tab "Helm Chart" >}} The kwok helm chart is listed on the [artifact hub](https://artifacthub.io/packages/helm/kwok/kwok). @@ -116,5 +116,3 @@ kubectl apply -f "${KWOK_WORK_DIR}/kwok.yaml" 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" >}} -[resource usage from annotation]: https://github.com/kubernetes-sigs/kwok/tree/main/kustomize/metrics/usage -[ResourceUsage configuration]: {{< relref "/docs/user/resource-usage-configuration" >}} diff --git a/site/content/en/docs/user/kwokctl-auditing.md b/site/content/en/docs/user/kwokctl-auditing.md index 251e3cec70..807559eb40 100644 --- a/site/content/en/docs/user/kwokctl-auditing.md +++ b/site/content/en/docs/user/kwokctl-auditing.md @@ -6,7 +6,7 @@ title: "Auditing" {{< hint "info" >}} -This document walks you through how to enable [Audit policy] on a `kwokctl` cluster +This document walks you through how to enable [Audit policy](https://kubernetes.io/docs/tasks/debug-application-cluster/audit/#audit-policy) on a `kwokctl` cluster {{< /hint >}} @@ -37,4 +37,3 @@ kwokctl logs audit -[Audit policy]: https://kubernetes.io/docs/tasks/debug-application-cluster/audit/#audit-policy diff --git a/site/content/en/docs/user/kwokctl-platform-specific-binaries.md b/site/content/en/docs/user/kwokctl-platform-specific-binaries.md index 886448115f..e133a2ce89 100644 --- a/site/content/en/docs/user/kwokctl-platform-specific-binaries.md +++ b/site/content/en/docs/user/kwokctl-platform-specific-binaries.md @@ -8,6 +8,8 @@ title: "Platform-Specific Binaries" This document provides details on how to build Kubernetes binaries and run `kwokctl` locally. +In v0.6.0 and later, this will be enabled automatically and no longer needs to be configured. + {{< /hint >}} ## Overview diff --git a/site/layouts/partials/docs/menu.html b/site/layouts/partials/docs/menu.html index 04c3f1a258..e0aaf34014 100644 --- a/site/layouts/partials/docs/menu.html +++ b/site/layouts/partials/docs/menu.html @@ -1,7 +1,7 @@