Documentation Module¶

Publish technical documentation with a clean and professional UI. It simplifies software documentation.

Everything about how to deliver our documentation to the end user

How user get access to documentation?¶

Idea collection:

• Every customer should get or provide an GitHub account

• For every customer (company) we create a private fork of our main documentation repository

• During delivery, customer is getting a documentation pointing to that private fork

How can user change/modify local documentation¶

Idea collection:

• Everything customer is doing in ABP module or so can be committed to the private fork

• Customer can also use GitHub directly to maintain the documentation themselfs

• All changes are purely local in their fork and can't be seen by anyone else

• DRAWBACK: if there is only one GitHub user, customer don't see the contributors to their local changes as everything is managed via a single GitHub client. Is that true Baturalp Uyar ? Can we manipulate contributor list while using GitHub with any ABP onboard tools?

How can user update his/her local documentation or get updates from GridLab?¶

Idea collection:

• GridLab maintains branches for every official documentation release

• As soon as a new version is released, GridLab will notify all customers either in app or via email to inform about updates

• Customer can pull changes into a new branch of their fork

• Customer can merge their local changes into a new documentation version to keep their changes but get changes from GridLab

How can user contribute to the documentation?¶

Idea collection:

• If customer things his/her changes might be relevant for others, they can create a pull request to the GridLab main repository

• GridLab can review and decide if that change will go into a new version of the documentation

• If GridLab accepts the pull request, customer will be named as contributor as well