Этот раздел предназначен для пользователей Earth Engine, желающих поделиться своими знаниями с остальным сообществом Earth Engine. Созданные пользователями Earth Engine для пользователей Earth Engine, руководства в этом разделе рассчитаны на пользователей всех уровней, от начинающих до более продвинутых.
Учебные материалы можно представлять в виде простого текста и кода, отформатированных с использованием языка разметки Markdown, или в виде блокнотов Colab, содержащих Markdown и исполняемый код Python. Учебные материалы, созданные с использованием клиентских библиотек JavaScript Earth Engine, обычно пишутся на Markdown, а для учебных материалов, основанных на клиентских библиотеках Python Earth Engine, рекомендуется использовать Colab.
Прежде чем начать
Нормы поведения
The Earth Engine team is committed to fostering a harassment-free and inclusive community. Please familiarize yourself with our Code of Conduct before contributing.
Присоединение к GitHub
Учебные материалы сообщества Earth Engine публикуются и проверяются через GitHub. Если у вас еще нет учетной записи GitHub, вам необходимо сначала создать ее по адресу https://github.com/join.
Предложение по проведению учебного занятия
Прежде чем вкладывать значительное время и усилия в создание нового руководства, потенциальным участникам предлагается представить простое предложение с основной информацией. Это позволяет авторам сотрудничать с разработчиками документации Earth Engine, чтобы сосредоточить усилия на руководствах, которые принесут наибольшую пользу сообществу пользователей Earth Engine. Это также экономит время, избегая возможных споров в процессе рецензирования.
Первая настройка
If this is the first time you're submitting a tutorial to the Earth Engine community GitHub repository, be sure to complete these steps before starting work on your tutorial:
Примите Лицензионное соглашение участника (CLA) по адресу:
https://cla.developers.google.com
Ознакомьтесь и усвойте Руководство по стилю оформления учебных материалов сообщества .
Написание и отправка учебного пособия
После того как ваше предложение по созданию учебного пособия будет принято сопровождающими проекта, у вас будет несколько вариантов редактирования пособия и его отправки в репозиторий сообщества Earth Engine:
Быстрый старт в Markdown
Вы можете создать форк репозитория GitHub и создать новый учебный материал непосредственно на веб-сайте GitHub, чтобы быстро начать работу без дополнительных инструментов или настройки:
Если вы еще этого не сделали, войдите в GitHub .
To create and edit a new tutorial file, click New tutorial . You'll be prompted to fork the repository, if needed.
Введите имя для файла с учебным материалом в форме:
your-tutorial-name/index.mdГде
your-tutorial-name— это краткое название вашего учебного пособия, написанное строчными буквами. Используйте дефисы ("-") для разделения слов. Не используйте пробелы или другие знаки препинания в названии папки.Редактируйте свой учебный материал непосредственно в файловом редакторе GitHub, используя функцию «Предварительный просмотр», чтобы проверить отформатированный результат (см. также раздел «Редактирование файлов в вашем репозитории » в документации GitHub).
Когда будете готовы, зафиксируйте изменения и создайте запрос на слияние (pull request).
Блокнот Colab
Нажмите здесь, чтобы начать создавать обучающие материалы в Colab:
Откроется блокнот с инструкциями по созданию и отправке вашего учебного пособия.
Передовой
Если вы уже знакомы с GitHub, Git и аналогичными инструментами, то общий процесс отправки как Markdown-файлов, так и руководств Colab одинаков:
Создайте форк и клонируйте репозиторий google/earthengine-community на GitHub.
Создайте в папке
tutorialsкаталог с сокращенным названием вашего урока (например,tutorials/my-amazing-tutorial).Зафиксируйте изменения в учебном пособии в новой директории, указав имя файла
index.md(для Markdown) илиtutorial.ipynb(для Colab). Изображения, использованные в учебном пособии, также зафиксируйте в той же директории.Загрузите новый контент в свой форк и создайте запрос на слияние (pull request) .
При создании запроса на слияние (pull request) обязательно укажите в комментариях номер исходного предложения в GitHub, используя его номер. Например, если это было предложение #123, то в описании запроса на слияние следует указать текст "Закрывает #123", чтобы сослаться на исходное предложение и автоматически отметить запрос как выполненный после публикации руководства.
После того, как вы создадите запрос на слияние (pull request), одному или нескольким сопровождающим проекта будет назначен рецензент для проверки вашей работы. Рецензент(ы) будут работать с вами, чтобы убедиться, что ваша работа является полной, корректной и соответствует руководству по стилю сообщества Earth Engine .
После одобрения вашего запроса на слияние (pull request) ваш учебный материал будет опубликован сопровождающими репозитория.