diff --git a/documentation/content/en/books/fdp-primer/overview/_index.adoc b/documentation/content/en/books/fdp-primer/overview/_index.adoc index 2b72b0c23e..c316176b05 100644 --- a/documentation/content/en/books/fdp-primer/overview/_index.adoc +++ b/documentation/content/en/books/fdp-primer/overview/_index.adoc @@ -1,353 +1,353 @@ --- title: Chapter 1. Overview prev: books/fdp-primer/preface next: books/fdp-primer/tools description: Overview about the FreeBSD Documentation Process tags: ["overview", "FreeBSD Documentation Project", "quick start"] showBookMenu: true weight: 2 params: path: "/books/fdp-primer/overview/" --- [[overview]] = Overview :doctype: book :toc: macro :toclevels: 1 :icons: font :sectnums: :sectnumlevels: 6 :sectnumoffset: 1 :partnums: :source-highlighter: rouge :experimental: :images-path: books/fdp-primer/ ifdef::env-beastie[] ifdef::backend-html5[] :imagesdir: ../../../../images/{images-path} endif::[] ifndef::book[] include::shared/authors.adoc[] include::shared/mirrors.adoc[] include::shared/releases.adoc[] include::shared/attributes/attributes-{{% lang %}}.adoc[] include::shared/{{% lang %}}/teams.adoc[] include::shared/{{% lang %}}/mailing-lists.adoc[] include::shared/{{% lang %}}/urls.adoc[] toc::[] endif::[] ifdef::backend-pdf,backend-epub3[] include::../../../../../shared/asciidoctor.adoc[] endif::[] endif::[] ifndef::env-beastie[] toc::[] include::../../../../../shared/asciidoctor.adoc[] endif::[] Welcome to the FreeBSD Documentation Project (FDP). Quality documentation is crucial to the success of FreeBSD, and we value your contributions very highly. This document describes how the FDP is organized, how to write and submit documentation, and how to effectively use the available tools. Everyone is welcome to contribute to the FDP. Willingness to contribute is the only membership requirement. This primer shows how to: * Understand the role of documentation and its place in the ecosystem. * Identify which parts of FreeBSD are maintained by the FDP. * Install the required documentation tools and files. * Make changes to the documentation. * Submit changes back for review and inclusion in the FreeBSD documentation. [[overview-documentation-ecosystem]] == Documentation in the FreeBSD Ecosystem All documents are for the benefit of their readers, not their writers or caretakers. They should adapt to the reader and not expect the reader to adapt to them. Never blame the reader for: * being unable to make use of a document easily or at all * finding a document confusing * not understanding a document or how to apply it * not finding an explicit answer or successfully bridging gaps (or connecting dots) to reason their way to one Instead, acknowledge that the document is: * inaccessible * confusing * hard to understand or apply * incomplete Then, make the document: * more accessible * less confusing * clearer * more complete Use the following methods: * apply link:https://webaim.org/intro/#principles[accessibility best practices] to correct the problem reported and any similar ones you find * rework or clarify the confusing structure or language * add relevant examples to the part that is hard to understand or apply * fill in the gaps or add the missing stepping stones [[overview-quick-start]] == Quick Start Some preparatory steps must be taken before editing the FreeBSD documentation. First, subscribe to the {freebsd-doc}. Some team members also interact on the `#bsddocs` IRC channel on http://www.efnet.org/[EFnet]. These people can help with questions or problems involving the documentation. [[freebsd-installation-process]] === FreeBSD installation process [.procedure] ==== . Install these packages. The `docproj` _meta-port_ installs all the applications required to do useful work with the FreeBSD documentation. + [source,shell] .... # pkg install docproj .... + . Install a local working copy of the documentation from the FreeBSD repository in [.filename]#~/doc# (see crossref:working-copy[working-copy,The Working Copy]). + [source,shell] .... % git clone https://git.FreeBSD.org/doc.git ~/doc .... + . Edit the documentation files that require changes. If a file needs major changes, consult the mailing list for input. + Review the output and edit the file to fix any problems shown, then rerun the command to find any remaining problems. Repeat until all of the errors are resolved. + . *_Always_* build and review the changes before submitting them. Running `make` in the `documentation` or `website` subdirectories will generate the documentation in HTML format. + [source,shell] .... % make .... + To reduce compile time, only one language can be compiled: + [source,shell] .... % make DOC_LANG=en .... + The build output is stored in [.filename]#~/doc/documentation/public/en/articles/# and [.filename]#~/doc/documentation/public/en/books/#. + . Review the build output and ensure the edits are free from typos, layout problems, or errors. If any errors are found during the build process, edit the problematic files to fix any issues that show up, then run the build command again until all errors are resolved. + . Add all the files with `git add .`, then review the diff with `git diff`. For example: + [source,shell] .... % git add . % git diff --staged .... + Make sure that all required files are included, then commit the change to your local branch and generate a patch with `git format-patch` + [source,shell] .... % git commit % git format-patch origin/main .... + Patch generated with `git format-patch` will include author identity and email addresses, making it easier for developers to apply (with `git am`) and give proper credit. + [IMPORTANT] ====== To make it easier for committers to apply the patch on their working copy of the documentation tree, please generate the [.filename]#.diff# from the base of your documentation tree. ====== + In the example above, changes have been made to the *bsdinstall* portion of the Handbook. + . Submit the patch or diff file using the web-based https://bugs.FreeBSD.org/bugzilla/enter_bug.cgi?product=Documentation[Problem Report] system. If using the web form, enter a Summary of _[patch] short description of problem_. Select the Component `Documentation`. In the Description field, enter a short description of the changes and any important details about them. Use the btn:[Add an attachment] button to attach the patch or diff file. Finally, use the btn:[Submit Bug] button to submit your diff to the problem report system. ==== [[gnu-linux-installation-process]] === GNU/Linux installation process [.procedure] ==== . Install these packages in apt-based systems like Debian or Ubuntu. On other GNU/Linux distributions the package names may change. Consult your distribution's package manager if in doubt. + [source,shell] .... # apt install hugo ruby-asciidoctor ruby-asciidoctor-pdf ruby-rouge git bmake .... + . Install a local working copy of the documentation from the FreeBSD repository in [.filename]#~/doc# (see crossref:working-copy[working-copy,The Working Copy]). + [source,shell] .... % git clone https://git.FreeBSD.org/doc.git ~/doc .... + . Edit the documentation files that require changes. If a file needs major changes, consult the mailing list for input. + Review the output and edit the files to fix any problems shown, then rerun the command to find any remaining problems. Repeat until all of the errors are resolved. + . Always build and test the changes before submitting them. Running `bmake` in the `documentation` or `website` subdirectories will generate the documentation in HTML format. + [source,shell] .... % bmake run LOCALBASE=/usr .... + . Add all the files with `git add .`, then review the diff with `git diff`. For example: + [source,shell] .... % git add . % git diff --staged .... + Make sure that all required files are included, then commit the change to your local branch and generate a patch with `git format-patch` + [source,shell] .... % git commit % git format-patch origin/main .... + Patch generated with `git format-patch` will include author identity and email addresses, making it easier for developers to apply (with `git am`) and give proper credit. + [IMPORTANT] ====== To make it easier for committers to apply the patch on their working copy of the documentation tree, please generate the [.filename]#.diff# from the base of your documentation tree. ====== + . Submit the patch or diff file using the web-based https://bugs.FreeBSD.org/bugzilla/enter_bug.cgi?product=Documentation[Problem Report] system. If using the web form, enter a Summary of _short description of problem_. Select the Component `Documentation`. In the Description field, enter a short description of the problem in the _Summary_ field and add _patch_ to the _Keywords_ field. Use the btn:[Add an attachment] button to attach the patch or diff file. Finally, use the btn:[Submit Bug] button to submit your diff to the problem report system. ==== [[mac-os-installation-process]] === macOS(R) installation process [.procedure] ==== . Install these packages using link:https://brew.sh/[Homebrew] and link:https://rubygems.org/[RubyGem]. + [source,shell] .... $ brew install hugo ruby git bmake .... + . Add Ruby to the Path. + [source,shell] .... $ echo 'export PATH="$(brew --prefix ruby)/bin:$PATH"' >> ~/.zshrc $ echo 'export PATH="$(brew --prefix hugo)/bin:$PATH"' >> ~/.zshrc $ echo 'export GEM_PATH="$(gem environment gemdir)"' >> ~/.zshrc $ echo 'export PATH="${GEM_PATH}/bin:$PATH"' >> ~/.zshrc $ source ~/.zshrc .... . Install the rouge package using RubyGem. + [source,shell] .... $ sudo gem install rouge asciidoctor asciidoctor-pdf asciidoctor-epub3 .... + . Install a local working copy of the documentation from the FreeBSD repository in [.filename]#~/doc# (see crossref:working-copy[working-copy,The Working Copy]). + [source,shell] .... $ git clone https://git.FreeBSD.org/doc.git ~/doc .... + . Edit the documentation files that require changes. If a file needs major changes, consult the mailing list for input. + Review the output and edit the files to fix any problems shown, then rerun the command to find any remaining problems. Repeat until all of the errors are resolved. + . Always build and test the changes before submitting them. Running `bmake` in the `documentation` or `website` subdirectories will generate the documentation in HTML format. + [source,shell] .... -$ bmake run USE_RUBYGEMS=YES RUBY_CMD=$(brew --prefix ruby)/bin/ruby +$ bmake run USE_RUBYGEMS=YES RUBY_CMD="$(brew --prefix ruby)/bin/ruby" HUGO_CMD="$(brew --prefix hugo)/bin/hugo" .... . Add all the files with `git add .`, then review the diff with `git diff`. For example: + [source,shell] .... % git add . % git diff --staged .... + Make sure that all required files are included, then commit the change to your local branch and generate a patch with `git format-patch` + [source,shell] .... % git commit % git format-patch origin/main .... + Patch generated with `git format-patch` will include author identity and email addresses, making it easier for developers to apply (with `git am`) and give proper credit. + [IMPORTANT] ====== To make it easier for committers to apply the patch on their working copy of the documentation tree, please generate the [.filename]#.diff# from the base of your documentation tree. ====== + . Submit the patch or diff file using the web-based https://bugs.FreeBSD.org/bugzilla/enter_bug.cgi?product=Documentation[Problem Report] system. If using the web form, enter a Summary of _short description of problem_. Select the Component `Documentation`. In the Description field, enter a short description of the problem in the _Summary_ field and add _patch_ to the _Keywords_ field. Use the btn:[Add an attachment] button to attach the patch or diff file. Finally, use the btn:[Submit Bug] button to submit your diff to the problem report system. ==== [[overview-doc]] == The FreeBSD Documentation Set The FDP is responsible for four categories of FreeBSD documentation. * _Handbook_: The Handbook is the comprehensive online resource and reference for FreeBSD users. * _FAQ_: The FAQ uses a short question and answer format to address questions that are frequently asked on the various mailing lists and forums devoted to FreeBSD. This format does not permit long and comprehensive answers. * _Manual pages_: The English language system manual pages are usually not written by the FDP, as they are part of the base system. However, the FDP can reword parts of existing manual pages to make them clearer or to correct inaccuracies. * _Web site_: This is the main FreeBSD presence on the web, visible at https://www.freebsd.org/[https://www.FreeBSD.org/] and many mirrors around the world. The web site is typically a new user's first exposure to FreeBSD. Translation teams are responsible for translating the Handbook and web site into different languages. Manual pages are not translated at present. Documentation source for the FreeBSD web site, Handbook, and FAQ is available in the documentation repository at `https://cgit.freebsd.org/doc/`. Source for manual pages is available in a separate source repository located at `https://cgit.freebsd.org/src/`. Documentation commit messages are visible with `git log`. Commit messages are also archived at link:{dev-commits-doc-all}. Web frontends to both of these repositories are available at https://cgit.freebsd.org/doc/[] and https://cgit.freebsd.org/src/[]. Many people have written tutorials or how-to articles about FreeBSD. Some are stored as part of the FDP files. In other cases, the author has decided to keep the documentation separate. The FDP endeavors to provide links to as much of this external documentation as possible. diff --git a/documentation/content/pt-br/books/fdp-primer/overview/_index.adoc b/documentation/content/pt-br/books/fdp-primer/overview/_index.adoc index 3cfbb5b603..605491e080 100644 --- a/documentation/content/pt-br/books/fdp-primer/overview/_index.adoc +++ b/documentation/content/pt-br/books/fdp-primer/overview/_index.adoc @@ -1,327 +1,327 @@ --- description: 'Visão geral sobre o Processo de Documentação do FreeBSD' next: books/fdp-primer/tools params: path: "/books/fdp-primer/overview/" prev: books/fdp-primer/preface showBookMenu: 'true' tags: ["overview", "FreeBSD Documentation Project", "quick start"] title: 'Capítulo 1. Visão Geral' weight: 2 --- [[overview]] = Visão geral :doctype: book :toc: macro :toclevels: 1 :icons: font :sectnums: :sectnumlevels: 6 :sectnumoffset: 1 :partnums: :source-highlighter: rouge :experimental: :images-path: books/fdp-primer/ ifdef::env-beastie[] ifdef::backend-html5[] :imagesdir: ../../../../images/{images-path} endif::[] ifndef::book[] include::shared/authors.adoc[] include::shared/mirrors.adoc[] include::shared/releases.adoc[] include::shared/attributes/attributes-{{% lang %}}.adoc[] include::shared/{{% lang %}}/teams.adoc[] include::shared/{{% lang %}}/mailing-lists.adoc[] include::shared/{{% lang %}}/urls.adoc[] toc::[] endif::[] ifdef::backend-pdf,backend-epub3[] include::../../../../../shared/asciidoctor.adoc[] endif::[] endif::[] ifndef::env-beastie[] toc::[] include::../../../../../shared/asciidoctor.adoc[] endif::[] Seja bem vindo ao Projeto de Documentação do FreeBSD.(FDP). Documentação de boa qualidade é muito importante para o sucesso do FreeBSD, e nós valorizamos muito suas contribuições. Este documento descreve como o FDP é organizado, como escrever e como submeter documentos, e como utilizar de forma efetiva as ferramentas que estão disponíveis. Todos são bem vindos para se juntar ao FDP. A vontade de contribuir é o único requisito de adesão. Este primer mostra como: * Compreender o papel da documentação e seu lugar no ecossistema. * Identificar quais partes do FreeBSD são mantidas pelo FDP. * Instalar as ferramentas e arquivos de documentação necessários. * Realizar alterações na documentação. * Enviar de volta alterações para revisão e inclusão na documentação do FreeBSD. [[overview-documentation-ecosystem]] == Documentação no Ecossistema FreeBSD Todos os documentos são para o benefício de seus leitores, não de seus escritores ou zeladores. Eles devem se adaptar ao leitor e não esperar que o leitor se adapte a eles. Nunca culpe o leitor por: * ser incapaz de fazer uso de um documento facilmente ou de tudo * achar o documento confuso * não entender o documento ou como utilizá-lo * não encontrar uma resposta explícita ou preencher lacunas com sucesso (ou conectando pontos) para raciocinar em direção a uma Em vez disso, reconheça que o documento é: * inacessível * confuso * difícil de entender ou utilizar * incompleto Em seguida, faça o documento: * mais acessível * menos confuso * mais claro * mais completo Use os seguintes métodos: * aplique as link:https://webaim.org/intro/#principles[melhores práticas de acessibilidade] para corrigir o problema relatado e quaisquer outros semelhantes que você encontrar * refazer ou esclarecer a estrutura ou linguagem confusa * adicionar exemplos relevantes para a parte que é difícil de entender ou aplicar * preencha as lacunas ou adicione os degraus que faltam [[overview-quick-start]] == Introdução Algumas etapas preparatórias devem ser seguidas antes de editar a documentação do FreeBSD. Primeiro, se registre na {freebsd-doc}. Alguns membros do time também interagem no IRC, canal `#bsddocs` na rede http://www.efnet.org/[EFnet]. Estas pessoas podem ajudar com questões e problemas envolvendo documentação. [[freebsd-installation-process]] === Processo de instalação do FreeBSD [.procedure] ==== . Instale esses pacotes. O _meta-port_ `docproj` instala todos os aplicativos necessários para editar e compilar a documentação do FreeBSD. + [source, shell] .... # pkg install docproj .... + . Obtenha uma cópia local da árvore de documentação do FreeBSD em [.filename]#~/doc# (ver crossref:working-copy[working-copy,A Área de Trabalho]). + [source, shell] .... % git clone https://git.FreeBSD.org/doc.git ~/doc .... + . Edite os arquivos de documentação que precisam de alterações. Se um arquivo precisar de grandes mudanças, consulte a lista de discussão para obter informações. + Revise a saída e edite o arquivo para corrigir os problemas informados e, em seguida, execute novamente o comando para verificar os problemas restantes. Repita até que todos os erros sejam resolvidos. + . *_Sempre_* realize testes de compilação e revise as alterações antes de submeter algo. Execute `make` no diretório `documentation` ou `website` para gerar a documentação no formato HTML. + [source, shell] .... % make .... + Para reduzir o tempo de compilação, apenas um idioma pode ser compilado: + [source, shell] .... % make DOC_LANG=en .... + A saída da compilação é armazenada em [.filename]#~/doc/documentation/public/en/articles/# e [.filename]#~/doc/documentation/public/en/books/#. + . Revise a saída da compilação e certifique-se de que as edições não contenham erros de digitação, problemas de layout ou erros. Se algum erro for encontrado durante o processo de compilação, edite os arquivos com erro para corrigir quaisquer problemas que apareçam e, em seguida, execute o comando de compilação novamente até que todos os erros sejam resolvidos. + . Adicione todos os arquivos com `git add .`, então revise o diff com `git diff`. Por exemplo: + [source, shell] .... % git add . % git diff --staged .... + Certifique-se de que todos os arquivos necessários estejam incluídos, então confirme a mudança em seu branch local e gere um patch com `git format-patch` + [source, shell] .... % git commit % git format-patch origin/main .... + Patch gerado com `git format-patch` incluirá a identidade do autor e endereços de e-mail, tornando mais fácil para os desenvolvedores aplicarem (com `git am`) e dar os devidos créditos. + [IMPORTANT] ====== Para tornar mais fácil para os committers aplicarem o patch em sua cópia de trabalho da árvore de documentação, por favor, gere o [.filename]#.diff# da base de sua árvore de documentação. ====== + No exemplo acima, foram feitas alterações na parte [.filename]#bsdinstall# do Handbook. + . Submeta o patch or arquivo diff pela web para o sistema de https://bugs.FreeBSD.org/bugzilla/enter_bug.cgi?product=Documentation[Relatórios de Problema]. Se estiver usando o formulário web, insira um Sumário com _[patch] descrição curta do problema_. Selecione o Componente `Documentation`. No campo de Descrição, insira uma breve descrição das alterações e quaisquer detalhes importantes sobre elas. Use o botão btn:[Add an attachment] para anexar o patch ou arquivo diff. Finalmente, pressione o botão btn:[Submit Bug] para enviar seu diff para o sistema de relatório de problemas. ==== [[gnu-linux-installation-process]] === Processo de instalação GNU/Linux [.procedure] ==== . Instale esses pacotes em sistemas baseados em apt como Debian ou Ubuntu. Em outras distribuições GNU/Linux os nomes dos pacotes podem mudar. Consulte o gerenciador de pacotes da sua distribuição em caso de dúvida. + [source, shell] .... # apt install hugo ruby-asciidoctor ruby-asciidoctor-pdf ruby-rouge git bmake .... + . Obtenha uma cópia local da árvore de documentação do FreeBSD em [.filename]#~/doc# (ver crossref:working-copy[working-copy,A Área de Trabalho]). + [source, shell] .... % git clone https://git.FreeBSD.org/doc.git ~/doc .... + . Edite os arquivos de documentação que precisam de alterações. Se um arquivo precisar de grandes mudanças, consulte a lista de discussão para obter informações. + Revise a saída e edite os arquivos para corrigir os problemas informados e, em seguida, execute novamente o comando para verificar os problemas restantes. Repita até que todos os erros sejam resolvidos. + . Sempre compile e teste as alterações antes de enviá-las. A execução de `bmake` nos subdiretórios `documentation` ou `website` irá gerar a documentação em formato HTML. + [source, shell] .... % bmake run LOCALBASE=/usr .... + . Adicione todos os arquivos com `git add .`, então revise o diff com `git diff`. Por exemplo: + [source, shell] .... % git add . % git diff --staged .... + Certifique-se de que todos os arquivos necessários estejam incluídos, então confirme a mudança em seu branch local e gere um patch com `git format-patch` + [source, shell] .... % git commit % git format-patch origin/main .... + Patch gerado com `git format-patch` incluirá a identidade do autor e endereços de e-mail, tornando mais fácil para os desenvolvedores aplicarem (com `git am`) e dar os devidos créditos. + [IMPORTANT] ====== Para tornar mais fácil para os committers aplicarem o patch em sua cópia de trabalho da árvore de documentação, por favor, gere o [.filename]#.diff# da base de sua árvore de documentação. ====== + . Submeta o patch ou arquivo diff file pela web para o sistema de https://bugs.FreeBSD.org/bugzilla/enter_bug.cgi?product=Documentation[Relatórios de Problema]. Se estiver usando o formulário web, insira um Sumário com uma _breve descrição do problema_. Selecione o Componente `Documentation`. No campo de Descrição, insira uma breve descrição das alterações e quaisquer detalhes importantes sobre elas e adicione _patch_ no campo _Keywords_. Use o botão btn:[Add an attachment] para anexar o patch ou arquivo diff. Finalmente, pressione o botão btn:[Submit Bug] para enviar seu diff para o sistema de relatório de problemas. ==== [[mac-os-installation-process]] === Processo de instalação do macOS(R) [.procedure] ==== . Instale esses pacotes usando o link:https://brew.sh/[Homebrew] e o link:https://rubygems.org/[RubyGem]. + [source, shell] .... $ brew install hugo ruby git bmake .... + . Adicione o Ruby ao Path. + [source, shell] .... $ echo 'export GEM_PATH="/usr/local/lib/ruby/gems/3.1.0"' >> ~/.zshrc $ echo 'export PATH="$(brew --prefix ruby)/bin:$PATH"' >> ~/.zshrc $ source ~/.zshrc .... + . Adicione o alias do git ao Homebrew, pois `git format-patch` do git fornecido pela Apple não funcionará com o Phabricator. + [source, shell] .... $ echo 'alias git=/usr/local/bin/git' >> ~/.zshrc $ source ~/.zshrc .... . Instale o pacote rouge usando RubyGem. + [source, shell] .... $ sudo gem install rouge asciidoctor asciidoctor-pdf asciidoctor-epub3 .... + . Obtenha uma cópia local da árvore de documentação do FreeBSD em [.filename]#~/doc# (ver crossref:working-copy[working-copy,A Área de Trabalho]). + [source, shell] .... $ git clone https://git.FreeBSD.org/doc.git ~/doc .... + . Edite os arquivos de documentação que precisam de alterações. Se um arquivo precisar de grandes mudanças, consulte a lista de discussão para obter informações. + Revise a saída e edite os arquivos para corrigir os problemas informados e, em seguida, execute novamente o comando para verificar os problemas restantes. Repita até que todos os erros sejam resolvidos. + . Sempre compile e teste as alterações antes de enviá-las. A execução de `bmake` nos subdiretórios `documentation` ou `website` irá gerar a documentação em formato HTML. + [source, shell] .... -$ bmake run USE_RUBYGEMS=YES RUBY_CMD=$(brew --prefix ruby)/bin/ruby +$ bmake run USE_RUBYGEMS=YES RUBY_CMD="$(brew --prefix ruby)/bin/ruby" HUGO_CMD="$(brew --prefix hugo)/bin/hugo" .... . Adicione todos os arquivos com `git add .`, então revise o diff com `git diff`. Por exemplo: + [source, shell] .... % git add . % git diff --staged .... + Certifique-se de que todos os arquivos necessários estejam incluídos, então confirme a mudança em seu branch local e gere um patch com `git format-patch` + [source, shell] .... % git commit % git format-patch origin/main .... + Patch gerado com `git format-patch` incluirá a identidade do autor e endereços de e-mail, tornando mais fácil para os desenvolvedores aplicarem (com `git am`) e dar os devidos créditos. + [IMPORTANT] ====== Para tornar mais fácil para os committers aplicarem o patch em sua cópia de trabalho da árvore de documentação, por favor, gere o [.filename]#.diff# da base de sua árvore de documentação. ====== + . Submeta o patch ou arquivo diff file pela web para o sistema de https://bugs.FreeBSD.org/bugzilla/enter_bug.cgi?product=Documentation[Relatórios de Problema]. Se estiver usando o formulário web, insira um Sumário com uma _breve descrição do problema_. Selecione o Componente `Documentation`. No campo de Descrição, insira uma breve descrição das alterações e quaisquer detalhes importantes sobre elas e adicione _patch_ no campo _Keywords_. Use o botão btn:[Add an attachment] para anexar o patch ou arquivo diff. Finalmente, pressione o botão btn:[Submit Bug] para enviar seu diff para o sistema de relatório de problemas. ==== [[overview-doc]] == Conjunto de Documentação do FreeBSD O FDP é responsável por quatro categorias de documentação do FreeBSD. * _Handbook_: O Handbook almeja ser um compreensivo recurso de referência online para os usuários do FreeBSD. * _FAQ_: O FAQ utiliza um formato curto de pergunta e resposta para abordar dúvidas que são frequentemente realizadas nas listas de discussão e fóruns dedicados ao FreeBSD. Este formato não permite respostas longas e detalhadas. * _Páginas de Manual_: As páginas de manual do sistema de língua inglesa geralmente não são escritas pelo FDP, pois fazem parte do sistema base. Contudo, o FDP pode reformular partes das páginas de manual existentes para torná-las mais claras ou para corrigir imprecisões. * _Web site_: Esta é a presença principal do FreeBSD na web, visite https://www.freebsd.org/[https://www.FreeBSD.org/] e muitos mirrors ao redor do mundo. O site é tipicamente o primeiro contato de um usuário novo com o FreeBSD. As equipes de tradução são responsáveis por traduzir o manual e o site para diferentes idiomas. As páginas do manual não são traduzidas no momento. Código fonte do site do FreeBSD, Handbook, e FAQ estão disponíveis no repositório de documentação em `https://cgit.freebsd.org/doc/`. Código fonte das páginas de manual estão disponíveis em um repositório diferente localizado em `https://cgit.freebsd.org/src/`. As mensagens de commit de documentação podem ser visualizadas com `git log`. As mensagens de commit também são arquivadas em link:{dev-commits-doc-all}. Endereço web para ambos os repositórios disponíveis em https://cgit.freebsd.org/doc/[] e https://cgit.freebsd.org/src/[]. Muitas pessoas tem escrito tutoriais e artigos how-to sobre FreeBSD. Alguns são armazenados como parte dos arquivos FDP. Em outros casos, o autor decidiu manter a documentação separada. O FDP esforça-se para fornecer links para o máximo possível dessas documentações externas.