Erste Community-Anleitung schreiben

Dieser Bereich ist für Earth Engine-Nutzer gedacht, die ihr Wissen mit der restlichen Earth Engine-Community teilen möchten. Die Anleitungen in diesem Abschnitt wurden von Earth Engine-Nutzern für Earth Engine-Nutzer erstellt und sind für alle Nutzer geeignet, von Anfängern bis hin zu fortgeschrittenen Nutzern.

Anleitungen können als Nur-Text und Code, der mit der Markdown-Auszeichnungssprache formatiert wurde, oder als Colab-Notebooks mit Markdown und ausführbarem Python-Code eingereicht werden. Anleitungen, die mit den Earth Engine JavaScript-Clientbibliotheken erstellt wurden, werden in der Regel in Markdown geschrieben. Für Anleitungen, die auf den Earth Engine Python-Clientbibliotheken basieren, wird Colab empfohlen.

Hinweis

Verhaltenskodex

Das Earth Engine-Team setzt sich für eine Community ein, in der es keine Belästigungen gibt und die alle einschließt. Bitte machen Sie sich mit unserem Verhaltenskodex vertraut, bevor Sie einen Beitrag leisten.

GitHub beitreten

Anleitungen der Earth Engine-Community werden über GitHub geteilt und überprüft. Wenn Sie noch kein GitHub-Konto haben, müssen Sie zuerst unter https://github.com/join eines erstellen.

Anleitung vorschlagen

Bevor potenzielle Mitwirkende viel Zeit und Mühe in eine neue Anleitung investieren, werden sie gebeten, einen einfachen Vorschlag mit einigen grundlegenden Informationen einzureichen. So können Autoren mit den Verantwortlichen der Earth Engine-Entwicklerdokumentation zusammenarbeiten, um sich auf Anleitungen zu konzentrieren, die für die Earth Engine-Nutzer-Community den größten Mehrwert bieten. Außerdem wird Zeit gespart, da potenzielle Rückfragen während des Überprüfungsprozesses vermieden werden.

Anleitung vorschlagen

Ersteinrichtung

Wenn Sie zum ersten Mal eine Anleitung im GitHub-Repository der Earth Engine-Community einreichen, führen Sie diese Schritte aus, bevor Sie mit der Arbeit an Ihrer Anleitung beginnen:

  1. Akzeptieren Sie die Lizenzvereinbarung für Mitwirkende (Contributor License Agreement, CLA) unter:

    https://cla.developers.google.com

  2. Lesen und verinnerlichen Sie den Styleguide für Anleitungen der Community.

Anleitung schreiben und einreichen

Sobald Ihr Anleitungsvorschlag von den Verantwortlichen akzeptiert wurde, haben Sie mehrere Möglichkeiten, die Anleitung zu bearbeiten und im Repository der Earth Engine-Community einzureichen:

Schnellstart für Markdown

Sie können das GitHub-Repository verzweigen und direkt über die GitHub-Website eine neue Anleitung erstellen, um schnell loszulegen, ohne zusätzliche Tools oder Einrichtungsschritte:

  1. Melden Sie sich bei GitHub an, falls noch nicht geschehen.

  2. Klicken Sie auf Neue Anleitung, um eine neue Anleitungsdatei zu erstellen und zu bearbeiten. Sie werden gegebenenfalls aufgefordert, das Repository zu verzweigen.

    Neue Anleitung

  3. Geben Sie einen Namen für die Anleitungsdatei im folgenden Format ein:

    your-tutorial-name/index.md

    Dabei ist your-tutorial-name der Kurzname Ihrer Anleitung in Kleinbuchstaben. Verwenden Sie Bindestriche („-“), um Wörter zu trennen. Verwenden Sie keine Leerzeichen oder andere Satzzeichen im Ordnernamen.

  4. Bearbeiten Sie Ihre Anleitung direkt im GitHub-Dateieditor und verwenden Sie "Vorschau", um die formatierte Ausgabe zu überprüfen (siehe auch Dateien in Ihrem Repository bearbeiten in der GitHub-Dokumentation).

  5. Wenn Sie fertig sind, übertragen Sie Ihre Änderungen und öffnen Sie eine Pull-Anfrage.

Colab-Notebook

Klicken Sie hier, um mit dem Schreiben einer Anleitung in Colab zu beginnen:

Neue Colab-Anleitung

Dadurch wird ein Notebook mit einer Anleitung zum Erstellen und Einreichen Ihrer Anleitung geöffnet.

Erweitert

Wenn Sie bereits mit GitHub, Git und ähnlichen Tools vertraut sind, ist der allgemeine Prozess für das Einreichen von Markdown- und Colab Anleitungen derselbe:

  1. Verzweigen und klonen Sie das google/earthengine-community GitHub -Repository.

  2. Erstellen Sie ein Verzeichnis unter tutorials mit dem Slug des Kurznamens von Ihrer Anleitung (z.B. tutorials/my-amazing-tutorial).

  3. Fügen Sie den entsprechenden Header für Markdown oder Colab hinzu.

  4. Übertragen Sie die Anleitung in das neue Verzeichnis mit dem Dateinamen index.md (für Markdown) oder tutorial.ipynb (für Colab). Übertragen Sie Bilder, die in der Anleitung verwendet werden, in dasselbe Verzeichnis.

  5. Übertragen Sie die neuen Inhalte in Ihre Verzweigung und öffnen Sie eine Pull -Anfrage.

Wenn Sie eine Pull-Anfrage erstellen, verweisen Sie im Kommentarbereich auf den ursprünglichen Vorschlag anhand der GitHub-Referenznummer. Wenn das Problem beispielsweise die Nummer 123 hat, fügen Sie den Text „Closes #123“ in die Beschreibung der Pull-Anfrage ein, um auf den ursprünglichen Vorschlag zu verweisen und ihn automatisch als erledigt zu markieren, sobald die Anleitung veröffentlicht wird.

Sobald Sie eine Pull-Anfrage geöffnet haben, werden ein oder mehrere Verantwortliche zugewiesen, um Ihren Beitrag zu überprüfen. Die Prüfer arbeiten mit Ihnen zusammen, um sicherzustellen, dass Ihr Beitrag vollständig und korrekt ist und dem Styleguide für Anleitungen der Earth Engine-Community entspricht.

Sobald Ihre Pull-Anfrage genehmigt wurde, wird Ihre Anleitung von den Verantwortlichen des Repositorys veröffentlicht.