Throughout the years, I've witnessed a positive shift within SAP towards greater openness, particularly in the adoption of collaborative platforms like GitHub.
SAP Fiori tools has been on this journey for some time, and we are now making the documentation for SAP Fiori tools open source. This means you can provide feedback and contribute your own content to the official
SAP Fiori tools documentation on the SAP Help Portal.
Our documentation on the SAP Help Portal serves as a vital intersection where SAP engages with end users and developers from customers and partners. If you come across documentation that is not as clear as you would expect, please send us your feedback and initiate a conversation through an issue. If you have a solution in mind, you can contribute a small piece of content and initiate a discussion with us through a pull request.
We're delivering this content directly to you in the form of Markdown resources in GitHub repositories. With this approach, everyone can benefit from the standard issue and pull request workflow processes widely used in various collaborative endeavors.
How you can contribute to the SAP Fiori tools documentation
Open
SAP Fiori tools User Guide, at the top of the page you will see a Feedback button.
You can provide feedback directly from the link on the documentation page for SAP Fiori tools.
Via the
Feedback button, you can provide feedback on the page content, either generally or specifically. This feedback provision will be via a GitHub issue.
The feedback button will create a GitHub issue.
Alternatively, if you find something for which you want to offer some content contribution, you can use the
Edit page button. This will take you to the Markdown content for that page in the GitHub repository for that documentation set, which is under the organization,
SAP-docs.
Here’s what that content will look like:
The edit button is on the GitHub page.
Then, when you use the edit (
✎) button on this page, it will launch the online editor. This is where you can make your change suggestion, and follow the standard GitHub workflow process based on the automatic creation of a pull request.
Here’s what edit mode looks like:
You can edit the documentation directly in Markdown on the relevant page in GitHub.
If you are well-versed in GitHub, and familiar with Git workflows, you also have the option to make your edits, craft a commit message in a new branch, and, upon approval, your changes will be integrated into the main branch.
Note: In order to provide feedback, you must have a GitHub user account.
Let’s all work together to make the SAP Fiori tools help documentation even more accessible to all the developers who rely on it to create SAP Fiori elements and freestyle SAPUI5 apps. Thanks!