Skip to content

Generating Documentation with MkDocs

Overview

Generating documentation with MkDocs is a straight-forward process. You check out the documentation, make your changes and check them in. After the push, the environment is updated you can see the results of your work immediately.

Prerequisites

  • a markdown editor (e. g., IntelliJ)
  • access to the location quintessence-hetzner-documentation
  • connection to our gitlab

Contribution Process

  • Consider the available structure, find the right location for your content (in the correct topic). You are very welcome to reach out to Dmitrijs or Anna R. if you need help integrating your content into the existing structure or have any other questions.
  • Check out the current project
  • Create a new file and write your content:
    • copy the content of the template into your new file
    • consider the guidelines and use the cheatsheet
  • Check in and push.
  • Assign the task to Anna R. to post-edit the content.
  • Consider notyfying the big team about the new documentation.

Changelog

Date Author Message
2026-02-25 aresnikowa Merge remote-tracking branch 'origin/master'