From 27b511021739d8b3537a8d60805f8456d2cdad22 Mon Sep 17 00:00:00 2001 From: Carina Kothe Date: Thu, 9 Nov 2023 17:23:09 +0100 Subject: [PATCH] Add review comments --- docs/contributor/installation.md | 6 +++--- docs/user/01-manager.md | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/contributor/installation.md b/docs/contributor/installation.md index 058c8a9c..a9bd95eb 100644 --- a/docs/contributor/installation.md +++ b/docs/contributor/installation.md @@ -47,12 +47,12 @@ For information about the prerequisites, refer to [Development](./development.md make deploy IMG=$IMG ``` -6. To start the reconciliation process, apply the Eventing Custom Resource. +6. To start the reconciliation process, apply the Eventing custom resource (CR). This step depends on your desired backend: NATS or EventMesh. - **Backend: NATS** - For NATS Backend you can apply the default Custom Resource using the following command: + For NATS Backend you can apply the default CR using the following command: ```sh kubectl apply -f config/samples/default.yaml @@ -73,7 +73,7 @@ This step depends on your desired backend: NATS or EventMesh. - **Backend: EventMesh** - For EventMesh Backend you can apply the default Custom Resource using the following command: + For EventMesh Backend you can apply the default CR using the following command: ```sh kubectl apply -f config/samples/default_eventmesh.yaml diff --git a/docs/user/01-manager.md b/docs/user/01-manager.md index dd1621fe..6a6c3063 100644 --- a/docs/user/01-manager.md +++ b/docs/user/01-manager.md @@ -2,7 +2,7 @@ This module ships Eventing Manager. Once this module is enabled, it provides the functionality to send and receive events. -## Module Lifecycle +## Module lifecycle Upon starting Eventing Manager, the controller (following the [Kubebuilder concept](https://book.kubebuilder.io/architecture.html)) creates, watches, and reconciles the following resources: @@ -31,6 +31,6 @@ Eventing Manager supports switching between two different backends. [NATS](https For more information about the possible configuration of Eventing Manager using NATS or EventMesh backend, refer to the [backend configuration](02-configuration.md#reference). -## Removing the Module +## Removing the module The module cannot be removed as long as Subscription CRs exist. After the user cleans up all the subscriptions, the Eventing module can be removed. The module takes care of cleaning up all resources owned by it.