Modifica organização de arquivos e completa página inicial e buscador

okfn-brasil · Dec 22, 2023 · 9913d3b · 9913d3b
1 parent 7e20c93
commit 9913d3b
Show file tree

Hide file tree

Showing 14 changed files with 173 additions and 326 deletions.
diff --git a/docs/pt_BR/source/api-publica.rst b/docs/pt_BR/source/api-publica.rst
diff --git a/docs/pt_BR/source/bibliotecas.rst b/docs/pt_BR/source/bibliotecas.rst
diff --git a/docs/pt_BR/source/buscador.rst b/docs/pt_BR/source/buscador.rst
diff --git a/docs/pt_BR/source/conheca.rst b/docs/pt_BR/source/conheca.rst
diff --git a/docs/pt_BR/source/documentacao.rst → ...t_BR/source/contribuindo/documentacao.rst b/docs/pt_BR/source/documentacao.rst → ...t_BR/source/contribuindo/documentacao.rst
diff --git a/docs/pt_BR/source/frontend.rst → docs/pt_BR/source/contribuindo/frontend.rst b/docs/pt_BR/source/frontend.rst → docs/pt_BR/source/contribuindo/frontend.rst
diff --git a/docs/pt_BR/source/guia-de-contribuicao.rst → ...rce/contribuindo/guia-de-contribuicao.rst b/docs/pt_BR/source/guia-de-contribuicao.rst → ...rce/contribuindo/guia-de-contribuicao.rst
diff --git a/docs/pt_BR/source/raspadores.rst → .../pt_BR/source/contribuindo/raspadores.rst b/docs/pt_BR/source/raspadores.rst → .../pt_BR/source/contribuindo/raspadores.rst
diff --git a/docs/pt_BR/source/arquitetura.rst → docs/pt_BR/source/entendendo/arquitetura.rst b/docs/pt_BR/source/arquitetura.rst → docs/pt_BR/source/entendendo/arquitetura.rst
diff --git a/docs/pt_BR/source/entendendo/conheca.rst b/docs/pt_BR/source/entendendo/conheca.rst
@@ -0,0 +1,38 @@
+Conheça o Querido Diário
+*************************
+
+Objetivos
+==========
+
+O **diário oficial** é uma publicação feita pelas esferas da administração pública brasileira, seja federal, estadual ou municipal e dos poderes executivo, legislativo e judiciário, que serve para tornar oficial para a população as ações tomadas pelos poderes.
+
+Ainda que públicos, esses documentos estão, no geral, disponibilizados por meio de arquivos *PDF*, que são formatos que não permitem análise por computador ou consulta em diversas edições ao mesmo tempo.
+
+[+ deserto de dados, município ser mais difícil]
+
+
+Projetos Relacionados
+======================
+
+Com o Querido Diário fazendo o trabalho pesado de coleta de diários oficiais, conheça outros projetos que utilizam dados oferecidos por ele.
+
+`Querido Diário: Tecnologias na Educação`_ 
+-------------------------------------------
+
+Quase metade das matrículas na educação básica pública no Brasil está nos municípios, mas é muito difícil encontrar informações sobre o dia a dia da gestão dessas redes. Por isso, os diários oficiais se tornam uma fonte preciosa de informação — quando não são as únicas. 
+
+O `Querido Diário: Tecnologias na Educação`_ é uma ferramenta capaz de identificar atos relacionados ao universo das tecnologias na educação: atos, normas e decisões sobre infraestrutura, conectividade, robótica, softwares e serviços contratados.
+
+[+ serviço de alertas, + relatórios da OK, + cruzamento CPF]
+
+
+`Diário do Clima`_
+-------------------
+
+O `Diário do Clima`_ é uma plataforma capaz de agregar dados de políticas ambientais para auxiliar na pesquisa dos atos publicados por municípios brasileiros. Monitora-se diários oficiais para identificar os documentos mais relevantes para quem acompanha o tema. Cada ato é categorizado e organizado, de modo que os usuários possam filtrar e receber alertas sobre temas e locais de interesse.
+
+[+ relatórios, + cruzamento CPF]
+
+
+.. REFERÊNCIAS
+.. _Lei de Acesso à Informação: https://www.justica.gov.br/Acesso
diff --git a/docs/pt_BR/source/index.rst b/docs/pt_BR/source/index.rst
@@ -1,37 +1,96 @@
-.. Querido Diário documentation master file, created by
-   sphinx-quickstart on Mon Nov  9 18:32:55 2020.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
 Querido Diário
 ==============
 
