# Contribution Guide Dokumentation

Diese Dokumentation wurde mit VuePress (opens new window) erstellt. Um diese zu erweitern wird eine lokale Version von der Dokumentation benötigt. Dafür sind folgende Schritte notwendig:

1: Voraussetzung ist Node.js (opens new window) >= 8.6.

2: Erstellung einer lokalen Kopie des Repositories über git clone

git clone https://github.com/hubblecommerce/hubble-docs.git
1

3: Installation der Dependencies

npm install
1

4: Starten der lokalen Umgebung über den Skriptbefehl aus der ~/package.json

npm run docs:dev
1

Dieser Befehl startet einen lokalen Server und die lokale Version der Dokumentation kann nun unter der im Terminal angegebenen URL eingesehen werden.

5: Editieren und Hinzufügen von Seiten

Seiten bestehen aus Markdown Dokumenten und enthalten einige VuePress spezifische Erweiterungen. Beispielsweise gibt es die Möglichkeit Übersetzungen für Seiten anzulegen (einsehbar in der VuePress Dokumentation unter Internationalization (opens new window)) oder eigene Vue Komponenten anzulegen (einsehbar in der VuePress Dokumentation unter Using Vue in Markdown (opens new window)).

Bevor editiert wird sollte ein neuer Branch angelegt werden. Der folgende Befehl erstellt und wechselt den Branch:

git checkout -b <NAME-OF-NEW-BRANCH>
1

Neu hinzugefügte Seiten müssen in der ~/docs/.vuepress/config.js an entsprechender Stelle eingetragen werden. Beispielsweise, das Hinzufügen eines Unterpunktes zu PWA:

// ~/docs/.vuepress/config.js
'/PWA': [
    {
        // ...
        children: [
            // ...
            '<NAME-OF-CHAPTER>'
        ]
    }
]
1
2
3
4
5
6
7
8
9
10

Details zu der Funktionsweise der Konfiguration in VuePress sind in der offiziellen Dokumentation (opens new window) einsehbar.

6: Erstellung eines Pull Requests

Eine detaillierte Ausführung zum Pull Request Prozess gibt es in der GitHub Dokumentation unter Creating a pull request (opens new window).