Atualiza textos na documentação oficial do projeto

docs/en/source/conf.py

@@ -11,14 +11,16 @@
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 
 import os
+from datetime import datetime
+
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
 
 
 # -- Project information -----------------------------------------------------
 
 project = "Querido Diário"
-copyright = "2020, Open Knowledge Brasil"
+copyright = f"2021–{datetime.now().year}, Open Knowledge Brasil"
 author = "Open Knowledge Brasil"
 
 
@@ -32,6 +34,12 @@
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 
+# The suffix of source filenames.
+source_suffix = ".rst"
+
+# The master toctree document.
+master_doc = "index"
+
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #

docs/pt_BR/source/conf.py

@@ -11,14 +11,16 @@
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 
 import os
+from datetime import datetime
+
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
 
 
 # -- Project information -----------------------------------------------------
 
 project = "Querido Diário"
-copyright = "2020, Open Knowledge Brasil"
+copyright = f"2021–{datetime.now().year}, Open Knowledge Brasil"
 author = "Open Knowledge Brasil"
 
 
@@ -32,6 +34,12 @@
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 
+# The suffix of source filenames.
+source_suffix = ".rst"
+
+# The master toctree document.
+master_doc = "index"
+
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #

docs/pt_BR/source/contribuindo/codigo-de-conduta.rst

@@ -0,0 +1,135 @@
+.. este arquivo serve de aporte para o Guia de Contribuição, mas não está referenciado na toctree
+
+:orphan: 
+
+Código de Conduta da Comunidade
+##################################
+
+Nossa promessa
+****************
+
+Como pessoas participantes, colaboradoras e líderes, nós nos comprometemos a fazer
+com que a participação em nossa comunidade seja uma experiência livre de assédio
+e com ambiente seguro para todas as pessoas, independentemente de idade, tamanho
+do corpo, deficiência aparente ou não aparente, etnia, características sexuais, 
+identidade ou expressão de gênero, nível de experiência, educação, situação sócio-econômica,
+nacionalidade, aparência pessoal, raça, religião ou identidade e orientação sexuais.
+
+Comprometemos-nos a agir e interagir de maneiras que contribuam para uma comunidade
+aberta, acolhedora, diversificada, inclusiva e saudável.
+
+Nossos padrões
+****************
+
+Exemplos de comportamentos que contribuem para criar um ambiente positivo para a
+comunidade incluem:
+
+- Demonstrar empatia e bondade com as outras pessoas
+- Respeitar opiniões, pontos de vista e experiências contrárias
+- Dar e receber feedbacks construtivos de maneira respeitosa
+- Assumir responsabilidade, pedir desculpas às pessoas afetadas por nossos erros e aprender com a experiência
+- Focar no que é melhor não só para nós individualmente, mas para a comunidade em geral
+
+Exemplos de comportamentos inaceitáveis incluem:
+
+- Uso de linguagem ou imagens sexualizadas, bem como o assédio sexual ou de qualquer natureza
+- Comentários insultuosos/depreciativos e ataques pessoais ou políticos
+- Assédio público ou privado
+- Publicar informações particulares de outras pessoas, como um endereço de e-mail ou endereço físico, sem a permissão explícita delas
+- Outras condutas que são normalmente consideradas inapropriadas em um ambiente profissional
+
+Responsabilidade de aplicação
+*******************************
+
+A liderança da comunidade é responsável por esclarecer e aplicar nossos padrões 
+de comportamento aceitáveis e tomará ações corretivas apropriadas e justas em resposta
+a qualquer comportamento que considerar impróprio, ameaçador, ofensivo ou problemático.
+
+A liderança da comunidade tem o direito e a responsabilidade de remover, editar 
+ou rejeitar comentários, *commits*, códigos, edições na *wiki*, erros e outras 
+contribuições que não estão alinhadas com este Código de Conduta e irá comunicar 
+as razões por trás das decisões da moderação quando for apropriado.
+
+Escopo
+********
+
+Este Código de Conduta se aplica dentro de todos os espaços da comunidade e também
+se aplica quando uma pessoa estiver representando oficialmente a comunidade em espaços
+públicos. Exemplos de representação da nossa comunidade incluem usar um endereço
+de e-mail oficial, postar em contas oficiais em mídias sociais ou atuar como uma
+pessoa indicada como representante em um evento *online* ou *offline*.
+
+Aplicação
+***********
+
+Casos de comportamento abusivo, de assédio ou de outra forma inaceitável podem ser
+relatados à liderança da comunidade em **[email protected]**, que será responsável
+pela aplicação. Todos os relatos serão revisados e investigadas imediatamente e 
+de maneira justa.
+
+A liderança da comunidade tem a obrigação de respeitar a privacidade e a segurança
+de quem reportar qualquer incidente.
+
+Diretrizes de impacto
+***********************
+
+A liderança da comunidade seguirá estas Diretrizes de impacto na comunidade para
+determinar as consequências de qualquer ação que considerar violadora deste Código
+de Conduta:
+
+1. Ação corretiva
+===================
+
+Impacto na comunidade: Uso de linguagem imprópria ou outro comportamento considerado
+anti-profissional ou repudiado pela comunidade.
+
+Consequência: Aviso escrito e privado da liderança da comunidade, esclarecendo a
+natureza da violação e com a explicação do motivo pelo qual o comportamento era 
+impróprio. Um pedido de desculpas público poderá ser solicitado.
+
+2. Advertência
+================
+
+Impacto na comunidade: Violação por meio de um incidente único ou atitudes repetidas.
+
+Consequência: Advertência com consequências para comportamento repetido. Não poderá 
+haver interações com as pessoas envolvidas, incluindo interações não solicitadas 
+com as pessoas que estiverem aplicando o Código de Conduta, por um período determinado. 
+Isto inclui evitar interações em espaços da comunidade, bem como canais externos 
+como as mídias sociais. A violação destes termos pode levar a um banimento temporário 
+ou permanente.
+
+3. Banimento temporário
+=========================
+
+Impacto na comunidade: Violação grave dos padrões da comunidade, incluindo a persistência 
+do comportamento impróprio.
+
+Consequência: Banimento temporário de qualquer tipo de interação ou comunicação 
+pública com a comunidade por um determinado período. Estarão proibidas as interações 
+públicas ou privadas com as pessoas envolvidas, incluindo interações não solicitadas 
+com as pessoas que estiverem aplicando o Código de Conduta. A violação destes termos 
+pode resultar em um banimento permanente.
+
+4. Banimento permanente
+=========================
+
+Impacto na comunidade: Demonstrar um padrão na violação das normas da comunidade, 
+incluindo a persistência do comportamento impróprio, assédio a uma pessoa ou agressão 
+ou depreciação a classes de pessoas.
+
+Consequência: Banimento permanente de qualquer tipo de interação pública dentro 
+da comunidade.
+
+Atribuição
+************
+
+Este Código de Conduta é adaptado do *Contributor Covenant*, versão 2.0, disponível 
+em https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+As Diretrizes de Impacto na Comunidade foram inspiradas pela Aplicação do código 
+de conduta da Mozilla.
+
+Para obter respostas a perguntas comuns sobre este código de conduta, veja a página 
+de Perguntas Frequentes (FAQ) em https://www.contributor-covenant.org/faq. Traduções 
+estão disponíveis em https://www.contributor-covenant.org/translations.