-O Querido Diário existe para facilitar o acesso aos **Diários Oficiais 
-do Poder Executivo Municipal**, permitindo que qualquer pessoa pesquise, 
-utilizando palavras-chave e filtros de busca, por informações dentro de diversas 
-publicações e de diferentes municípios ao mesmo tempo.
+O projeto Querido Diário (QD) propõe classificar, contextualizar e expandir a
+informação contida nos **diários oficiais do poder executivo municipal brasileiro**,
+tornando-os disponíveis de forma a permitir sua visualização em formato aberto e
+amigável.
+
+A ferramenta busca facilitar o monitoramento, a análise e a correlação das informações
+publicadas nos diários, fomentando o desenvolvimento da tecnologia para fins cívicos no
+Brasil e promovendo o controle social para encontrar soluções para os desafios do
+contexto público.
+
+Para isso, QD disponibiliza os dados em sua `plataforma web`_, para uso mais comum e 
+pontual por meio de uma interface de busca, e também em sua `API`_ (do inglês, 
+*Application Programming Interface*), para facilitar o desenvolvimento de soluções que
+façam uso dos dados.
+
+Quer entender mais sobre o projeto? :doc:`Continue lendo<entendendo/conheca>`.
+
+Como colaborar
+==============
+
+Doando na `campanha de financiamento recorrente`_
+    Para que sejam possíveis a manutenção da infraestrutura e a realização de eventos e
+    formações de comunidade que mantêm o projeto ativo.
+Doando `diretamente para a OKBR`_
+    Para apoiar a atuação da organização neste e em outros projetos.
+Fazendo :doc:`uso e divulgação<utilizando/buscador>`
+    Para consultar os dados e divulgar seus achados ou até mesmo para uso pessoal.
+Colocando a :doc:`mão na massa<contribuindo/guia-de-contribuicao>`
+    Para quem tem mais conhecimentos técnicos sobre diários oficiais, código, design,
+    etc. (temos vários projetos que precisam de mãos para desenvolvimento).
+Realizando `atividades de ensino ou pesquisa`_
+    Para analisar os dados em publicações jornalísticas ou acadêmicas. Ou auxiliar na
+    compreensão e superação de desafios técnicos em diversas áreas da arquitetura do QD.
+
+Contato
+=======
+
+Você pode entrar em contato com as pessoas engajadas no projeto principalmente por meio
+do servidor do `Discord`_. Ou enviando e-mail para contato ARROBA serenata.ai.
+
+Responsabilidade
+=================
+
+A `Open Knowledge Brasil`_ é a entidade responsável por manter toda a infraestrutura do
+projeto e organizar seu desenvolvimento, contando com a contribuição contínua de pessoas
+voluntárias.
+
+Licenças, Termos de Uso e Política de Privacidade
+--------------------------------------------------
+
+Todas as licensas do Querido Diário são abertas. O código é disponibilizado em
+`repositórios no GitHub`_ sob licença MIT e as informações publicadas na plataforma
+estão sob Creative Commons Atribuição 4.0 Internacional (CC-BY), salvo quando apontada
+outra licença específica no material em questão.
+
+Para mais informações, consulte os `Termos de Uso e Política de Privacidade`_. 
+
+.. REFERÊNCIAS
+.. _plataforma web: https://queridodiario.ok.org.br/
+.. _API: https://queridodiario.ok.org.br/api/docs
+.. _campanha de financiamento recorrente: https://www.catarse.me/queridodiario-okbr
+.. _diretamente para a OKBR: https://ok.org.br/apoie/
+.. _atividades de ensino ou pesquisa: https://ok.org.br/projetos/qd-universidades/
+.. _Discord: https://go.ok.org.br/discord
+.. _Open Knowledge Brasil: https://ok.org.br/
+.. _repositórios no GitHub: https://github.com/okfn-brasil/?q=querido-diario&type=source
+.. _Termos de Uso e Política de Privacidade: https://queridodiario.ok.org.br/privacidade
 
 .. toctree::
    :maxdepth: 3
-   :caption: SOBRE
+   :hidden:
+   :caption: Entendendo o projeto
 
-   conheca
-   arquitetura
+   entendendo/conheca
+   entendendo/arquitetura
 
 .. toctree::
-   :maxdepth: 1
-   :caption: UTILIZE
+   :maxdepth: 3
+   :hidden:
+   :caption: Como utilizar
 
-   buscador
-   api-publica
-   operadores-avancados
-   bibliotecas
+   utilizando/buscador
+   utilizando/api-publica
 
 .. toctree::
-   :maxdepth: 2
-   :caption: CONTRIBUA
+   :maxdepth: 3
+   :hidden:
+   :caption: Como contribuir
 
-   guia-de-contribuicao
-   raspadores
-   frontend
-   documentacao
+   contribuindo/guia-de-contribuicao
+   contribuindo/raspadores
+   contribuindo/frontend
+   contribuindo/documentacao