Document Actions
Contributing Documentation
Guidelines and policy for contributing user documentation to be published to mifos.org
Mifos is built on a foundation of knowledge sharing and community collaboration. We welcome individuals to contribute to the technical and user documentation on Mifos.org.
The primary areas where this documentation resides are:
- Developers --> Install Mifos
- Developers --> Technical Orientation
Contributions to these sections will be handled according to the workflow & review policy outlined below. This review policy does not apply to the Developer's Wiki (pages with "wiki" in the url); the Wiki is a fully open collaboration space for our developers - to learn more about using the Wiki, please click here.
The Mifos Knowledge Center is also another area where users can collaborate to share their lessons learned while deploying Mifos with the rest of the community. Submissions made here will not be part of this review policy.
Workflow & Review Policy
All newly created documentation will be reviewed by a member of the Mifos team prior to being published to Mifos.org and. It will follow this workflow:
Lifecycle of new documentation
|
User Action |
User creates a new page |
--> |
User submits page for review |
--> |
Mifos team reviews & publishes page |
| Document State |
Initial Draft |
Pending |
Published |
To ensure that your documentation is effective for the entire community:
- Write clearly and concisely.
- Highlight all the steps or points of advice so that your intended message is clearly understood.
- Feel free to use screenshots if these visual aids will clarify your message.
Creating new documentation
1. Create your new page.
- Click page from the "add to folder" drop-down menu.
- In this example, we're saving our page to the Technical Orientation folder of the Developer's section.
2. Edit and save your page.
- Edit the content of your page - please look here for tips on editing content.
- Save your page.
- It will now be in the "initial draft" state.
3. Once you've finished editing your page. Save it and then from the state drop-down menu, select: submit.
4. Your page will now be in the "pending" state. From here it will be reviewed by a member of the Mifos team who will then publish it or send it back to you requesting further edits to be made.
Editing existing documentation
If you'd like to make edits or improvements to an already existing published document, you will first need to "checkout" a copy, make your suggested edits and then follow the same review policy as previously outlined.
1. Navigate to the page you would like to edit.
- In this example, we're going to be editing the "Build and Install Mifos on Windows" page.
2. Checkout a working copy of the published page you want to edit
- From the "actions" drop-down menu, click checkout.
3. Select current folder as the location you would like to checkout to.
4. The document is checked out and now ready for editing as it's in the "initial draft" state.
5. Upon completion of your edits, save your document as normally would be be sure to include comments in the versioning box to describe the changes that you've made.
6. Once you are ready to submit the document for review. Click "submit" from the state menu.
7. The document is now in the pending state and in the queue for review by a member of the Mifos team.
8. If you would like to cancel your checkout and not submit any changes for review, you can do so by clicking "cancel checkout" from the actions drop-down:
