Pisanie pierwszego samouczka dla społeczności

To miejsce jest przeznaczone dla użytkowników Earth Engine, którzy chcą dzielić się swoją wiedzą z innymi członkami społeczności Earth Engine. Samouczki w tej sekcji zostały utworzone przez użytkowników Earth Engine dla użytkowników Earth Engine. Są one przeznaczone dla wszystkich poziomów zaawansowania – od początkujących po bardziej zaawansowanych.

Samouczki można przesyłać jako zwykły tekst i kod sformatowany za pomocą języka znaczników Markdown lub jako notatniki Colab zawierające Markdown i wykonywalny kod w języku Python. Samouczki utworzone przy użyciu bibliotek klienta Earth Engine JavaScript są zwykle pisane w Markdown, natomiast w przypadku samouczków opartych na bibliotekach klienta Earth Engine Python zalecamy korzystanie z Colab.

Zanim zaczniesz

Kodeks postępowania

Zespół Earth Engine dokłada wszelkich starań, aby tworzyć społeczność, w której nie ma miejsca na nękanie i która jest otwarta na wszystkich. Zanim zaczniesz współtworzyć treści, zapoznaj się z naszym Kodeksem postępowania.

Dołączanie do GitHuba

Samouczki społeczności Earth Engine są udostępniane i sprawdzane za pomocą GitHuba. Jeśli nie masz jeszcze konta na GitHubie, musisz je najpierw utworzyć na stronie https://github.com/join.

Proponowanie samouczka

Zanim potencjalni współtwórcy poświęcą dużo czasu i wysiłku na nowy samouczek, prosimy o przesłanie prostej propozycji zawierającej podstawowe informacje. Dzięki temu autorzy mogą współpracować z osobami odpowiedzialnymi za dokumentację dla deweloperów Earth Engine, aby skupić się na samouczkach, które są najbardziej przydatne dla społeczności użytkowników Earth Engine. Pozwala to również zaoszczędzić czas, ponieważ unika się potencjalnych wymian informacji podczas procesu sprawdzania.

Zaproponuj samouczek

Pierwsza konfiguracja

Jeśli po raz pierwszy przesyłasz samouczek do repozytorium GitHub społeczności Earth Engine, przed rozpoczęciem pracy nad samouczkiem wykonaj te czynności przed rozpoczęciem:

  1. Zaakceptuj Umowę licencyjną dla współtwórców (CLA) na stronie:

    https://cla.developers.google.com

  2. Przeczytaj i zapoznaj się z przewodnikiem po stylu samouczków społeczności.

Pisanie i przesyłanie samouczka

Gdy Twoja propozycja samouczka zostanie zaakceptowana przez osoby odpowiedzialne za utrzymanie repozytorium, masz kilka opcji edytowania samouczka i przesłania go do repozytorium społeczności Earth Engine:

Szybki start z Markdown

Możesz utworzyć rozwidlenie repozytorium GitHub i utworzyć nowy samouczek bezpośrednio via na stronie GitHub, aby szybko rozpocząć pracę bez dodatkowych narzędzi or konfiguracji:

  1. Jeśli jeszcze tego nie zrobiłeś, zaloguj się na GitHubie.

  2. Aby utworzyć i edytować nowy plik samouczka, kliknij Nowy samouczek. W razie potrzeby pojawi się prośba o utworzenie rozwidlenia repozytorium.

    Nowy samouczek

  3. Wpisz nazwę pliku samouczka w formacie:

    your-tutorial-name/index.md

    gdzie your-tutorial-name to krótka nazwa samouczka w całości pisana małymi literami. Do rozdzielania słów używaj łączników („-”). W nazwie folderu nie używaj spacji ani innych znaków interpunkcyjnych.

  4. Edytuj samouczek bezpośrednio w edytorze plików GitHub, używając „Podgląd”, aby sprawdzić sformatowane dane wyjściowe (zobacz też Edytowanie plików w repozytorium w dokumentacji GitHub).

  5. Gdy skończysz, zatwierdź zmiany i otwórz żądanie pull.

notatnik Colab

Kliknij tutaj, aby rozpocząć pisanie samouczka w Colab:

Nowy samouczek Colab

Spowoduje to otwarcie notatnika zawierającego instrukcje dotyczące tworzenia i przesyłania samouczka.

Zaawansowane

Jeśli znasz już GitHuba, Gita i powiązane narzędzia, ogólny proces przesyłania samouczków w Markdown i Colab jest taki sam:

  1. Utwórz rozwidlenie i skopiuj repozytorium GitHub google/earthengine-community.

  2. Utwórz katalog w folderze tutorials z krótką nazwą samouczka (np. tutorials/my-amazing-tutorial).

  3. Dodaj odpowiedni nagłówek dla Markdown lub Colab.

  4. Zatwierdź samouczek w nowym katalogu z nazwą pliku index.md (w przypadku Markdown) lub tutorial.ipynb (w przypadku Colab). Zatwierdź obrazy użyte w samouczku w tym samym katalogu.

  5. Prześlij nowe treści do swojego rozwidlenia i otwórz żądanie ściągnięcia.

Podczas tworzenia żądania pull w sekcji komentarzy odwołaj się do pierwotnej propozycji, podając numer zgłoszenia na GitHubie. Jeśli na przykład zgłoszenie miało numer 123, w opisie żądania pull umieść tekst „Closes #123”, aby odwołać się do pierwotnej propozycji i automatycznie oznaczyć ją jako zrealizowaną po opublikowaniu samouczka.

Gdy otworzysz żądanie pull, do sprawdzenia Twojego zgłoszenia zostanie przypisana co najmniej jedna osoba odpowiedzialna za utrzymanie repozytorium. Sprawdzający będą współpracować z Tobą, aby upewnić się, że Twoje zgłoszenie jest kompletne, poprawne i zgodne z przewodnikiem po stylu samouczków społeczności Earth Engine.

Gdy Twoje żądanie pull zostanie zatwierdzone, samouczek zostanie opublikowany przez osoby odpowiedzialne za utrzymanie repozytorium.