Contribute to this documentation

This documentation is a constant work in progress, and anyone can propose changes and additions here.

First thing first

To be able to contribute to the documentation you must be signed in to a GitHub account, so the first thing you have to do is sign-up:

../_images/sign-up-github.png

When you want to propose a change, you must make sure you’re signed-in to your account.

Text edits

For text edits, do the following:

  1. Go to the page you want to edit.

  2. Click “Edit on GitHub”.

../_images/edit-on-github.png

  1. Click the pen to edit the file.

../_images/edit-on-github-pen.png

  1. Edit the text as needed.

  2. Scroll down to the bottom of the page.

  3. Type a comment about the changes you made.

  4. Select “Create a new branch for this commit and start a pull request”.

  5. Type a title for the changes (dashboard-edits in the example below).

  6. Click “Propose changes”.

../_images/edit-on-github-propose.png

  1. If you haven’t already, add a comment.

  2. If the Reviewers field is not pre populated, you must add a reviewer. You should primarily add the Documentation Project Manager there (at the moment Benny Eronson).

../_images/edit-on-github-reviewer.png

  1. Click “Create pull request”.

../_images/edit-on-github-create.png

Extensive edits

If you would like to contribute with more extensive changes or additions, as for example new images or a whole new page, contact the Documentation Project Manager for instructions.