Did you spot an error in the documentation? Do you think something is missing or should be explained differently? Do you have a great idea for new content? This is the place to share your thoughts and ideas with us!
You can add content requests by creating a GitHub issue. If you want to propose changes, updates, or corrections to the documentation content, please create a pull request.
You are welcome to:
- Correct or update existing documentation as needed.
- Add new content and sections to an existing article.
- Create and propose entirely new documentation chapters.
- Suggest changes to the structure of the documentation.
As with every open source project, there is no guarantee that your contributions will be accepted, but we do our best to make it happen! We might also edit and adapt your contributions before we implement them to bring them in line with our documentation standards.
To contribute, please follow these simple steps:
- Fork this repo into your GitHub account.
- Implement your contribution.
- Create a GitHub pull request with a meaningful title.
- A colleague from our documentation team will review your suggested changes and give feedback.
- Once your contribution is accepted and the pull request is merged, it will be visible in the OpenUI5 Nightly Demo Kit. With the next OpenUI5 release, these changes will also become part of the official OpenUI5 documentation in the Demo Kit.
Due to legal reasons, contributors will be asked to accept a DCO when they create the first pull request to this project. This happens in an automated fashion during the submission process. SAP uses the standard DCO text of the Linux Foundation.
I have a great idea for a new documentation page. How do I add this?
The process is generally the same as when you change a file, but instead of changing an existing file, you simply add a new file (or several files) to the docsfolder. Ideally, you add Markdown files (*.md), but any other text-based file format is okay. After that, you create a pull request as usual. You don't have to worry about adding the proposed file to the documentation hierarchy, just let us know in the comments where you think this should go.
What's this "loio" at the top of each markdown file?
This is the internal ID of the documentation page in our content management system. Part of this ID is also added to the file name.
The raw Markdown files in the docsfolder have a number in the file name. What does that mean?
This number is part of the internal ID that is generated by our content management system. You don't need to worry about that when you add a new file to the docsfolder.
Have fun contributing and do let us know if we can support with anything!