Collaborate with Us – Open Documentation Initiative for SAP Integration Suite

Better together! With the Open Documentation contribution process, you can now give feedback to the SAP Integration Suite documentation on SAP Help Portal. Get to know the idea, learn how to do it, and start contributing via GitHub! 

The new Open Documentation contribution process allows users and content creators to collaborate – faster, better, and more directly. Looking at some documentation and you’re not sure that it’s quite hitting the mark? Send us – the content creators of SAP Integration Suite – some feedback and start a conversation in the form of an issue. Found something that doesn’t look quite right, and you know how it could be addressed? Contribute a small piece of content and start a conversation with us in the form of a pull request. 

Our goal is to make the documentation process more collaborative by inviting users to provide feedback and enhance existing information.  

What do you need? 

• A GitHub account (it’s free, and easy to set up). 
• Knowledge of the Contribution Guidelines process (I you have questions or doubts, you can directly raise an issue within the guidelines). 

How does it work? 

SAP Integration Suite documentation is now available to you via GitHub, and you can collaborate by using standard GitHub processes: use pull requests to suggest changes to existing content, and issues to provide feedback and start a discussion with us. 

How to Edit Content & Suggest Changes 

1. Open the documentation on SAP Help Portal. 
2. Choose Edit to open the markdown file of the current document.
   
   
3. On GitHub, choose the pencil icon to open the file for editing.
   
   
4. Update the Markdown version of the HTML page. 
5. Add a comment and propose your changes.
6. Create a pull request and wait for our response.

How to Provide Feedback & Raise an Issue 

1. Open the documentation on SAP Help Portal. 
2. Choose Feedback to open an issue for the current document.
   
   
3. Submit your issue and wait for our response. 

We’re excited about this new collaboration process because it helps us to better understand your feedback, act upon it faster, and improve the content together with you.  

More Information

• SAPUI5 Demo Kit with the SAPUI5 and SAP Fiori elements developer documentation
• https://github.com/SAP-docs/sapui5 (contribution repository)
• Contribution Guidelines
• SAP BTP Documentation Goes GitHub: Learn About Our New Collaboration Process

Other SAP Products Participating in the Open Documentation Initiative

• SAP BTP Documentation Goes GitHub – New Collaboration Process
• Contribute to the Setup Guide for SAP Cloud ALM
• Collaborate with us on the Migration Guide for SAP Process Orchestration!
• Join forces with us and collaborate on the SAP Custom Domain Service guides!

Looking forward to hearing from you!