Skip to content

Commit

Permalink
Added in the learning path content for each persona.
Browse files Browse the repository at this point in the history
Signed-off-by: John Krug <[email protected]>
  • Loading branch information
jhkrug committed Jul 17, 2024
1 parent 87d621c commit 39a75b9
Show file tree
Hide file tree
Showing 16 changed files with 265 additions and 8 deletions.
2 changes: 1 addition & 1 deletion docs/learnpaths/_category_.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"label": "Learning paths",
"position": 75,
"position": 25,
"collapsed": true
}
Empty file removed docs/learnpaths/all.md
Empty file.
Empty file removed docs/learnpaths/developer.md
Empty file.
Empty file removed docs/learnpaths/distributor.md
Empty file.
Empty file removed docs/learnpaths/integrator.md
Empty file.
22 changes: 22 additions & 0 deletions docs/learnpaths/kubewarden-all.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
sidebar_label: All
title: All
description: Learning paths for different personas.
keywords: [learning paths]
doc-persona: [kubewarden-all]
doc-type: [explanation]
doc-topic: [learning-paths]
---

|Page title|
|-|
|[Kubewarden vs OPA Gatekeeper](../explanations/comparisons/opa-comparison)|
|[Kubewarden architecture](../explanations/architecture)|
|[Common tasks](../howtos/tasks)|
|[Threat Model](../reference/threat-model)|
|[OCI registry support for Kubewarden](../reference/oci-registries-support)|
|[Dependency matrix](../reference/dependency-matrix)|
|[Glossary](../glossary)|
|[Quick start](../quick-start)|
|[Security disclosure](../disclosure)|
|[What is Kubewarden?](../introduction)|
43 changes: 43 additions & 0 deletions docs/learnpaths/kubewarden-developer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
sidebar_label: Developer
title: Developer
description: Learning paths for different personas.
keywords: [learning paths]
doc-persona: [kubewarden-developer]
doc-type: [explanation]
doc-topic: [learning-paths]
---

|Page title|
|-|
|[Contributing to Kubewarden documentation](../howtos/contribution-guide/contributing)|
|[Contribution guide](../howtos/contribution-guide/contribution-guide)|
|[Suggesting a doc improvement](../howtos/contribution-guide/suggesting-an-improvement)|
|[Custom Resource Definitions (CRD)](../reference/CRDs)|
|[Testing for cluster operators](../tutorials/testing-policies/03-cluster-operators)|
|[Writing policies in Go](../tutorials/writing-policies/go/01-intro-go)|
|[Creating a new validation policy](../tutorials/writing-policies/go/02-scaffold)|
|[Defining policy settings](../tutorials/writing-policies/go/03-policy-settings)|
|[Writing the validation logic](../tutorials/writing-policies/go/04-validation)|
|[End-to-end testing](../tutorials/writing-policies/go/05-e2e-tests)|
|[Logging](../tutorials/writing-policies/go/06-logging)|
|[Integrating with GitHub Actions](../tutorials/writing-policies/go/07-automate)|
|[Distributing policy](../tutorials/writing-policies/go/08-distribute)|
|[Validation using JSON queries](../tutorials/writing-policies/go/09-validation-with-queries)|
|[Writing raw policies](../tutorials/writing-policies/go/10-raw-policies)|
|[Policy metadata](../tutorials/writing-policies/metadata)|
|[Rust](../tutorials/writing-policies/rust/01-intro-rust)|
|[Creating a policy](../tutorials/writing-policies/rust/02-create-policy)|
|[Defining policy settings](../tutorials/writing-policies/rust/03-define-policy-settings)|
|[Writing validation logic](../tutorials/writing-policies/rust/04-write-validation-logic)|
|[Creating a new mutation policy](../tutorials/writing-policies/rust/05-mutation-policy)|
|[Logging](../tutorials/writing-policies/rust/06-logging)|
|[Building and distributing policies](../tutorials/writing-policies/rust/07-build-and-distribute)|
|[Raw policies](../tutorials/writing-policies/rust/08-raw-policies)|
|[Typescript](../tutorials/writing-policies/typescript)|
|[WASI](../tutorials/writing-policies/wasi/01-intro-wasi)|
|[Writing raw policies](../tutorials/writing-policies/wasi/02-raw-policies)|
|[Introduction to CEL](../tutorials/writing-policies/CEL/01-intro-cel)|
|[Reusing ValidatingAdmissionPolicies](../tutorials/writing-policies/CEL/02-reusing-vap)|
|[Context-aware CEL policies](../tutorials/writing-policies/CEL/03-context-aware)|
|[Sigstore host capabilities](../tutorials/writing-policies/CEL/04-example-sigstore)|
22 changes: 22 additions & 0 deletions docs/learnpaths/kubewarden-distributor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
sidebar_label: Distributor
title: Distributor
description: Learning paths for different personas.
keywords: [learning paths]
doc-persona: [kubewarden-distributor]
doc-type: [explanation]
doc-topic: [learning-paths]
---

