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

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

The manual is written in the reStructuredText (RST) markup language and can be edited using a plain text editor. For a local preview, you convert (build) the manual source files from RST into HTML web pages.

Обновление

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

make update

Написание

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

Be sure to check the Руководство по стилю написания for conventions and Руководство по стилю оформления to learn how to write in the reStructuredText markup language.

Счастливой писанины!

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

If you are going to add or overhaul a section, be sure to check carefully that it does not already exist. In some places, the docs are so disorganized that sections may be duplicated or in a strange location. In the case that you find a duplicate or out of place section, create an issue explaining the issue, and optionally include a revision (actual changes).

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

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

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

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

Blender itself has a system of module owners with developer and artist members who are responsible for the design and maintenance of the assigned Blender areas. See the module pages for more information.

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

To view your changes, build the manual as instructed. Keep in mind that you can also build only the chapter you just edited to view it quickly. Open the generated .html files inside the build/html folder using your web browser, or refresh the page if you have it open already.

Загрузка

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