Перейти к содержанию

Как предложить правку

Можно исправить опечатку, уточнить инструкцию, добавить источник или написать новую статью. Для отправки изменений нужен аккаунт GitHub.

Исправить существующую статью

  1. Откройте нужную статью на этом сайте.
  2. Нажмите ✏️ «Редактировать страницу» рядом с заголовком. На узком экране расположение кнопки может отличаться.
  3. Войдите в GitHub, если он попросит авторизоваться.
  4. Измените текст в открывшемся .md-файле. Если GitHub предложит создать fork — вашу копию репозитория — подтвердите.
  5. Нажмите Commit changes или Propose changes — подпись зависит от ваших прав и интерфейса GitHub. Кратко объясните изменение.
  6. Создайте Pull Request кнопкой Create pull request. Если GitHub предлагает сравнить изменения, сначала нажмите Compare & pull request.

Владелец посмотрит изменения, при необходимости задаст вопросы и примет их кнопкой Merge. После успешной автоматической сборки сайт обновится. Время зависит от очереди и публикации; фиксированный срок не гарантируется.

Для владельца

Чтобы правка прошла тот же процесс проверки, при сохранении выберите новую ветку и создание Pull Request. Прямой коммит в основную ветку тоже запускает публикацию.

Как узнать статус правки

Откройте свой Pull Request на GitHub. Во вкладке Checks виден результат автоматической проверки: сайт должен собраться без ошибок, а внутренние ссылки — вести на существующие страницы. Зелёная проверка помогает владельцу оценить правку, но не заменяет проверку содержания.

После Merge ход публикации можно посмотреть во вкладке Actions репозитория. Когда она успешно завершится, откройте изменённую статью на сайте.

Предложить новую статью

  1. Откройте репозиторий вики.
  2. Создайте свою копию кнопкой Fork, если у вас нет права записи.
  3. В каталоге docs/materials/ выберите Add file → Create new file.
  4. Назовите файл коротко, например useful-topic.md, и заполните его по шаблону.
  5. Добавьте ссылку на статью в docs/materials/index.md.
  6. Отправьте Pull Request. При проверке владелец при необходимости добавит статью в боковое меню.

Перед отправкой

  • Проверьте, что такую статью ещё не написали.
  • Пишите понятно и по существу, оставляйте ссылки на источники.
  • Публикуйте собственный текст или материал, который разрешено распространять.
  • Не добавляйте пароли, ключи, личные переписки и чужие персональные данные.

Подробнее: Оформление статей.