|Page title|
|-|
|[Distributing policies](../explanations/distributing-policies)|
|[Using Pod Security Admission with Kubewarden](../howtos/pod-security-admission-with-kubewarden)|
|[PodSecurityPolicy migration](../howtos/psp-migration)|
|[Raw policies](../howtos/raw-policies)|
|[Secure supply chain](../howtos/secure-supply-chain)|
|[Custom certificate authorities](../howtos/custom-certificate-authorities)|
|[Audit Scanner](../howtos/audit-scanner)|
|[ValidatingAdmissionPolicy migration](../howtos/vap-migration)|
|[Policy Server certificate rotation issue](../howtos/workarounds/policy-server-certificate-expiry)|
|[Publish policies to Artifact Hub](../tutorials/publish-policy-to-artifact-hub)|
47 changes: 47 additions & 0 deletions docs/learnpaths/kubewarden-integrator.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
sidebar_label: Integrator
title: Integrator
description: Learning paths for different personas.
keywords: [learning paths]
doc-persona: [kubewarden-integrator]
doc-type: [explanation]
doc-topic: [learning-paths]
---

|Page title|
|-|
|[What is the Audit Scanner?](../explanations/audit-scanner/audit-scanner)|
|[Audit Scanner - Limitations](../explanations/audit-scanner/limitations)|
|[Audit Scanner - Policy Reports](../explanations/audit-scanner/policy-reports)|
|[Context aware policies](../explanations/context-aware-policies)|
|[Distributing policies](../explanations/distributing-policies)|
|[Mutating policies](../explanations/mutating-policies)|
|[Managing Kubewarden with Rancher Fleet](../howtos/Rancher-Fleet)|
|[Requirements for a Kubewarden air gap installation](../howtos/airgap/01-requirements)|
|[Air gap installation](../howtos/airgap/02-install)|
|[Using Pod Security Admission with Kubewarden](../howtos/pod-security-admission-with-kubewarden)|
|[Configuring policies](../howtos/policies)|
|[Using custom certificate authorities](../howtos/policy-servers/01-custom-cas)|
|[Configuring PolicyServers to use private registries](../howtos/policy-servers/02-private-registry)|
|[Configuring PolicyServers for production](../howtos/policy-servers/03-production-deployments)|
|[PodSecurityPolicy migration](../howtos/psp-migration)|
|[Raw policies](../howtos/raw-policies)|
|[Secure supply chain](../howtos/secure-supply-chain)|
|[Tracing quickstart](../howtos/telemetry/20-tracing-qs)|
|[Metrics quickstart](../howtos/telemetry/30-metrics-qs)|
|[Open Telemetry quick start](../howtos/telemetry/10-opentelemetry-qs)|
|[Rancher UI extension quickstart](../howtos/ui-extension/01-install)|
|[Monitoring](../howtos/ui-extension/02-metrics)|
|[Tracing](../howtos/ui-extension/03-tracing)|
|[Custom certificate authorities](../howtos/custom-certificate-authorities)|
|[Audit Scanner](../howtos/audit-scanner)|
|[ValidatingAdmissionPolicy migration](../howtos/vap-migration)|
|[Policy Server certificate rotation issue](../howtos/workarounds/policy-server-certificate-expiry)|
|[Metrics reference](../reference/metrics-reference)|
|[Monitor mode](../reference/monitor-mode)|
|[Policy evaluation timeout protection](../reference/policy-evaluation-timeout)|
|[Verification configuration format](../reference/verification-config)|
|[Reference for sources.yaml](../reference/sources_yaml)|
|[Publish policies to Artifact Hub](../tutorials/publish-policy-to-artifact-hub)|
|[Verifying Kubewarden](../tutorials/verifying-kubewarden)|
|[Raw policies](../tutorials/writing-policies/rust/08-raw-policies)|
51 changes: 51 additions & 0 deletions docs/learnpaths/kubewarden-operator.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
sidebar_label: Operator
title: Operator
description: Learning paths for different personas.
keywords: [learning paths]
doc-persona: [kubewarden-operator]
doc-type: [explanation]
doc-topic: [learning-paths]
---

