Dokumentation Bearbeiten und Ergänzen

Um diese Dokumentation möglichst aktuell zu halten und damit alle relevanten Informationen von den Aareon Connect Partnern enthalten sind, können Sie diese Dokumenation ebenfalls bearbeiten und ergänzen.

Alles was Sie dafür benötigen ist ein kostenloser GitHub Account, den Sie, falls noch nicht vorhanden, hier erstellen können.

Mit einem GitHub Account können Sie dann folgenden Schritten folgen:

  1. Gehen Sie über den Datei-Browser auf die Seite die Sie bearbeiten wollen

    1. Die Struktur entspricht genau der Struktur in der Dokumentation

  2. Klicken Sie auf das Stift Symbol und erstellen eine neue Kopie in Ihrem GitHub Account

  3. Nehmen Sie in der Kopie die vorgeschlagenen Änderungen vor

    1. Für die Formatierung wird Markdown verwendet

  4. Wechseln Sie auf Preview um eine Vorschau Ihrer Änderungen, inkl. Formatierung zu sehen

  5. Klicken Sie oben rechts auf Commit changes...

  6. Beschreiben Sie in der Commit message Ihre Änderung in wenigen Worten und ggf. weitere Details in der Extended description.

  7. Falls Sie weitere Änderungen zu dem selben Thema (z.B. eine verlinkte Seite) vornehmen wollen, können Sie dies ebenfalls tun bevor Sie mit den nächsten Schritten fortfahren

  8. Klicken Sie auf Create pull request

  9. Passen Sie ggf. den automatisch vorgeschlagene Pull Request Titel und description an

  10. Klicken Sie erneut auf Create pull request

  11. Das Aareon Connect Team wird dann Ihren Änderungsvorschlag prüfen und in die Dokumentation aufnehmen

Last updated