Редактирование руководства

Вы можете изменять руководство, редактируя локальные текстовые файлы. Эти файлы синхронизируются с файлами в хранилище на сервере, на основе которых собирается онлайн-руководство.

Руководство написано на языке разметки reStructuredText (RST) и может быть отредактировано с помощью обычного текстового редактора. Для локального предварительного просмотра вы конвертируете (собираете) исходные файлы руководства из RST в веб-страницы HTML.

Обновление

Во-первых, убедитесь, что ваша локальная копия руководства обновлена до последней версии онлайн-репозитория, используя:

make update

Написание

Теперь вы можете редактировать файлы документации, расположенные в папке manual, вашим любимым текстовым редактором, поскольку они являются обычными текстовыми файлами с расширением .rst.

Обязательно ознакомьтесь с руководством по стилю написания условных обозначений и с руководством по стилю оформления, чтобы узнать, как писать на языке разметки reStructuredText.

Приятного чтения!

Большие изменения

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

Перед тем, как выполнить любое нетривиальное редактирование (например, перемещение каталогов), вам следует уточнить у того, кто поддерживает руководство, согласуется ли такое изменение с концепцией руководства. Это позволит наиболее эффективным образом использовать ваше время и усилия. В противном случае, ваши изменения могут быть отклонены, либо потребуют время на проведение длительного ревью. Например, другой участник проекта уже работает над разделом, который вы собираетесь изменить, или раздел планируется удалить, либо обновить согласно плановым изменениям в Blender’е.

Своевременная и частая коммуникация между участниками является ключом к продуктивному окружению, усилия людей не распыляются и в результате всё идёт только на пользу руководству по Blender’у.

Получение помощи/ответов

Если у вас есть сомнения относительно функциональности, которую вы хотите задокументировать, вы должны задать свои вопросы разработчикам Blender’а, ответственным за эту область, или задать их на неофициальном канале поддержки пользователей в канале #docs или #blender-coders в чате Blender’а.

Сам Blender имеет систему владельцев модулей с разработчиками и художниками, которые отвечают за дизайн и обслуживание назначенных областей Blender’а. См. страницу владельцев модулей для получения дополнительной информации.

Предварительный просмотр (preview)

Для просмотра изменений, сделайте сборку руководства как было указано в инструкции. Имейте в виду, что вы также можете собрать только ту главу, которую вы только что отредактировали, чтобы быстро её просмотреть. Откройте сгенерированные .html файлы внутри папки build/html с помощью веб-браузера или обновите страницу, если она уже открыта.

Загрузка

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