SAP Open Source Webinar on the Open Documentation Initiative
Here’s the information about an SAP Open Source webinar we held yesterday about the Open Documentation Initiative.
SAP’s Open Source Program Office has a webinar series with a wealth of interesting talks on open source and standards topics. Yesterday I was honoured to be able to give a session on the Open Documentation Initiative.
You can access the replay any time – head over to this webinar replays page and select the session.
I included lots of links in the slides, but rather than just present the slides here, I thought I’d share a curated set of the links for further reading and reference.
In the Precedence section, I talked about the fact that we’re not the first to do this, and gave examples from GitHub and Microsoft. The blog post linked at the bottom of one of these slides is Introducing docs.microsoft.com and is a great read. In this section I also showed a couple of examples of collaboration I’d enjoyed with the Microsoft and GitHub documentation teams:
- I submitted an issue to the Azure Docs repo: Deletion of (second) node resource group – confusion / clarity which resulted in an improvement to the documentation in question
- I submitted a pull request to the main GitHub Docs repo: include ‘shell command’ as a possible step task which was merged and improved the documentation in question in a small but important way
In the Gamification section I referred to the two missions in SAP Community that relate to the Open Documentation Initiative – you can find them in the Collaboration Missions area.
The guidelines explain how you can contribute, and are in the SAP Help Portal in the Contribution Guidelines section. It is to page in this section that we created and submitted a change, in the form of a pull request, avoid having the word appropriate twice, live during the webinar. This pull request has been merged 🙂
To wrap up, I provided a few links, which are here (some are already shared, above):
- Blog posts: Introducing the Open Documentation Initiative and Collaboration missions for the Open Documentation Initiative
- Video: SAP BTP Open Documentation Initiative
- GitHub Organization: SAP Documentation
And of course, don’t forget the main pilot documentation, which can be found on the SAP Help Portal here: SAP Business Application Studio and in the corresponding SAP Documentation repository here: SAP-docs/btp-business-application-studio.
In the immortal words of the Sirius Cybernetics Corporation Complaints Division – share & enjoy!