Contributing to the Documentation¶

The documentation is as important as the code. It follows the exact same principles: DRY, tests, ease of maintenance, extensibility, optimization, and refactoring just to name a few. And of course, documentation has bugs, typos, hard to read tutorials, and many more.

Contributing¶

Before contributing, you need to become familiar with the markup language used by the documentation.

The Sylius documentation is hosted on GitHub, in the main repository:

https://github.com/Sylius/Sylius

If you want to submit a patch, fork the official repository on GitHub and then clone your fork to you local destination:

git clone [email protected]:YOUR_USERNAME/Sylius.git

Under the name origin you will have from now on the access to your fork. Add also the main repository as the upstream remote.

git remote add upstream [email protected]:Sylius/Sylius.git

Choose the right Base Branch¶

Before starting to work on a patch, you must determine on which branch you need to work. It will be:

  • 1.x, if you are fixing or adding docs for features that exist in one of those versions,
  • master, if you are documenting a new feature, that was not in 1.x

Note

All bug fixes merged into the 1.x maintenance branches are also merged into master on a regular basis.

Create a dedicated branch for your changes (for organization):

git checkout -b docs/improving_foo_and_bar

You can now make your changes directly to this branch and commit them. Remember to name your commits descriptively, keep them possibly small, with just unitary changes (such that change something only in one part of the docs, not everywhere).

When you’re done, push this branch to your GitHub fork and initiate a pull request.

Your pull request will be reviewed, you will be asked to apply fixes if necessary and then it will be merged into the main repository.

Testing Documentation¶

To test the documentation before a commit you need to install Sphinx and needed dependencies.

Tip

Official Sphinx installation guide : www.sphinx-doc.org

Note

If you are using docker - you can try building your documentation with: Sylius Documentation Builder

Our recommendation is to install Sphinx via Pip.

We suggest to install & use Sphinx v1.8.5

pip3 install -Iv sphinx==1.8.5

pip3 install --no-cache-dir -r ./docs/requirements.txt

Then run

sphinx-build -b html ./docs ./docs/build

and view the generated HTML files in the docs/build directory. You can open them in your browser and check how they look!

Warning

If you have problems with using Sphinx, please make sure that you’re using Python 3. Using pip, try to uninstall old dependencies and install latest version Python and Sphinx.

pip uninstall sphinx
pip3 uninstall sphinx

If you have installed old sphinx by your operating system tools like: brew, apt-get or yum, you have to uninstall it too.

Creating a Pull Request¶

Following the example, the pull request will be from your improving_foo_and_bar branch to the Sylius master branch by default.

GitHub covers the topic of pull requests in detail.

Note

The Sylius documentation is licensed under a Creative Commons Attribution-Share Alike 3.0 Unported License.

Warning

You should always prefix the PR name with a [Documentation] tag!

You can prefix the title of your pull request in a few cases:

  • [WIP] (Work in Progress) is used when you are not yet finished with your pull request, but you would like it to be reviewed. The pull request won’t be merged until you say it is ready.
  • [ComponentName] if you are contributing docs that regard on of the Sylius Components.
  • [BundleName] when you add documentation of the Sylius Bundles.
  • [Behat] if you modify something in the the BDD guide.
  • [API] when you are contributing docs to the API guide.

For instance if your pull request is about documentation of some feature of the Resource bundle, but it is still a work in progress it should look like : [WIP][Documentation][ResourceBundle] Arbitrary feature documentation.

Documenting new Features or Behavior Changes¶

If you’re documenting a brand new feature or a change that’s been made in Sylius, you should precede your description of the change with a .. versionadded:: 1.X tag and a short description:

.. versionadded:: 1.3
    The ``getProductDiscount`` method was introduced in Sylius 1.3.

Standards¶

All documentation in the Sylius Documentation should follow the documentation standards.

Reporting an Issue¶

The easiest contributions you can make is reporting issues: a typo, a grammar mistake, a bug in a code example, a missing explanation, and so on.

Steps:

  • Submit a new issue in the GitHub tracker;
  • (optional) Submit a patch.