Skip to content

Latest commit

 

History

History
98 lines (62 loc) · 8.22 KB

how-to-contribute.md

File metadata and controls

98 lines (62 loc) · 8.22 KB
Raw

Работа с документацией Yandex Cloud

Чтобы работать с документацией Yandex Cloud, вам потребуется зарегистрироваться на GitHub и создать пул-реквест в репозиторий. Документация написана с помощью расширенного синтаксиса Markdown — YFM. Вы можете использовать любой удобный текстовый редактор с подсветкой синтаксиса.

Создать пул-реквест можно из локальной рабочей копии или прямо из интерфейса GitHub.

Инструменты для работы с документацией

Для локальной работы с документацией Yandex Cloud вам понадобятся клиент Git и текстовый редактор для работы с Markdown.

Клиент Git

Git используется для хранения исходных текстов, контроля версий и отслеживания изменений в документации Yandex Cloud.

Установите интерфейс командной строки для работы с Git:

  • Windows.
  • Linux.
  • Git для macOS входит в состав Xcode Command Line Tools. Выполните в терминале команду git и следуйте инструкциям.

Еще можно использовать клиент с графическим интерфейсом, например SourceTree.

Редакторы для YFM

YFM — это расширенный диалект языка разметки Markdown, который используется в документации Yandex Cloud. Все файлы документации хранятся в формате .md.

Для редактирования Markdown подходят любые текстовые редакторы. Но для удобства можно использовать редакторы с подсветкой синтаксиса, например, Atom, Sublime Text, Notepad++ и подобные.

Работа с локальной копией репозитория

Вы можете вносить правки в документацию Yandex Cloud через интерфейс GitHub или локально.

Чтобы внести правки и отправить их в репозиторий, вам потребуется:

  1. Зарегистрироваться на GitHub.
  2. Создать ответвление (fork) репозитория.
  3. Склонировать репозиторий.
  4. Внести изменения.
  5. Создать пул-реквест.

Создание ответвления

  1. Откройте репозиторий в браузере.
  2. Нажмите кнопку Fork.

Через некоторое время будет создано ответвление репозитория.

Клонирование репозитория

  1. Склонируйте репозиторий одним из способов:

    • Bash:

      1. На странице ответвления нажмите кнопку <> Code.

      2. В открывшемся окне на вкладке HTTPS нажмите ❐, чтобы скопировать ссылку.

      3. Откройте терминал и введите следующую команду:

        git clone <ссылка_на_ответвление_репозитория>

      Все файлы будут загружены на ваш компьютер в директорию по умолчанию. После этого вы можете приступать к работе с документацией.

    • GitHub Desktop:

      1. На странице ответвления нажмите кнопку <> Code.
      2. В открывшемся окне нажмите кнопку Open with GitHub Desktop. Вы перейдете в раздел клонирования репозитория в GitHub Desktop.
      3. Нажмите Choose…, чтобы выбрать каталог, в который нужно клонировать репозиторий.
      4. Нажмите Clone.

  2. Внесите изменения и выполните следующие команды, чтобы загрузить обновленные файлы в репозиторий:

    1. git add -A
    2. git commit -m "<текст комментария к коммиту>"
    3. git push

  3. Создайте пул-реквест из вашего ответвления в основной репозиторий с документацией. На странице вашего ответвления нажмите кнопку Pull request.

  4. В открывшемся окне проверьте изменения и убедитесь, что в пул-реквест не попало ничего лишнего. Нажмите кнопку Create Pull request.

  5. Чтобы ваш пул-реквест был принят, вы должны прочитать «Лицензионное Соглашение Яндекса с Контрибьютором» и подтвердить свое согласие с его условиями. Добавьте в комментарий следующее предложение: I hereby agree to the terms of the CLA available at: https://yandex.ru/legal/cla/?lang=ru. Подробнее о соглашении в файле CONTRIBUTING.md.

Редактирование страницы через интерфейс GitHub

Быстро отредактировать одну страницу документации можно через интерфейс GitHub.

Для внесения правок в несколько документов удобнее склонировать репозиторий и править тексты в редакторе.

Чтобы внести правки в документацию Yandex.Cloud:

  1. Авторизуйтесь на GitHub.
  2. Откройте в документации страницу, на которой вы хотите внести правки, и нажмите значок карандаша.
  3. В интерфейсе GitHub нажмите значок карандаша, чтобы начать редактировать файл.
  4. Внесите нужные правки и опишите изменения в форме внизу страницы. Нажмите кнопку Propose file change.
  5. Откроется экран, на котором можно сравнить внесенные изменения с оригиналом. Если вы видите зеленую надпись Able to merge, то ваши изменения не создают конфликтов. Нажмите кнопку Create pull request.
  6. Если требуется, подробнее опишите изменения.
  7. Чтобы ваш пул-реквест был принят, вы должны прочитать «Лицензионное Соглашение Яндекса с Контрибьютором» и подтвердить свое согласие с его условиями. Добавьте в комментарий следующее предложение: I hereby agree to the terms of the CLA available at: https://yandex.ru/legal/cla/?lang=ru. Подробнее о соглашении в файле CONTRIBUTING.md.
  8. Нажмите кнопку Create pull request.

После этого будет создан пул-реквест. Дождитесь, пока его примут, или внесите дополнительные правки.