Guidelines

Syntax

Please familiarize yourself with the Markdown Syntax and the Docusaurus Markdown features first.

Please direct all relevant questions to the colleagues found in the table below.

Language

All documentation is written in English. This is a must for all projects.

Adding to the docs

Merge Requests

NEVER push directly to the master branch or merge on your own. EVERY merge request must be approved by the person managing the docs for your respective system.

Currently, these people are:

Name	System
Dominik Tetzloff	Magento
Rene Kuschnick	Shopware
Christian Schiffler	Git / Top Level Technical docs

New article

If you want to add a new article, please clone the Repository and create a new .md file in the relevant docs folder.

Create a new branch, add your article and create a merge request.

Editing an article

At the bottom of every article you can find a link to edit the article directly in GitLab (Edit this page).

After you added your changes, push into a new branch in the GitLab IDE and create a merge request.

Document structure

Every document needs to follow the standard Markdown structure.

This means start the file off with a h1 (# Title). This h1 will also determine the title of the Sidebar Item.

From then on, split the file into sections that make sense. The hierarchy is:

• h2 (##)
  • h3 (###)
    • h4 (####)
  • h3 (###)
• h2 (##)

It cannot be stressed enough that the clarity of the structure is important. This structure h2 onwards also determines not just the browsable shortcut list in the top right corner, it will also be displayed as a breadcrumb in the search result item.

A clear structure therefore makes it easier for everyone to find the information they need quickly.

Example Structure (Click to expand)

# My new Page

Preliminary Infos go here.

## Step 1

Step 1 description.

## Step 2

### Option 1

Option 1 description.

### Option 2

Option 2 description.

## Bottom Line

More text.