# How to use the handbook

# Handbook-first approach

Handbook is our Single Source of Truth. That's how we share our knowledge and follow company's values.

# How to make changes

  • Respect Interation priciple and make small changes frequently. You can improve them later.
  • Web IDE for make changes in browser.
  • Prefer to make changes through merge requests.
  • Notify everyone about the changes in #announcement channel.


# How to edit locally with git?

  1. Clone the repository with the project.
  2. Download the updates with git pull.
  3. Create a branch with git checkout -b update-some-page.
  4. Make edits.
  5. Make a commit with git commit -a -m "update some page".
  6. Send to GitLab git push origin update-some-page.
  7. Create a Merge Request.

# Formatting

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

# Style guidelines

  • Write in plain English.
  • Avoid complex phrases and words.
  • Use grammarly to check the grammar and sentence complexity.
  • Explain with examples.