-
Notifications
You must be signed in to change notification settings - Fork 7
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add the operator folder to the template #44
Changes from 12 commits
9832fba
51fbb5f
d1da290
a581db2
13cc514
10eb89c
0e51c69
c09424f
91dfb49
3b1fc2b
edcefba
ef972c2
a7fdd92
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
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 to the respective operators. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# Installing {Component Name} | ||
|
||
## Prerequisites | ||
|
||
<!--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 | ||
|
||
<!--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.--> | ||
|
||
<!--For more information, see [Documentation Guidelines for Operator Documentation](https://wiki.one.int.sap/wiki/display/NDW/Documentation+Guidelines+for+Operator+Documentation#DocumentationGuidelinesforOperatorDocumentation-InstallationandUpdate)--> |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# Updating {Component Name} | ||
|
||
## Prerequisites | ||
|
||
<!--Describe the prerequisites for updating your service (if there are some).--> | ||
|
||
## What's Changed {OPTIONAL} | ||
|
||
<!--In this optional section, describe significat changes since the last minor or major release. For example: | ||
- Operation changes | ||
- New functionalities | ||
- Deprecated functionalities | ||
- Configuration changes | ||
- Updating pitfalls--> | ||
|
||
## Procedure | ||
|
||
<!--Describe the update steps in a logical sequence.--> | ||
|
||
## 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#DocumentationGuidelinesforOperatorDocumentation-InstallationandUpdate)--> |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# {Component/Service Name} - Operations | ||
|
||
<!--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: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. One more section came to my mind we need to add here: Metrics Each module and component needs to document the followings:
Separately for alerting, if some important conditions are represented by a combination of metrics, then these should also be listed as suggested alerts, along with threshold mechanics. |
||
## Configuration | ||
|
||
Desribe Helm charts parameters and configuration values used during installation. | ||
|
||
Provide details on any injected configuration that the component expects. For example, ConfigMaps and/or Secrets. | ||
|
||
## 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)--> |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +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.--> | ||
|
||
<!--For more information, see [Documentation Guidelines for Troubleshooting Documentation](https://wiki.one.int.sap/wiki/display/NDW/Documentation+Guidelines+for+Operator+Documentation#DocumentationGuidelinesforOperatorDocumentation-TroubleshootingDocumentation)--> |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
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: | ||
|
||
- Installation | ||
- Update | ||
- Operations | ||
- Troubleshooting | ||
|
||
You will find the respective files for each documentation type in the template file structure. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# Installing {Component Name} | ||
|
||
## Prerequisites | ||
|
||
<!--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 | ||
|
||
<!--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.--> | ||
|
||
<!--For more information, see [Documentation Guidelines for Operator Documentation](https://wiki.one.int.sap/wiki/display/NDW/Documentation+Guidelines+for+Operator+Documentation#DocumentationGuidelinesforOperatorDocumentation-InstallationandUpdate)--> |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# Updating {Component Name} | ||
|
||
## Prerequisites | ||
|
||
<!--Describe the prerequisites for updating your service (if there are some).--> | ||
|
||
## What's Changed {OPTIONAL} | ||
|
||
<!--In this optional section, describe significat changes since the last minor or major release. For example: | ||
- Operation changes | ||
- New functionalities | ||
- Deprecated functionalities | ||
- Configuration changes | ||
- Updating pitfalls--> | ||
|
||
## Procedure | ||
|
||
<!--Describe the update steps in a logical sequence.--> | ||
|
||
## 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#DocumentationGuidelinesforOperatorDocumentation-InstallationandUpdate)--> |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# {Component/Service Name} - Operations | ||
|
||
<!--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: | ||
## Configuration | ||
|
||
Desribe Helm charts parameters and configuration values used during installation. | ||
|
||
Provide details on any injected configuration that the component expects. For example, ConfigMaps and/or Secrets. | ||
|
||
## 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)--> |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# {Component/Service Name} - Troubleshooting | ||
|
||
<!-- | ||
- 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 Troubleshooting Documentation](https://wiki.one.int.sap/wiki/display/NDW/Documentation+Guidelines+for+Operator+Documentation#DocumentationGuidelinesforOperatorDocumentation-TroubleshootingDocumentation)--> |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
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: | ||
|
||
- Installation | ||
- Update | ||
- Operations | ||
- Troubleshooting | ||
|
||
You will find the respective files for each documentation type in the template file structure. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should have a section for significant changes since the last release, depending on the release type. For patch updates, nothing is expected. For minor or major releases breaking changes are expected to be explained here.
This includes, but not limited to:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I understood it differently. For me, this document is about the update procedure that is more or less stable. It includes the steps to update the component. What you are describing sounds more like a changelog or a release note. We can re-confirm with Aneta. BTW, Aneta, do we also provide what's new notes for the partner-managed edition?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Aneta confirmed that "it's actually both the stable steps but also the specific for the concrete version update. As an example, you can have a look at the BAS update documentation:
https://help.sap.com/docs/OPSAWS/a57e20d1d0124a5db7cf6b68a4b60c06/51a431e8a20841e5a3c258bda526ac10.html?state=DRAFT". Also, in addition, we probably will also publish What's New.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I proposed a section called "What's Changed". PTAL.