Docs

Internal documentation

We’re an open-source company, and we want to share as much information as possible with the public. This is also true for documentation, and thus this handbook already contains a lot of documentation topics.

However, we also have internal & confidential information, which we can’t share with the public.

For those topics, we’re using our internal docs system, based on Silverbullet. It’s intended for:

• Internal documentation

• Confidential information

• Customer-specific documentation

• Daily notes

• Sprint notes

• …

Note

The deployment, and all documentation for the docs can be found in the GitLab Docs project.

Docs vs. Handbook

Both, the `docs`_, as well as the handbook are intended for documentation purposes.

However, there are clear rules what belong to the handbook:

• It must have a «public character»

• It must be a «high-level» documentation

For all others, especially «techie documentation» & «boring» internal operations stuff, we’re either using the `docs`_, and/or Markdown files in GitLab projects.

Important

Always try to make cross-references between the documentation.

For example, if you describe a topic on a high-level in the handbook, but you’ve a more low-level «techie documentation» in the `docs`_, or in a Markdown README.md, cross-reference between those documentation sources.