docs/pt_BR/source/contribuindo/documentacao.rst

@@ -0,0 +1,29 @@
+Documentação 
+###############
+
+A documentação técnica do projeto serve para auxiliar a compreensão de pessoas 
+interessadas, usuárias e desenvolvedoras, registrando informações fundamentais e
+mais profundamente descritas sobre como o Querido Diário funciona e quais recursos 
+oferece.
+
+- **Repositório**: https://github.com/okfn-brasil/querido-diario-comunidade
+- **Como instalar e simular a documentação**: `README`_
+
+Toda a documentação oficial (este *site*!) é gerada a partir dos arquivos ``.rst``
+do repositório, construida com o gerador de documentação `Sphinx`_, usando o tema
+`sphinx-rtd-theme`_ e fica hospedada no serviço `Read The Docs`_.
+
+Cada uma das páginas deste *site*, listadas no menu de navegação, corresponde 
+a um arquivo de mesmo nome no diretório ``/docs``. Também é possível chegar aos 
+arquivos por meio do "Editar no GitHub" presente no topo de todas as páginas. 
+
+.. important::
+    É importante que a documentação esteja atualizada e seja relevante para a comunidade. 
+    Não hesite em contribuir com *pull requests* (PRs) para ajustes, complementos 
+    e adições, além de traduções para outros idiomas.
+
+.. REFERÊNCIAS:
+.. _README: https://github.com/okfn-brasil/querido-diario-comunidade?tab=readme-ov-file#como-executar
+.. _Sphinx: https://www.sphinx-doc.org/en/master/
+.. _sphinx-rtd-theme: https://sphinx-rtd-theme.readthedocs.io/en/stable/
+.. _Read The Docs: https://about.readthedocs.com/?ref=readthedocs.com