Intelligent Situation Automation has been one of the early adopters of the Open Documentation Initiative. Through this initiative, our Administration Guide is now open for your comments, suggestions, or any new ideas that can improve your overall user experience. Collaborate directly with our developer colleagues and help us improve this document.
How does this work?
It's simple. You propose your changes via a pull request. Our development team reviews your suggested edits. If your suggestions are valid, the document is updated. That's it!
You can also raise an issue with your feedback, and our team will get back to you after reviewing the details.
It might also be that our developers have further questions or require clarifications. We will communicate through the same channel and continue to collaborate till a consensus is reached.
A couple of things to consider before you start collaborating with us:
Get to know more about our Contribution Guidelines. For any questions, raise an issue within the guidelines itself.
Let's take a closer look at each of these steps in detail.
You can submit your suggested edits directly in the document.
Let's say you're reading our Administration Guide on the SAP Help Portal and spot an error, or spot any omission, you can directly provide your proposed edits via a pull request in GitHub. To do this, select the Edit page option from the Feedback dropdown on the SAP Help Portal.
The same page you were reading opens in GitHub. Use the pencil icon to make the content editable.
Make your changes in the markdown file and choose Commit changes. If you are not familiar with markdown language, you can check out some basic writing and formatting syntax used in GitHub.
You can provide some additional information describing your reason for suggesting the changes and choose Propose changes. This will help our team to make an informed decision about the update.
You can report an issue in the document.
If you have a general issue to report about the document, you can do so by selecting the Create issue option from the Feedback dropdown on the SAP Help Portal. This could be any change that you think might add value for our product users.
Provide a title and a description for your issue and choose Submit new issue. You can also use the Feedback Type dropdown to classify the type of issue, for example, clarity, content gaps, and so on. The more information you provide, the easier it will be for us to review your issue and come up with the correct resolution.
What happens next?
Once you submit your proposed changes via pull request or submit a new issue, our team will carefully review them and inform you about any updates.
Give it a try!
So, what do you think of our feedback feature? Give it a try and let us know about your experience. If you have any questions about the procedure, please feel free to drop a few lines in the comment section below.
As a token of appreciation for your contribution, you will receive a badge on your SAP community profile.