Dokumente bearbeiten
Wir laden Mitglieder der Community ausdrücklich dazu ein, an der OXID eSales Dokumentation mitzuarbeiten. Das können kleinere Ergänzungen zu bestehenden Dokumenten sein, aber auch das Erstellen neuer Dokumente. Unsere Dokumentation ist in sogenannten Repositories auf GitHub gespeichert. Wenn Sie an ihr mitschreiben wollen, benötigen Sie zunächst ein eigenes Benutzerkonto, welches in nur drei Schritten erstellt ist. Jetzt anmelden: https://github.com/join?source=header-home.
Jedes Dokument der Anwender- und Entwicklerdokumentation online hat rechts oben einen Link Edit on Github, welcher das Dokument auf GitHub direkt öffnet. Will man es jetzt bearbeiten, erhält man einen Hinweis, dass dies nur in einem eigenen Repository möglich ist. Kein Problem, denn in GitHub läuft das alles automatisch ab. Sobald man dann die Änderung abschicken will, ist dieses eigene Repository längst erstellt und es wird ein Pull Request, also ein Vorschlag mit der Änderung, an das originale Repository geschickt.
Um ein neues Dokument zu erstellen, erzeugt man zunächst einen Fork. Dabei wird eine Kopie des originalen Repository erstellt, welches man dann im eigenen Profil findet. Dort kann eine Datei an beliebiger Stelle hinzugefügt werden. Am Ende steht wieder der Pull Request, mit dem das neue Dokument als Vorschlag an das originale Repository geschickt wird.
Natürlich können Dateien auch lokal auf dem Rechner bearbeitet werden.