Онлайн-редактирование

Добро пожаловать! На этой странице объясняется процесс внесения вклада в документацию по Blender’у через наш рабочий процесс онлайн-редактирования. Независимо от того, исправляете ли вы опечатки или добавляете совершенно новые разделы, ваш вклад ценен.

Ниже приводится обзор процесса редактирования в режиме онлайн.

Начало работы

Прежде всего вам понадобится учётная запись на projects.blender.org. Нажмите кнопку „Вход“ и следуйте инструкциям, чтобы создать учётную запись, если её у вас ещё нет.

После входа в систему вы можете начать редактирование прямо из вашего браузера.

Поиск страниц для редактирования

Перейдите к руководству по Blender’у (docs.blender.org/manual) и перейдите на страницу, которую вы хотели бы улучшить (убедитесь, что вы просматриваете версию, находящуюся в разработке (/dev)).

В правом верхнем углу каждой страницы вы найдете ссылку «Edit Page». Нажав на неё, вы попадёте в онлайн-редактор на projects.blender.org.

Внесение изменений

После нажатия «Edit this page» вы увидите текущий исходный код страницы в области редактирования текста. Документация по Blender’у написана с использованием reStructuredText (RST).

Теперь вы можете:

  • Исправлять опечатки и грамматические ошибки.

  • Добавлять недостающие детали или улучшать разъяснения.

Совет

Ознакомьтесь с «руководством по стилю оформления» для получения справки по форматированию руководства.

Предварительный просмотр ваших изменений

В настоящее время онлайн-редактор имеет ограниченную поддержку для предварительного просмотра ваших изменений. Чтобы убедиться в правильности, дважды проверьте произведённое форматирование и обратитесь к аналогичным существующим страницам документации для получения руководства.

Фиксация внесённых изменений

После совершения изменений перейдите в конец страницы:

  • Предоставьте чёткое и краткое изложение ваших изменений в поле сообщения о коммите (например, «Исправлена опечатка в документации по скульптингу»).

  • Выберите «Commit Changes».

Это действие в автоматическом режиме поможет вам создать «пул-реквест» , чтобы отправить ваши изменения на рецензирование.

Пул-реквесты и рецензирования

Когда вы фиксируете свои изменения, они отправляются в качестве пул-реквеста для проверки группой по документации. Рецензенты могут предложить некоторые улучшения или запрашивать дополнительные изменения.

Важно

Оставайтесь на связи! Следите за своей электронной почтой или уведомлениями на projects.blender.org, чтобы оперативно отвечать на комментарии рецензентов.

После одобрения вашего запроса на включение внесённых изменений, – рецензент его объединит, и ваш вклад будет опубликован в онлайн версии руководства.

Лучшей практикой будет

  • Придерживаться фокусированных правок: Одна тема на один пул-реквест.

  • Предоставлять чёткие коммит-сообщения: Составляйте сообщения о фиксациях конкретными.

  • Отзывайтесь оперативно: Активная коммуникация ускоряет обработку рецензий.

Получение помощи

Если вы не уверены в изменениях, форматировании или рабочем процессе, не стесняйтесь задавать вопросы:

Благодарность за помощь в улучшении документации по Blender!