Apply Iwona's suggestions

kyma-project · Oct 23, 2024 · d1da290 · d1da290
1 parent 51fbb5f
commit d1da290
Show file tree

Hide file tree

Showing 12 changed files with 27 additions and 23 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -2,13 +2,13 @@
 
 ## Overview
 
-The `docs` folder contains three subfolders - `user`, `contributor` and `operator`.
+The `docs` folder contains three subfolders - `user`, `contributor` and `operator`*.
 
 The `user` subfolder contains the end-user documentation, which is displayed on the [Kyma website](https://kyma-project.io/#/) and in the SAP Help Portal. Depending on your module needs, the subfolder must include overview, usage, or technical reference documents. To display the content on the website properly, create a `_sidebar.md` file in the `user` subfolder and list the documents it contains there. For more information on how to publish user documentation, follow [this guide](https://github.com/kyma-project/community/blob/main/docs/guidelines/content-guidelines/01-user-docs.md).
 
 The `contributor` subfolder includes any developer-related documentation to help them manually install, develop, and operate a module.
 
-The `operator` subfolder is mandatory only if your module/component is delivered to restricted markets. The subfolder includes documentation relevant for the respective operators.
+* The `operator` subfolder is mandatory only if your module/component is delivered to restricted markets. The subfolder includes documentation relevant to the respective operators.
 
 To have a common structure across all modules, all documents must be properly numbered according to the following structure:
 

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 for 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
@@ -10,6 +10,6 @@
 
 ## Post-Installation Steps
 
-<!--Describe any post-installation steps that you might need, including the initial setup of your monitors. Setting up monitors should also be part of your operations topic. However, please include this information here as well (ideally you can create referable content).-->
+<!--Describe any post-installation steps that you might need, including the initial setup of your monitors. Setting up monitors should also be part of your operations topic. However, please include this information here as well.-->
 
-<!--For more information, see [Documentation Guidelines for Operator Documentation](https://wiki.one.int.sap/wiki/display/NDW/Documentation+Guidelines+for+Operator+Documentation)-->
+<!--For more information, see [Documentation Guidelines for Operator Documentation](https://wiki.one.int.sap/wiki/display/NDW/Documentation+Guidelines+for+Operator+Documentation#DocumentationGuidelinesforOperatorDocumentation-InstallationandUpdate)-->
diff --git a/docs/operator/cn/02-10-update.md b/docs/operator/cn/02-10-update.md
@@ -8,8 +8,8 @@
 
 <!--Describe the update steps in a logical sequence.-->
 
-## Post-Update Stapes
+## Post-Update Steps
 
 <!--Describe any post-update steps that you might need. If monitors need to be recreated after an update, add this information to the update structure of your service/component.-->
 
-<!--For more information, see [Documentation Guidelines for Operator Documentation](https://wiki.one.int.sap/wiki/display/NDW/Documentation+Guidelines+for+Operator+Documentation)-->
+<!--For more information, see [Documentation Guidelines for Operator Documentation](https://wiki.one.int.sap/wiki/display/NDW/Documentation+Guidelines+for+Operator+Documentation#DocumentationGuidelinesforOperatorDocumentation-InstallationandUpdate)-->
diff --git a/docs/operator/cn/03-10-operations.md b/docs/operator/cn/03-10-operations.md
@@ -1,3 +1,5 @@
 # {Component/Service Name} - Operations
 
-<!--For more information, see [Documentation Guidelines for Operator Documentation](https://wiki.one.int.sap/wiki/display/NDW/Documentation+Guidelines+for+Operator+Documentation)-->
+<!--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.-->
+
+<!--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/cn/04-10-troubleshooting.md b/docs/operator/cn/04-10-troubleshooting.md
@@ -1,8 +1,8 @@
 # {Component/Service Name} - Troubleshooting
 
 <!--
-- Use a problem-solution format, whereas a problem can be a statement or a question. \
-- If you have more than one solution, provide the recommended solution first. If you're not sure, add both.
--  Provide all recommended actions and introduce a connection to the alerts of your service, preferably the monitor name.-->
+- Use a problem-solution format, where a problem can be 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.-->
 
-<!--For more information, see [Documentation Guidelines for Operator Documentation](https://wiki.one.int.sap/wiki/display/NDW/Documentation+Guidelines+for+Operator+Documentation)-->
+<!--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/cn/README.md b/docs/operator/cn/README.md
@@ -1,4 +1,4 @@
-This folder includes documentation relevant for the China cloud operator. The documentation is published as part of the [SAP BTP, Partner-Managed Edition](https://help.sap.com/docs/CPOPS?state=DRAFT) official documentation in SAP Help Portal.
+This folder includes documentation relevant to the China cloud operator. The documentation is published as part of the [SAP BTP, Partner-Managed Edition](https://help.sap.com/docs/CPOPS?state=DRAFT) official documentation in the SAP Help Portal.
 
 The mandatory documentation types include:
 
@@ -7,4 +7,4 @@ The mandatory documentation types include:
 - Operations
 - Troubleshooting
 
-You will find the respective files for each of the documentation type in the template file structure.
+You will find the respective files for each documentation type in the template file structure.
diff --git a/docs/operator/ns2/01-10-installation.md b/docs/operator/ns2/01-10-installation.md
@@ -10,6 +10,6 @@
 
 ## Post-Installation Steps
 
-<!--Describe any post-installation steps that you might need, including the initial setup of your monitors. Setting up monitors should also be part of your operations topic. However, please include this information here as well (ideally you can create referable content).-->
+<!--Describe any post-installation steps that you might need, including the initial setup of your monitors. Setting up monitors should also be part of your operations topic. However, please include this information here as well.-->
 
-<!--For more information, see [Documentation Guidelines for Operator Documentation](https://wiki.one.int.sap/wiki/display/NDW/Documentation+Guidelines+for+Operator+Documentation)-->
+<!--For more information, see [Documentation Guidelines for Operator Documentation](https://wiki.one.int.sap/wiki/display/NDW/Documentation+Guidelines+for+Operator+Documentation#DocumentationGuidelinesforOperatorDocumentation-InstallationandUpdate)-->
diff --git a/docs/operator/ns2/02-10-update.md b/docs/operator/ns2/02-10-update.md
@@ -12,4 +12,4 @@
 
 <!--Describe any post-update steps that you might need. If monitors need to be recreated after an update, add this information to the update structure of your service/component.-->
 
-<!--For more information, see [Documentation Guidelines for Operator Documentation](https://wiki.one.int.sap/wiki/display/NDW/Documentation+Guidelines+for+Operator+Documentation)-->
+<!--For more information, see [Documentation Guidelines for Operator Documentation](https://wiki.one.int.sap/wiki/display/NDW/Documentation+Guidelines+for+Operator+Documentation#DocumentationGuidelinesforOperatorDocumentation-InstallationandUpdate)-->
diff --git a/docs/operator/ns2/03-10-operations.md b/docs/operator/ns2/03-10-operations.md
@@ -1,3 +1,5 @@
 # {Component/Service Name} - Operations
 
-<!--For more information, see [Documentation Guidelines for Operator Documentation](https://wiki.one.int.sap/wiki/display/NDW/Documentation+Guidelines+for+Operator+Documentation)-->
+<!--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.-->
+
+<!--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
@@ -1,8 +1,8 @@
 # {Component/Service Name} - Troubleshooting
 
 <!--
-- Use a problem-solution format, whereas a problem can be a statement or a question. \
-- If you have more than one solution, provide the recommended solution first. If you're not sure, add both.
+- 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.-->
 
-<!--For more information, see [Documentation Guidelines for Operator Documentation](https://wiki.one.int.sap/wiki/display/NDW/Documentation+Guidelines+for+Operator+Documentation)-->
+<!--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 SAP Help Portal.
+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
 
 The mandatory documentation types include:
 
@@ -7,4 +7,4 @@ The mandatory documentation types include:
 - Operations
 - Troubleshooting
 
-You will find the respective files for each of the documentation type in the template file structure.
+You will find the respective files for each documentation type in the template file structure.