How to handbook

Contributions

This handbook is maintained by Thomann.io employees.

It's entirely written in Markdown for the sake of simplicity and portability. If you want to learn more about Markdown, check this short video or read John Gruber's excellent documentation.

If you spot typos, find something to be unclear or simply wrong, there are three options:

• Change the markdown file directly and create a pull request
• Contact the folks in the #io-handbook channel on Slack

If you want to add something new or make a major change to a process described in the handbook, there are two options:

• Create your change as a pull request and assign a director for review
• Write a proposal in the #io-handbook channel on Slack

Afterwards, a proposal is up for discussion and adjustments. Once it's refined and approved, it will become part of the handbook.

Changes should always be announced in our Assembly. Depending on the urgency also in #io-team-all.

Some rules

• If you're writing about a process do not refer to contact persons directly
• Please write about your change in the changelog.md

Where goes what?

• All markdown goes into /src
• All files go into /assets
• Stay plain text when possible
• When mentioning Slack channels, use #channel-name-as-code. Markdown might confuse them with headlines otherwise.

How does it go live?

• We're using mdBook to render this handbook on https://handbook.thomann.io - the documentation can be found here
• Once your changes have arrived in the main branch, they will be deployed to staging. It's required that the staging site is updated first.
• Once staging is deployed without errors, you can release to production by creating a new release tag