Editando o manual¶
You can modify the manual by editing local text files. These files are kept in sync with those online via a repository, based on this the server will update the online manual.
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.
Atualização¶
Firstly, make sure that your local copy of the manual is up to date with the online repository using:
make update
Escrevendo¶
Agora você pode fazer edições nos arquivos de documentação, que são arquivos do tipo .rst dentro da pasta manual usando um editor de textos de sua escolha.
Be sure to check the Guias de estilo de escrita for conventions and Guias de estilo para linguagem de marcação to learn how to write in the reStructuredText markup language.
Feliz escrita!
Grandes alterações¶
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).
Antes de fazer quaisquer edições que não são simples e plenamente justificáveis, (por exemplo, como mover pastas), você deverá certificar-se com algum dos mantenedores do manual que a sua contribuição está alinhada com a visão comunitária do manual. Isto assegura a melhor utilização de seu tempo e boa vontade mesmo que seja possível que, por alguma razão, as suas alterações sejam conflitantes e possam ser rejeitadas ou necessitem de uma revisão que consuma uma grande quantidade de tempo. Por exemplo, outra pessoa poderia já estar trabalhando na seção que você deseja alterar, a seção pode estar agendada para ser apagada ou ser atualizada de acordo com um planejamento de alteração no Blender.
A Comunicação rápida e frequente é a chave para obtenção de um ambiente produtivo, para que não sejam desperdiçados esforços de pessoas e para que possamos chegar a um manual do Blender melhor como resultado.
Obtendo ajuda/respostas¶
Caso você ainda esteja em dúvidas sobre uma funcionalidade que deseja documentar, você deve enviar as suas questões para os desenvolvedores Blender responsáveis por esta área ou perguntar em canais não oficiais de suporte no #docs ou #blender-coders canal em Chat.
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.
Preview¶
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.
Envio de arquivos¶
Quando você estiver satisfeito com as suas alterações, você poderá fazer o upload, para que eles estejam no manual online. Inicialmente, isto é feito através da submissão de patches de maneira que alguém possa revisar as suas alterações e fornecer a você feedback. Após esta etapa, você poderá entregar suas alterações diretamente. Este processo está descrito em detalhes na próxima seção.