-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add the operator folder to the template
- Loading branch information
Showing
12 changed files
with
110 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
This folder is mandatory only if your module/component is delivered to restricted markets.It includes documentation relevant for the respective operators. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# Installing {Component Name} | ||
|
||
## Prerequisites | ||
|
||
<!--Describe the prerequisites for installing your service (if there are some).--> | ||
|
||
## Procedure | ||
|
||
<!--Describe the installation steps in a logical sequence.--> | ||
|
||
## 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).--> | ||
|
||
<!--For more information, see [Documentation Guidelines for Operator Documentation](https://wiki.one.int.sap/wiki/display/NDW/Documentation+Guidelines+for+Operator+Documentation)--> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# Updating {Component Name} | ||
|
||
# Prerequisites | ||
|
||
<!--Describe the prerequisites for updating your service (if there are some).--> | ||
|
||
## Procedure | ||
|
||
<!--Describe the update steps in a logical sequence.--> | ||
|
||
## Post-Update Stapes | ||
|
||
<!--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)--> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# {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)--> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +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.--> | ||
|
||
<!--For more information, see [Documentation Guidelines for Operator Documentation](https://wiki.one.int.sap/wiki/display/NDW/Documentation+Guidelines+for+Operator+Documentation)--> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
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. | ||
|
||
The mandatory documentation types include: | ||
|
||
- Installation | ||
- Update | ||
- Operations | ||
- Troubleshooting | ||
|
||
You will find the respective files for each of the documentation type in the template file structure. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# Installing {Component Name} | ||
|
||
## Prerequisites | ||
|
||
<!--Describe the prerequisites for installing your service (if there are some).--> | ||
|
||
## Procedure | ||
|
||
<!--Describe the installation steps in a logical sequence.--> | ||
|
||
## 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).--> | ||
|
||
<!--For more information, see [Documentation Guidelines for Operator Documentation](https://wiki.one.int.sap/wiki/display/NDW/Documentation+Guidelines+for+Operator+Documentation)--> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# Updating {Component Name} | ||
|
||
# Prerequisites | ||
|
||
<!--Describe the prerequisites for updating your service (if there are some).--> | ||
|
||
## Procedure | ||
|
||
<!--Describe the update steps in a logical sequence.--> | ||
|
||
## Post-Update Stapes | ||
|
||
<!--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)--> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# {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)--> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +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.--> | ||
|
||
<!--For more information, see [Documentation Guidelines for Operator Documentation](https://wiki.one.int.sap/wiki/display/NDW/Documentation+Guidelines+for+Operator+Documentation)--> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
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. | ||
|
||
The mandatory documentation types include: | ||
|
||
- Installation | ||
- Update | ||
- Operations | ||
- Troubleshooting | ||
|
||
You will find the respective files for each of the documentation type in the template file structure. |