Improve for Code Review Comments

kyma-project · Feb 15, 2024 · aee0a29 · aee0a29
1 parent 232c19a
commit aee0a29
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/api/operator/v1alpha1/eventing_types.go b/api/operator/v1alpha1/eventing_types.go
@@ -107,7 +107,7 @@ type EventingStatus struct {
 	BackendConfigHash int64       `json:"specHash"`
 	// Can have one of the following values: Ready, Error, Processing, Warning. Ready state is set
 	// when all the resources are deployed successfully and backend is connected.
-	// It gets Warning state in case backend is not specified, NATS module is not installed or EventMesh secret is missing in the cluster.
+	// It gets Warning state in case backend is not specified, NATS module is not installed, or EventMesh secret is missing in the cluster.
 	// Error state is set when there is an error. Processing state is set if recources are being created or changed.
 	State            string              `json:"state"`
 	PublisherService string              `json:"publisherService,omitempty"`

diff --git a/docs/user/02-configuration.md b/docs/user/02-configuration.md
@@ -78,7 +78,12 @@ Use the following sample CRs as guidance. Each can be applied immediately when y
 <!-- TABLE-END -->
 
 <h3>More Details about Eventing CR state</h3>
-In the table below there is more information about the overall state of the Eventing CR. The <b>State</b> column has the overall state of the Eventing CR. The <b>Backend Config</b> column is part of the eventing CR that is either available or mistakenly not specified by a user. The <b>Backend State</b> column describes the state of the NATS backend or EventMesh secret existence. As indicated in the table, warnings are set in all cases where user action is required, e.g. the user needs to install the NATS module or create an EventMesh secret.
+The following table provides more details on the overall state of the Eventing CR:
+- The <b>State</b> column has the overall state of the Eventing CR.
+- The <b>Backend Config</b> column is part of the eventing CR that is either available or mistakenly not specified by a user.
+- The <b>Backend State</b> column describes the state of the NATS backend or EventMesh Secret existence. 
+
+Warnings indicate that user action is required, that is, the user must install the NATS module or create an EventMesh Secret.
 
 | Backend Config | Backend State         | State |
 |---------------------------|---------------------------|----------------|