|Page title|
|-|
|[What is the Audit Scanner?](../explanations/audit-scanner/audit-scanner)|
|[Audit Scanner - Limitations](../explanations/audit-scanner/limitations)|
|[Audit Scanner - Policy Reports](../explanations/audit-scanner/policy-reports)|
|[Distributing policies](../explanations/distributing-policies)|
|[Managing Kubewarden with Rancher Fleet](../howtos/Rancher-Fleet)|
|[Requirements for a Kubewarden air gap installation](../howtos/airgap/01-requirements)|
|[Air gap installation](../howtos/airgap/02-install)|
|[Contributing to Kubewarden documentation](../howtos/contribution-guide/contributing)|
|[Contribution guide](../howtos/contribution-guide/contribution-guide)|
|[Suggesting a doc improvement](../howtos/contribution-guide/suggesting-an-improvement)|
|[Using Pod Security Admission with Kubewarden](../howtos/pod-security-admission-with-kubewarden)|
|[Configuring policies](../howtos/policies)|
|[Using custom certificate authorities](../howtos/policy-servers/01-custom-cas)|
|[Configuring PolicyServers to use private registries](../howtos/policy-servers/02-private-registry)|
|[Configuring PolicyServers for production](../howtos/policy-servers/03-production-deployments)|
|[PodSecurityPolicy migration](../howtos/psp-migration)|
|[Raw policies](../howtos/raw-policies)|
|[Secure supply chain](../howtos/secure-supply-chain)|
|[Tracing quickstart](../howtos/telemetry/20-tracing-qs)|
|[Metrics quickstart](../howtos/telemetry/30-metrics-qs)|
|[Open Telemetry quick start](../howtos/telemetry/10-opentelemetry-qs)|
|[Rancher UI extension quickstart](../howtos/ui-extension/01-install)|
|[Monitoring](../howtos/ui-extension/02-metrics)|
|[Tracing](../howtos/ui-extension/03-tracing)|
|[Custom certificate authorities](../howtos/custom-certificate-authorities)|
|[Audit Scanner](../howtos/audit-scanner)|
|[ValidatingAdmissionPolicy migration](../howtos/vap-migration)|
|[Policy Server certificate rotation issue](../howtos/workarounds/policy-server-certificate-expiry)|
|[Metrics reference](../reference/metrics-reference)|
|[Monitor mode](../reference/monitor-mode)|
|[Policy evaluation timeout protection](../reference/policy-evaluation-timeout)|
|[Upgrade path](../reference/upgrade-path)|
|[Verification configuration format](../reference/verification-config)|
|[Reference for sources.yaml](../reference/sources_yaml)|
|[Publish policies to Artifact Hub](../tutorials/publish-policy-to-artifact-hub)|
|[Policy testing](../tutorials/testing-policies/index)|
|[Verifying Kubewarden](../tutorials/verifying-kubewarden)|
|[Distributing policy](../tutorials/writing-policies/go/08-distribute)|
|[Building and distributing policies](../tutorials/writing-policies/rust/07-build-and-distribute)|
49 changes: 49 additions & 0 deletions docs/learnpaths/kubewarden-policy-developer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
sidebar_label: Policy Developer
title: Policy Developer
description: Learning paths for different personas.
keywords: [learning paths]
doc-persona: [kubewarden-policy-developer]
doc-type: [explanation]
doc-topic: [learning-paths]
---

