From 55b4e7ddd59348067b6cef89619cf6f19eb48f46 Mon Sep 17 00:00:00 2001 From: Maciej Szulik Date: Tue, 3 Dec 2024 19:14:02 +0100 Subject: [PATCH] chore: fix all actions links (#1499) ## Description Fix all links to actions docs. ## Related Issue None ## Type of change - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [x] Other (security config, docs update, etc) ## Checklist before merging - [x] Unit, [Journey](https://github.com/defenseunicorns/pepr/tree/main/journey), [E2E Tests](https://github.com/defenseunicorns/pepr-excellent-examples), [docs](https://github.com/defenseunicorns/pepr/tree/main/docs), [adr](https://github.com/defenseunicorns/pepr/tree/main/adr) added or updated as needed - [x] [Contributor Guide Steps](https://docs.pepr.dev/main/contribute/#submitting-a-pull-request) followed Signed-off-by: Maciej Szulik --- README.md | 2 +- docs/030_user-guide/040_capabilities.md | 2 +- docs/030_user-guide/README.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 59650ebd8..31ab1ec00 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ Pepr is on a mission to save Kubernetes from the tyranny of YAML, intimidating g ## Example Pepr Action -This quick sample shows how to react to a ConfigMap being created or updated in the cluster. It adds a label and annotation to the ConfigMap and adds some data to the ConfigMap. It also creates a Validating Webhook to make sure the "pepr" label still exists. Finally, after the ConfigMap is created, it logs a message to the Pepr controller and creates or updates a separate ConfigMap with the [kubernetes-fluent-client](https://github.com/defenseunicorns/kubernetes-fluent-client) using server-side apply. For more details see [actions](./docs/030_user-guide/030_actions.md) section. +This quick sample shows how to react to a ConfigMap being created or updated in the cluster. It adds a label and annotation to the ConfigMap and adds some data to the ConfigMap. It also creates a Validating Webhook to make sure the "pepr" label still exists. Finally, after the ConfigMap is created, it logs a message to the Pepr controller and creates or updates a separate ConfigMap with the [kubernetes-fluent-client](https://github.com/defenseunicorns/kubernetes-fluent-client) using server-side apply. For more details see [actions](./docs/030_user-guide/030_actions/) section. ```ts When(a.ConfigMap) diff --git a/docs/030_user-guide/040_capabilities.md b/docs/030_user-guide/040_capabilities.md index 3ccaccafa..b378bb54d 100644 --- a/docs/030_user-guide/040_capabilities.md +++ b/docs/030_user-guide/040_capabilities.md @@ -1,6 +1,6 @@ # Pepr Capabilities -A capability is set of related [actions](./030_actions.md) that work together to achieve a specific transformation or operation on Kubernetes resources. Capabilities are user-defined and can include one or more actions. They are defined within a Pepr module and can be used in both MutatingWebhookConfigurations and ValidatingWebhookConfigurations. A Capability can have a specific scope, such as mutating or validating, and can be reused in multiple Pepr modules. +A capability is set of related [actions](./030_actions/) that work together to achieve a specific transformation or operation on Kubernetes resources. Capabilities are user-defined and can include one or more actions. They are defined within a Pepr module and can be used in both MutatingWebhookConfigurations and ValidatingWebhookConfigurations. A Capability can have a specific scope, such as mutating or validating, and can be reused in multiple Pepr modules. When you [`npx pepr init`](./010_pepr-cli.md#pepr-init), a `capabilities` directory is created for you. This directory is where you will define your capabilities. You can create as many capabilities as you need, and each capability can contain one or more actions. Pepr also automatically creates a `HelloPepr` capability with a number of example actions to help you get started. diff --git a/docs/030_user-guide/README.md b/docs/030_user-guide/README.md index 93ce27d8a..d4fd17297 100644 --- a/docs/030_user-guide/README.md +++ b/docs/030_user-guide/README.md @@ -10,7 +10,7 @@ You can find the following information in this section: ### [Pepr Modules](020_pepr-modules.md) -### [Pepr Actions](030_actions.md) +### [Pepr Actions](030_actions/) ### [Pepr Capabilities](040_capabilities.md)