docs: Apply the flexible alerts plugin to Eventing docs (#485)

kyma-project · Feb 14, 2024 · 953ab14 · 953ab14
1 parent 6c5567f
commit 953ab14
Show file tree

Hide file tree

Showing 7 changed files with 26 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -15,7 +15,8 @@ This project is scaffolded using [Kubebuilder](https://book.kubebuilder.io), and
 ## Get Started
 
 You need a Kubernetes cluster to run against. You can use [k3d](https://k3d.io/) to get a local cluster for testing, or run against a remote cluster.
-> **Note:** Your controller automatically uses the current context in your kubeconfig file, that is, whatever cluster `kubectl cluster-info` shows.
+> [!NOTE]
+> Your controller automatically uses the current context in your kubeconfig file, that is, whatever cluster `kubectl cluster-info` shows.
 
 ## Install
 
@@ -57,7 +58,8 @@ You need a Kubernetes cluster to run against. You can use [k3d](https://k3d.io/)
    make run
    ```
 
-> **NOTE:** You can also run this in one step with the command: `make install run`.
+> [!NOTE]
+> You can also run this in one step with the command: `make install run`.
 
 ### Run Tests
 
@@ -85,7 +87,8 @@ If you are editing the API definitions, generate the manifests such as CRs or CR
 make manifests
 ```
 
-> **NOTE:** Run `make --help` for more information on all potential `make` targets.
+> [!NOTE]
+> Run `make --help` for more information on all potential `make` targets.
 
 For more information, see the [Kubebuilder documentation](https://book.kubebuilder.io/introduction.html).
 
@@ -106,7 +109,8 @@ make docker-buildx IMG=<container-registry>/eventing-manager:<tag>
 ## Deployment
 
 You need a Kubernetes cluster to run against. You can use [k3d](https://k3d.io/) to get a local cluster for testing, or run against a remote cluster.
-> **Note:** Your controller automatically uses the current context in your kubeconfig file, that is, whatever cluster `kubectl cluster-info` shows.
+> [!NOTE]
+> Your controller automatically uses the current context in your kubeconfig file, that is, whatever cluster `kubectl cluster-info` shows.
 
 ### Deploy on the Cluster
 

diff --git a/docs/user/resources/evnt-cr-subscription.md b/docs/user/resources/evnt-cr-subscription.md
@@ -9,8 +9,8 @@ The `subscriptions.eventing.kyma-project.io` CustomResourceDefinition (CRD) is a
 This sample Subscription custom resource (CR) subscribes to an event called `order.created.v1`.
 
 > **WARNING:** Prohibited characters in event names under the **spec.types** property, are not supported in some backends. If any are detected, Eventing will remove them. Read [Event names](../evnt-event-names.md#event-name-cleanup) for more information.
-
-> **NOTE:** Both the subscriber and the Subscription should exist in the same namespace.
+> [!NOTE]
+> Both, the subscriber and the Subscription, should exist in the same namespace.
 
 ```yaml
 apiVersion: eventing.kyma-project.io/v1alpha2

diff --git a/docs/user/troubleshooting/evnt-04-free-jetstream-storage.md b/docs/user/troubleshooting/evnt-04-free-jetstream-storage.md
@@ -17,7 +17,8 @@ This retention policy keeps messages in the stream if they can't be delivered to
 If there are too many undelivered events, the NATS JetStream storage may get full.
 To prevent event loss, the backend stops receiving events, and no further events can be persisted to the stream.
 
-> **NOTE:** If you delete a Subscriber (sink) while there is still a Kyma Subscription pointing to that sink, the events published to that Subscription pile up in the stream and possibly delay the event delivery to other Subscribers.
+> [!NOTE]
+> If you delete a Subscriber (sink) while there is still a Kyma Subscription pointing to that sink, the events published to that Subscription pile up in the stream and possibly delay the event delivery to other Subscribers.
 
 ## Remedy
 

diff --git a/docs/user/tutorials/evnt-02-subs-with-multiple-filters.md b/docs/user/tutorials/evnt-02-subs-with-multiple-filters.md
@@ -4,7 +4,8 @@ The [Subscription](../resources/evnt-cr-subscription.md) CustomResourceDefinitio
 
 ## Prerequisites
 
->**NOTE:** Read about the [Purpose and Benefits of Istio Sidecars](https://kyma-project.io/#/istio/user/00-30-overview-istio-sidecars). Then, check how to [Enable Automatic Istio Sidecar Proxy Injection](https://kyma-project.io/#/istio/user/operation-guides/02-20-enable-sidecar-injection). For more details, see [Default Istio Setup](https://kyma-project.io/#/istio/user/00-40-overview-istio-setup) in Kyma.
+> [!NOTE]
+> Read about the [Purpose and Benefits of Istio Sidecars](https://kyma-project.io/#/istio/user/00-30-overview-istio-sidecars). Then, check how to [Enable Automatic Istio Sidecar Proxy Injection](https://kyma-project.io/#/istio/user/operation-guides/02-20-enable-sidecar-injection). For more details, see [Default Istio Setup](https://kyma-project.io/#/istio/user/00-40-overview-istio-setup) in Kyma.
 
 1. Follow the [Prerequisites steps](evnt-01-prerequisites.md) for the Eventing tutorials.
 2. [Create and Modify an Inline Function](https://kyma-project.io/#/serverless-manager/user/tutorials/01-10-create-inline-function).

diff --git a/docs/user/tutorials/evnt-03-type-cleanup.md b/docs/user/tutorials/evnt-03-type-cleanup.md
@@ -5,7 +5,8 @@ You learn how Eventing behaves when you create a [Subscription](../resources/evn
 
 ## Prerequisites
 
->**NOTE:** Read about the [Purpose and Benefits of Istio Sidecars](https://kyma-project.io/#/istio/user/00-30-overview-istio-sidecars). Then, check how to [Enable Automatic Istio Sidecar Proxy Injection](https://kyma-project.io/#/istio/user/operation-guides/02-20-enable-sidecar-injection). For more details, see [Default Istio Setup](https://kyma-project.io/#/istio/user/00-40-overview-istio-setup) in Kyma.
+> [!NOTE]
+> Read about the [Purpose and Benefits of Istio Sidecars](https://kyma-project.io/#/istio/user/00-30-overview-istio-sidecars). Then, check how to [Enable Automatic Istio Sidecar Proxy Injection](https://kyma-project.io/#/istio/user/operation-guides/02-20-enable-sidecar-injection). For more details, see [Default Istio Setup](https://kyma-project.io/#/istio/user/00-40-overview-istio-setup) in Kyma.
 
 1. Follow the [Prerequisites steps](evnt-01-prerequisites.md) for the Eventing tutorials.
 2. [Create and Modify an Inline Function](https://kyma-project.io/#/serverless-manager/user/tutorials/01-10-create-inline-function).
@@ -193,4 +194,5 @@ Note that the `Event Type` of the received event is not the same as defined in t
 
 You see that Kyma Eventing modifies the event names to filter out prohibited characters to conform to Cloud Event specifications. 
 
-> **CAUTION:** This cleanup modification is abstract; you can still publish and subscribe to the original Event names. However, in some cases, it can lead to a naming collision as explained in [Event names](../evnt-event-names.md).
+> [!WARNING]
+> This cleanup modification is abstract; you can still publish and subscribe to the original Event names. However, in some cases, it can lead to a naming collision as explained in [Event names](../evnt-event-names.md).
diff --git a/docs/user/tutorials/evnt-04-change-max-in-flight-in-sub.md b/docs/user/tutorials/evnt-04-change-max-in-flight-in-sub.md
@@ -5,7 +5,8 @@ The "in-flight messages" config defines the number of events that Kyma Eventing
 
 ## Prerequisites
 
->**NOTE:** Read about the [Purpose and Benefits of Istio Sidecars](https://kyma-project.io/#/istio/user/00-30-overview-istio-sidecars). Then, check how to [Enable Automatic Istio Sidecar Proxy Injection](https://kyma-project.io/#/istio/user/operation-guides/02-20-enable-sidecar-injection). For more details, see [Default Istio Setup](https://kyma-project.io/#/istio/user/00-40-overview-istio-setup) in Kyma.
+> [!NOTE]
+> Read about the [Purpose and Benefits of Istio Sidecars](https://kyma-project.io/#/istio/user/00-30-overview-istio-sidecars). Then, check how to [Enable Automatic Istio Sidecar Proxy Injection](https://kyma-project.io/#/istio/user/operation-guides/02-20-enable-sidecar-injection). For more details, see [Default Istio Setup](https://kyma-project.io/#/istio/user/00-40-overview-istio-setup) in Kyma.
 
 1. Follow the [Prerequisites steps](evnt-01-prerequisites.md) for the Eventing tutorials.
 2. [Create and Modify an Inline Function](https://kyma-project.io/#/serverless-manager/user/tutorials/01-10-create-inline-function).

diff --git a/docs/user/tutorials/evnt-05-send-legacy-events.md b/docs/user/tutorials/evnt-05-send-legacy-events.md
@@ -2,11 +2,13 @@
 
 Kyma Eventing also supports sending and receiving of legacy events. In this tutorial we will show how to send legacy events.
 
-> **NOTE:** It is recommended to use [CloudEvents specification](https://cloudevents.io/) for sending and receiving events in Kyma.
+> [!NOTE]
+> It is recommended to use [CloudEvents specification](https://cloudevents.io/) for sending and receiving events in Kyma.
 
 ## Prerequisites
 
->**NOTE:** Read about the [Purpose and Benefits of Istio Sidecars](https://kyma-project.io/#/istio/user/00-30-overview-istio-sidecars). Then, check how to [Enable Automatic Istio Sidecar Proxy Injection](https://kyma-project.io/#/istio/user/operation-guides/02-20-enable-sidecar-injection). For more details, see [Default Istio Setup](https://kyma-project.io/#/istio/user/00-40-overview-istio-setup) in Kyma.
+> [!NOTE]
+> Read about the [Purpose and Benefits of Istio Sidecars](https://kyma-project.io/#/istio/user/00-30-overview-istio-sidecars). Then, check how to [Enable Automatic Istio Sidecar Proxy Injection](https://kyma-project.io/#/istio/user/operation-guides/02-20-enable-sidecar-injection). For more details, see [Default Istio Setup](https://kyma-project.io/#/istio/user/00-40-overview-istio-setup) in Kyma.
 
 1. Follow the [Prerequisites steps](evnt-01-prerequisites.md) for the Eventing tutorials.
 2. [Create and Modify an Inline Function](https://kyma-project.io/#/serverless-manager/user/tutorials/01-10-create-inline-function).
@@ -87,7 +89,8 @@ You created the `lastorder` Function, and subscribed to the `order.received.v1`
        http://localhost:3000/myapp/v1/events
    ```
 
-   > **NOTE:** If you want to use a Function to publish a CloudEvent, see the [Event object SDK specification](https://kyma-project.io/#/serverless-manager/user/technical-reference/07-70-function-specification?id=event-object-sdk).
+> [!NOTE]
+> If you want to use a Function to publish a CloudEvent, see the [Event object SDK specification](https://kyma-project.io/#/serverless-manager/user/technical-reference/07-70-function-specification?id=event-object-sdk).
 
 ## Publish Legacy Events