Moja global documentation
This repository contains developer documentation for the moja global community. You can find the online version of the moja global documentation at docs.moja.global.
Issues and contributions for the developer documentation are tracked here. We have a large community using these resources and we would like to make it our best effort to respond to issues in a timely fashion.
To file a docs issue, use the issue tracker in the moja-global/moja_global_docs repo.
Installation
To edit the documentation you need a GitHub account. Once you have created one and logged in, you can edit any page by navigating to the corresponding file and clicking the edit (pen) icon.
This will create a "fork" and further you can create a "pull request", which will be approved by one of the existing members of the Docs team. If you have any development experience, you can setup the docs on your local machine to build the documentation locally.
Here are the steps you can follow while setting up the documentation locally.
- Fork the repository
If you choose to setup the documentation website locally, you need to have Python and the Python package manager pip on your local machine. Follow the official Python installation to setup Python on your local machine.
First make a fork, and then clone the repo:
- Clone the repository. Replace the
<GITHUB_USERNAME>with your GitHub username. You can find your username by clicking on your profile picture in the top right corner of the GitHub website.
git clone https://github.com/<GITHUB_USERNAME>/moja_global_docs.git- Go into the directory containing the project
cd moja_global_docs- Navigate to the docs directory
cd docsYou are now in the docs directory.
Assuming that you have python & pip already installed. Let us set the documentation up:
For Linux Users:
virtualenv env
source env/bin/activate
pip install -r requirements.txt
make htmlFor Windows Users:
virtualenv env
env\Scripts\activate
pip install -r requirements.txt
make htmlYou can now open the documentation site on _build/html/index.html in your browser. Make corresponding changes on the documentation site and then run make clean && make html to update the documentation. You can now create a pull request to get your changes merged into the upstream develop branch.
To look for broken links:
make linkcheckYou can now look for the broken links, if any, inside _build/linkcheck/output .
Setup the pre-commit hook
In order to ensure that the documentation is free from unforced spelling errors, a pre-commit hook has been used. On executing git commit, codespell checks for spelling errors.
Steps to install pre-commit :
pip install pre-commit
pre-commit install
If spelling errors are detected, codespell automatically corrects the spelling. It is required to execute git add to stage the changes made.
The job spell-check in the Github Action named pre-commit is used to run the spell check on CI. A failed Github Action indicates the presence of spelling errors. The contributors should correct the spelling errors and commit the changes
How to Get Involved?
moja global welcomes a wide range of contributions as explained in the Contributing guide and in the About moja global page.
FAQ and Other Questions
- You can know about moja global on the About moja global page.
- If you have a question about the code, submit user feedback in the relevant repository.
- If you have a general question about a project or repository or moja global, join moja global and
- submit a discussion to the project, repository or moja global team
- submit a message to the relevant channel on moja global's Slack workspace.
- If you have other questions, please write to [email protected].
Contributors
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!
Maintainers Reviewers Ambassadors Coaches
The following people are Maintainers Reviewers Ambassadors or Coaches.
 moja global |
Maintainers review and accept proposed changes. Reviewers check proposed changes before they go to the Maintainers. Ambassadors are available to provide training related to this repository. Coaches are available to provide information to new contributors to this repository.