|Page title|
|-|
|[What is the Audit Scanner?](../explanations/audit-scanner/audit-scanner)|
|[Audit Scanner - Limitations](../explanations/audit-scanner/limitations)|
|[Audit Scanner - Policy Reports](../explanations/audit-scanner/policy-reports)|
|[Context aware policies](../explanations/context-aware-policies)|
|[Distributing policies](../explanations/distributing-policies)|
|[Mutating policies](../explanations/mutating-policies)|
|[Raw policies](../howtos/raw-policies)|
|[Policy communication specification](../reference/spec/01-intro-spec)|
|[Policy settings](../reference/spec/02-settings)|
|[Validating policies](../reference/spec/03-validating-policies)|
|[Mutating policies](../reference/spec/04-mutating-policies)|
|[Context aware policies](../reference/spec/05-context-aware-policies)|
|[Host capabilities specification](../reference/spec/host-capabilities/01-intro-host-capabilities)|
|[Signature verifier policies](../reference/spec/host-capabilities/02-signature-verifier-policies)|
|[Network capabilities](../reference/spec/host-capabilities/04-net)|
|[Cryptographic capabilities](../reference/spec/host-capabilities/05-crypto)|
|[Kubernetes capabilities](../reference/spec/host-capabilities/06-kubernetes)|
|[Container registry capabilities](../reference/spec/host-capabilities/03-container-registry)|
|[Publish policies to Artifact Hub](../tutorials/publish-policy-to-artifact-hub)|
|[Testing for policy authors](../tutorials/testing-policies/02-policy-authors)|
|[Policy testing](../tutorials/testing-policies/index)|
|[Verifying Kubewarden](../tutorials/verifying-kubewarden)|
|[C#](../tutorials/writing-policies/dotnet)|
|[Writing Kubewarden policies](../tutorials/writing-policies/index)|
|[Other languages](../tutorials/writing-policies/other-languages)|
|[Rego](../tutorials/writing-policies/rego/01-intro-rego)|
|[Builtin support](../tutorials/writing-policies/rego/02-builtin-support)|
|[Gatekeeper support](../tutorials/writing-policies/rego/gatekeeper/01-intro)|
|[Creating a new Gatekeeper Rego policy](../tutorials/writing-policies/rego/gatekeeper/02-create-policy)|
|[Build and run a Gatekeeper policy](../tutorials/writing-policies/rego/gatekeeper/03-build-and-run)|
|[Distributing a Gatekeeper policy with Kubewarden](../tutorials/writing-policies/rego/gatekeeper/04-distribute)|
|[Introduction to Open Policy Agent](../tutorials/writing-policies/rego/open-policy-agent/01-intro)|
|[Creating a new policy](../tutorials/writing-policies/rego/open-policy-agent/02-create-policy)|
|[Build and run a OPA policy for Kubewarden](../tutorials/writing-policies/rego/open-policy-agent/03-build-and-run)|
|[Distributing an OPA policy with Kubewarden](../tutorials/writing-policies/rego/open-policy-agent/04-distribute)|
|[Writing raw policies](../tutorials/writing-policies/rego/open-policy-agent/05-raw-policies)|
|[Swift](../tutorials/writing-policies/swift)|
23 changes: 23 additions & 0 deletions docs/learnpaths/kubewarden-user.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
sidebar_label: User
title: User
description: Learning paths for different personas.
keywords: [learning paths]
doc-persona: [kubewarden-user]
doc-type: [explanation]
doc-topic: [learning-paths]
---

|Page title|
|-|
|[What is the Audit Scanner?](../explanations/audit-scanner/audit-scanner)|
|[Audit Scanner - Limitations](../explanations/audit-scanner/limitations)|
|[Audit Scanner - Policy Reports](../explanations/audit-scanner/policy-reports)|
|[Using Pod Security Admission with Kubewarden](../howtos/pod-security-admission-with-kubewarden)|
|[PodSecurityPolicy migration](../howtos/psp-migration)|
|[Secure supply chain](../howtos/secure-supply-chain)|
|[Custom certificate authorities](../howtos/custom-certificate-authorities)|
|[ValidatingAdmissionPolicy migration](../howtos/vap-migration)|
|[Metrics reference](../reference/metrics-reference)|
|[Monitor mode](../reference/monitor-mode)|
|[Publish policies to Artifact Hub](../tutorials/publish-policy-to-artifact-hub)|
Empty file removed docs/learnpaths/operator.md
Empty file.
14 changes: 7 additions & 7 deletions docs/learnpaths/paths.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ If you are new to Kubewarden, these sections contain a set of learning paths for

|Persona|Description|
|-|-|
|[user](user.md)|Someone who takes a policy and uses it in a cluster. They run policies and observe results.|
|[operator](operator.md)|Someone operating Kubewarden in a cluster. Installs and maintains Kubewarden.|
|[integrator](integrator.md)|Builds with, using, or on top of KW. Perhaps a custom UI or a helper tool for generating policies.|
|[distributor](distributor.md)|Someone who has written a policy and wants to share it with others. They want the policy to be easily consumed by the “policy consumer” role. A distributor of Kubewarden policies, to places such as ArtifactHub.|
|[policy-developer](policy-developer.md)| A person designing policies for Kubewarden and specifying their configuration.|
|[developer](developer.md)|A person working on the Kubewarden product set. Building Kubewarden itself.|
|[all](all.md)|Documentation sections of common interest.|
|[user](kubewarden-user.md)|Someone who takes a policy and uses it in a cluster. They run policies and observe results.|
|[operator](kubewarden-operator.md)|Someone operating Kubewarden in a cluster. Installs and maintains Kubewarden.|
|[integrator](kubewarden-integrator.md)|Builds with, using, or on top of KW. Perhaps a custom UI or a helper tool for generating policies.|
|[distributor](kubewarden-distributor.md)|Someone who has written a policy and wants to share it with others. They want the policy to be easily consumed by the “policy consumer” role. A distributor of Kubewarden policies, to places such as ArtifactHub.|
|[policy-developer](kubewarden-policy-developer.md)| A person designing policies for Kubewarden and specifying their configuration.|
|[developer](kubewarden-developer.md)|A person working on the Kubewarden product set. Building Kubewarden itself.|
|[all](kubewarden-all.md)|Documentation sections of common interest.|
Empty file.
Empty file removed docs/learnpaths/user.md
Empty file.

0 comments on commit 39a75b9

Please sign in to comment.