diff --git a/docs/README.md b/docs/README.md index a3b3fec..2dd7b4c 100644 --- 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 index ae0a1a7..35cd335 100644 --- 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. \ No newline at end of file +This folder is mandatory only if your module/component is delivered to restricted markets.It includes documentation relevant to the respective operators. \ No newline at end of file diff --git a/docs/operator/cn/01-10-installation.md b/docs/operator/cn/01-10-installation.md index 026a832..fa8d5ae 100644 --- a/docs/operator/cn/01-10-installation.md +++ b/docs/operator/cn/01-10-installation.md @@ -10,6 +10,6 @@ ## Post-Installation Steps - + - \ No newline at end of file + \ No newline at end of file diff --git a/docs/operator/cn/02-10-update.md b/docs/operator/cn/02-10-update.md index a3abcf0..c6c71cf 100644 --- a/docs/operator/cn/02-10-update.md +++ b/docs/operator/cn/02-10-update.md @@ -8,8 +8,8 @@ -## Post-Update Stapes +## Post-Update Steps - \ No newline at end of file + diff --git a/docs/operator/cn/03-10-operations.md b/docs/operator/cn/03-10-operations.md index 931e2bf..4dca380 100644 --- a/docs/operator/cn/03-10-operations.md +++ b/docs/operator/cn/03-10-operations.md @@ -1,3 +1,5 @@ # {Component/Service Name} - Operations - \ No newline at end of file + + + \ No newline at end of file diff --git a/docs/operator/cn/04-10-troubleshooting.md b/docs/operator/cn/04-10-troubleshooting.md index 387a056..0ef71f5 100644 --- 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, 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.--> - + diff --git a/docs/operator/cn/README.md b/docs/operator/cn/README.md index c0ee109..086fca7 100644 --- 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 index 026a832..fa8d5ae 100644 --- a/docs/operator/ns2/01-10-installation.md +++ b/docs/operator/ns2/01-10-installation.md @@ -10,6 +10,6 @@ ## Post-Installation Steps - + - \ No newline at end of file + \ No newline at end of file diff --git a/docs/operator/ns2/02-10-update.md b/docs/operator/ns2/02-10-update.md index a3abcf0..50835d9 100644 --- a/docs/operator/ns2/02-10-update.md +++ b/docs/operator/ns2/02-10-update.md @@ -12,4 +12,4 @@ - \ No newline at end of file + \ No newline at end of file diff --git a/docs/operator/ns2/03-10-operations.md b/docs/operator/ns2/03-10-operations.md index 931e2bf..4dca380 100644 --- a/docs/operator/ns2/03-10-operations.md +++ b/docs/operator/ns2/03-10-operations.md @@ -1,3 +1,5 @@ # {Component/Service Name} - Operations - \ No newline at end of file + + + \ No newline at end of file diff --git a/docs/operator/ns2/04-10-troubleshooting.md b/docs/operator/ns2/04-10-troubleshooting.md index 387a056..f32d418 100644 --- a/docs/operator/ns2/04-10-troubleshooting.md +++ b/docs/operator/ns2/04-10-troubleshooting.md @@ -1,8 +1,8 @@ # {Component/Service Name} - Troubleshooting - + diff --git a/docs/operator/ns2/README.md b/docs/operator/ns2/README.md index f08294f..43b8aec 100644 --- 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.