Developer documentation is available at https://developer.mautic.org and is generated using Slate.
Before contributing, you need to:
In this section, you'll learn how to contribute to the Mautic documentation for the first time. The next section will explain the shorter process you'll follow in the future for every contribution after your first one.
Let's imagine that you want to improve the REST API documentation. In order to make your changes, follow these steps:
git clone https://github.com/YOUR-GITHUB-USERNAME/developer-documentation.git
git checkout -b fix_1234 upstream/master
In this example, the name of the branch is
fix_1234 and the
upstream/master value tells Git to create this branch based on the
master branch of the upstream remote, which is the original Mautic Developer Docs repository.
source/includes. Add, tweak, reword and even remove any content and do your best to comply with the Documentation Standards. Then commit and push your changes!
git add _api_authorization.md git commit _api_authorization.md git push
Everything is now ready to initiate a pull request. Go to your forked repository at https://github.com/YOUR-GITHUB-USERNAME/developer-documentation and click on the Pull Requests link located in the sidebar. Then, click on the big New pull request button.
The last step is to prepare the description of the pull request. A short phrase or paragraph describing the proposed changes is enough to ensure that your contribution can be reviewed.
Check you out! You've made your first contribution to the Mautic developer documentation! Somebody throw a party! Your first contribution took a little extra time because you needed to learn a few standards and setup your computer. But from now on, your contributions will be much easier to complete.
Here is a checklist of steps that will guide you through your next contribution to the Mautic docs:
# Create a new branch git fetch upstream git checkout -b my_changes upstream/master # ... do your changes # (optional) add your changes if this is new content git add xxx.md # commit your changes and push them to your fork git commit xxx.md git push origin my_changes # go to GitHub and create your Pull Request # (optional) make the changes requested by reviewers and commit them git commit xxx.md git push
We will add instructions for building the documentation locally at a later stage.
Found errors? Think you can improve this documentation? edit this page