Drupal Commerce Documentation
- How to contribute to this documentation
How to contribute to this documentation
Before your first contribution
Before contributing, you should consider the following:
- The documentation is written using reStructuredText markup language. If you are not familiar with this format, read this article for a quick overview of its basic features.
- The documentation is hosted on GitHub. You'll need a free GitHub user account to contribute to the documentation.
- The documentation is published under a Creative Commons BY-SA 4.0 License and all your contributions will implicitly adhere to that license.
Fast online contribution
If you're making a relatively small change - like fixing a typo or rewording something - the easiest way to contribute is directly on GitHub! You can do this while you're reading this documentation.
- Click on the Edit on GitHub button on the upper right corner and you'll be redirected to GitHub:
- Click the edit icon to edit the documentation:
- You will be asked to fork the repo, click Fork this repository and propose changes:
- Edit the contents, describe your changes and click on the Propose file change button:
- GitHub will now create a branch and a commit for your changes (forking the repository first if this is your first contribution) and it will also display a preview of your changes: If everything is correct, click on the Create pull request button.
- GitHub will display a new page where you can do some last-minute changes to your pull request before creating it. For simple contributions, you can safely ignore these options and just click on the Create pull request button again.
Congratulations! You just created a pull request to the official Drupal Commerce documentation! The community will now review your pull request and (possibly) suggest tweaks.
But if you want to contribute heavily, we recommend you doing a local setup of the documentation.
- Run composer install
- In the terminal generate user for admin panel
bin/plugin login newuser
- Add credentials
php -S localhost:8000 system/router.php
Edit using Visual Code Studio
You can download Visual Code Studio and add the reStructured Text plugin to have an editor with built in previews available.
Edit and review manually
./build.sh, this will generate documentation HTML inside
- Now you can view the documentation locally, execute
php -S localhost:8000 -t _build/html, and visit http://localhost:8000/ from your browser.