Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
wzshiming committed Aug 8, 2024
1 parent da3756a commit e414361
Show file tree
Hide file tree
Showing 8 changed files with 33 additions and 30 deletions.
2 changes: 1 addition & 1 deletion netlify.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions site/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@
/resources
/*.lock
/public
_vendor
41 changes: 22 additions & 19 deletions site/config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ disablePathToLower: false
enableGitInfo: true
disableKinds:
- taxonomy
- taxonomyTerm

permalinks:
posts: "/:section/:year/:month/:day/:slug/"
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
10 changes: 4 additions & 6 deletions site/content/en/docs/user/kwok-in-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,18 +53,18 @@ 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).

{{< /tab >}}

{{< tab "Kustomize (<0.4)" >}}
{{< tab "Kustomize (<v0.4)" >}}

## Variables preparation

Expand Down Expand Up @@ -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" >}}
3 changes: 1 addition & 2 deletions site/content/en/docs/user/kwokctl-auditing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 >}}

Expand Down Expand Up @@ -37,4 +37,3 @@ kwokctl logs audit

<img width="700px" src="/img/demo/audit-log.svg">

[Audit policy]: https://kubernetes.io/docs/tasks/debug-application-cluster/audit/#audit-policy
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion site/layouts/partials/docs/menu.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<nav>
{{ partial "docs/brand" . }}
{{ partial "docs/search" . }}
{{ if .Site.IsMultiLingual }}
{{ if hugo.IsMultilingual }}
{{ partial "docs/languages" . }}
{{ end }}

Expand Down
2 changes: 1 addition & 1 deletion site/layouts/shortcodes/code-sample.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

{{ $filename := $file }}
{{ if not (hasPrefix $filename "/") }}
{{ $filename = printf "%s/%s" $page.Path $file }}
{{ $filename = path.Join $page.Path $file }}
{{ end }}
{{ $filename = safeURL $filename }}

Expand Down

0 comments on commit e414361

Please sign in to comment.