Apply review suggestions

kyma-project · Oct 24, 2024 · edcefba · edcefba
1 parent 3b1fc2b
commit edcefba
Show file tree

Hide file tree

Showing 7 changed files with 35 additions and 7 deletions.
diff --git a/docs/operator/README.md b/docs/operator/README.md
@@ -1 +1 @@
-This folder is mandatory only if your module/component is delivered to restricted markets.It includes documentation relevant to the respective operators.
+This folder is mandatory only if your module/component is delivered to restricted markets. It includes documentation relevant to the respective operators.
diff --git a/docs/operator/cn/01-10-installation.md b/docs/operator/cn/01-10-installation.md
@@ -2,7 +2,9 @@
 
 ## Prerequisites
 
-<!--Describe the prerequisites for installing your service (if there are some).-->
+<!--Describe the prerequisites for installing your service (if there are some). For example:
+- List the components that your component depends on
+- List the BTP integrations used by your component-->
 
 ## Procedure
 

diff --git a/docs/operator/cn/03-10-operations.md b/docs/operator/cn/03-10-operations.md
@@ -1,5 +1,17 @@
 # {Component/Service Name} - Operations
 
-<!--Please create only one single document for your Operations documentation. Our goal is to display all Operations content for a service on a single page so that the operators can quickly search for information using the search function.-->
+<!--Please create only one single document with multiple sections for your Operations documentation. Our goal is to display all Operations content for a service on a single page so that the operators can quickly search for information using the search function.-->
+
+<!--Recommended sections:
+
+## REST API {if applicable}
+
+## Custom Resources
+
+In this section, describe:
+- The component's CRs and their purpose
+- CRs' backup requirements (Is it regenerated or does it require backup?)
+- CRs' mechanics
+- CRs' labels and annotations -->
 
 <!--For more information, see [Documentation Guidelines for Operator Documentation](https://wiki.one.int.sap/wiki/display/NDW/Documentation+Guidelines+for+Operator+Documentation#DocumentationGuidelinesforOperatorDocumentation-OperationsDocumentation)-->
diff --git a/docs/operator/ns2/01-10-installation.md b/docs/operator/ns2/01-10-installation.md
@@ -2,7 +2,9 @@
 
 ## Prerequisites
 
-<!--Describe the prerequisites for installing your service (if there are some).-->
+<!--Describe the prerequisites for installing your service (if there are some). For example:
+- List the components that your component depends on
+- List the BTP integrations used by your component-->
 
 ## Procedure
 

diff --git a/docs/operator/ns2/03-10-operations.md b/docs/operator/ns2/03-10-operations.md
@@ -1,5 +1,17 @@
 # {Component/Service Name} - Operations
 
-<!--Please create only one single document for your Operations documentation. Our goal is to display all Operations content for a service on a single page so that the operators can quickly search for information using the search function.-->
+<!--Please create only one single document with multiple sections for your Operations documentation. Our goal is to display all Operations content for a service on a single page so that the operators can quickly search for information using the search function.-->
+
+<!--Recommended sections:
+
+## REST API {if applicable}
+
+## Custom Resources
+
+In this section, describe:
+- The component's CRs and their purpose
+- CRs' backup requirements (Is it regenerated or does it require backup?)
+- CRs' mechanics
+- CRs' labels and annotations -->
 
 <!--For more information, see [Documentation Guidelines for Operator Documentation](https://wiki.one.int.sap/wiki/display/NDW/Documentation+Guidelines+for+Operator+Documentation#DocumentationGuidelinesforOperatorDocumentation-OperationsDocumentation)-->
diff --git a/docs/operator/ns2/04-10-troubleshooting.md b/docs/operator/ns2/04-10-troubleshooting.md
@@ -3,6 +3,6 @@
 <!--
 - Use a problem-solution format, where a problem can be presented as a statement or a question.
 - If you have multiple solutions, provide the recommended solution first.
--  Provide all recommended actions and introduce a connection to the alerts of your service, preferably the monitor name.-->
+- Provide all recommended actions and introduce a connection to the alerts of your service, preferably the monitor name.-->
 
 <!--For more information, see [Documentation Guidelines for Troubleshooting Documentation](https://wiki.one.int.sap/wiki/display/NDW/Documentation+Guidelines+for+Operator+Documentation#DocumentationGuidelinesforOperatorDocumentation-TroubleshootingDocumentation)-->
diff --git a/docs/operator/ns2/README.md b/docs/operator/ns2/README.md
@@ -1,4 +1,4 @@
-This folder includes documentation relevant for the NS2 operator. The documentation is published as part of the [SAP BTP, Partner-Managed Edition (AWS GovCloud)](https://help.sap.com/docs/OPSAWS?state=DRAFT) official documentation in the SAP Help Portal
+This folder includes documentation relevant to the NS2 operator. The documentation is published as part of the [SAP BTP, Partner-Managed Edition (AWS GovCloud)](https://help.sap.com/docs/OPSAWS?state=DRAFT) official documentation in the SAP Help Portal
 
 The mandatory documentation types include:
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		This folder is mandatory only if your module/component is delivered to restricted markets.It includes documentation relevant to the respective operators.
		This folder is mandatory only if your module/component is delivered to restricted markets. It includes documentation relevant to the respective operators.