Contributing to WSO2 Open Banking 3.0 Documentation
The WSO2 Open Banking documentation is based on the Atlassian-Confluence platform until its latest release. With the WSO2 Open Banking v3.0 — Open Banking Accelerator release the documentation platform has changed to MkDocs https://www.mkdocs.org/.
Link to the latest documentation space — https://ob.docs.wso2.com/en/latest/
What is MkDocs?
MkDocs is a fast, simple and complete static site generator that’s geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.
The source code WSO2 Open Banking documentation is available in GitHub in a public repository, letting everyone become a contributor for this project.
Link to the repo — https://github.com/wso2/docs-open-banking.
Edit the Markdown file
You can simply edit an existing Markdown file to make minor changes, the steps to follow are:
- Go to ob.docs.wso2.com and to the page you wish to edit.
- Click the edit icon (pen) in the top right corner of the page:
3. Now you will need to sign in to your GitHub account.
4. Once you sign in, it will open the relevant Markdown (md) file in the repository in edit mode.
5. Carefully modify the file.
And if you need any help regarding formatting etc. Please refer to the Markdown Cheat Sheet.
6. Scroll down, add a proper commit message, and click Commit changes.
This will automatically fork the repo and create a new branch for you.
7. This will redirect you to the UI where you open a pull request. Fill the PR template, provide a title, and send in your Pull Request.
Once we receive your PR, we will go thru it, review the changes and do the needful.
Also, if you have any concerns regarding the latest WSO2 Open Banking documentation, simply click the Report Issues button in the right corner of the doc space, sign in to your GitHub account, and open a Git Issue. We will get back to you.
