# How to use the handbook
# Why we write this handbook
It is extremely important for a remote team to share knowledge and information quickly and efficiently.
# How to make changes
# Editing with GitLab
Every page has an edit link at the bottom. The link leads to GitLab where edits can be made right in the interface. It's better to download the repository copy to your account and push changes as Merge Requests (MRs).
# Editing with the local repository
- Clone the repository with the project.
- Download the updates with
- Create a branch with
git checkout -b update-some-page.
- Make edits.
- Make a commit with
git commit -a -m "update some page".
- Send to GitLab
git push origin update-some-page.
- Create a Merge Request.
Use Markdown (opens new window) for formatting.
# Formatting guidelines
If there are more than four headings on the page, add a content block. To do this insert
[[toc]] macros at the beginning of the page.
# Main heading [[toc]]
# Style guidelines
- Avoid corporate language. Imagine writing to a friend.
- Explain with examples.