Wiki-Beiträge

Eine Anleitung zum Aktualisieren des 1Hive-Wikis.

1Hive ist ein großes, weitläufiges Ökosystem mit vielen verschiedenen Projekten, die ständig weiterentwickelt werden. Die Pflege eines Wikis ist wichtig, um einen präzisen Überblick über den Status von 1hive zu erhalten. Jeder wird ermutigt, zum 1Hive-Wiki beizutragen.

Mindestens ein Mitglied aus jedem Schwarm hat Schreibzugriff, um das Wiki zu aktualisieren und sicherzustellen, dass die Details zu seinem Schwarm und den zugehörigen Projekten korrekt sind. Jeder ohne Schreibzugriff kann weiterhin eine Seite im Wiki oder in der Wiki-Struktur über Github mithilfe einer Pull-Anforderung aktualisieren.

Bearbeiten des Wikis mit Github

Schritte zum erstmaligen Einrichten

  1. Um eine Seite ohne expliziten Schreibzugriff zu bearbeiten, ist ein Github-Konto erforderlich. Erstellen Sie eins hier: http://github.com/

  2. Forken Sie das Wiki von der 1Hive Github-Organisation in Ihr eigenes Github-Konto, indem Sie auf diesen Link klicken und oben rechts auf Fork klicken: https://github.com/1Hive/wiki

Schritte nach dem Setup

  1. Navigieren Sie im Wiki-Repo, das Ihrem eigenen Github-Konto zugeordnet wurde, zu der Datei, die Sie ändern möchten, und bearbeiten Sie die Datei direkt in Ihrem Webbrowser, indem Sie auf das Stiftsymbol oben rechts am Dateirand klicken. Jede Datei stellt eine Seite im Wiki dar. Die Namen sollten diejenigen darstellen, die auf der Wiki-Website angezeigt werden.

  2. Verwenden Sie Github Markdown, um Ihren Eintrag zu formatieren: https://guides.github.com/features/mastering-markdown/

  3. Wenn Sie eine neue Seite hinzufügen, stellen Sie sicher, dass Sie aus der Datei SUMMARY.md im Stammverzeichnis (root) einen Link zu dieser Seite erstellen, um sie in das Menü aufzunehmen.

  4. Übernehmen Sie Ihre Änderung, indem Sie nach unten scrollen, eine Commit Nachricht eingeben und auf Commit klicken..

  5. Erstellen Sie eine Pull-Anfrage (PR) für das 1Hive-Wiki-Repo, indem Sie auf Pull-Anfragen -> Neue Pull-Anfrage klicken. Beachten Sie, dass das Basis-Repository 1Hive / Wiki und die Basis Mastersein sollte. Klicken Sie auf Pull-Anforderung erstellen.

  6. Geben Sie einen Titel und eine Beschreibung Ihrer Änderung ein und klicken Sie auf Pull-Anforderung erstellen.

  7. Sie haben erfolgreich eine PR im 1Hive-Wiki-Repo erstellt. Sie müssen jetzt warten, bis es von einem Mitglied der 1Hive Github-Organisation überprüft wurde. Prüfer können Kommentare hinterlassen. Überprüfen Sie daher unbedingt Ihre E-Mails und prüfen Sie erneut, ob Sie antworten müssen.

  8. Wenn Sie Ihre Änderungen aufgrund von Überprüfungskommentaren aktualisieren müssen, aktualisieren Sie die Datei zunächst wie zuvor. Sie sollten sich in der PR widerspiegeln.

  9. Sobald die PR als akzeptabel angesehen wird, wird sie von einem Rezensenten in das Wiki eingefügt.

Last updated