Version Control
Last updated
Last updated
The documentation collection is maintained in GitHub at https://github.com/adempiere/adempiere-documentation. Corrections and updates can be made through pull-requests to that repository.
The goal is to maintain the set of documentation in parallel with the software so individual software releases will have corresponding documentation releases. Branches in the documentation repository will mirror the main branches in the software repository with the "master" branch being the most current release. Editing work should be done in the "develop" branch. Branches with names like "v3.9.1" will identify version releases.
To contribute, you will need an account on GitHub. Fork the ADempiere-Documentation repository to your GitHub account.
Create or login to your account on GitBook and create a space linked to your GitHub fork of the ADempiere documentation. When you specify the branches to sync with your GitHub account, use the following branch names:
master develop v* contrib*
After GitBook has synced content with your GitHub fork, you can use GitBook to make edits in your fork. At the top left of the GitBook window, you will see the name of the branch/version you are currently reading. If you expand that drop down, a list of available versions will be shown. The version "1.0.0" is the "master" version. (You can click on a version and change its name if you wish.) Select the one version edit. When it appears, at the bottom right, click the button to edit the selected version. The list of versions should show a link with the name "Create a new release +".
Select "Create a new release" and give it a name that follows the wildcard patterns, for example "contrib_grammar". A copy of the currently selected version will be created. Make your edits and save them. Add a comment to describe the draft's changes in the space above the "draft" icon and then publish them. GitBook will sync with your GitHub repository automatically.
When you have completed all the edits and want to submit them to the main adempiere-documentation repository, go to your account on GitHub and submit a pull request from your edited version to the target version/branch in the ADempiere repository - typically "develop". When a set of edits is complete, the develop branch will be merged into the master branch and the edits will be available in the official documentation.
GitHub provides excellent documentation on making pull requests. Be sure to target the correct branch in the main repository when making the pull request.
If you run into trouble, you can delete your local GitBook version and recreate it from the data in GitHub. Just ensure all your edits are committed first.
