Atualizando a documentação | Sprints 10, 11 e 12; Ata 5, Sidebar e Co…

…nfiguração do ambiente
ResidenciaTICBrisa · Jul 5, 2024 · 18186e9 · 18186e9
1 parent 1f878ff
commit 18186e9
Show file tree

Hide file tree

Showing 6 changed files with 178 additions and 9 deletions.
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -26,11 +26,15 @@
     - [Sprint 07](/equipe/sprints/sprint7.md)
     - [Sprint 08](/equipe/sprints/sprint8.md)
     - [Sprint 09](/equipe/sprints/sprint9.md)
+    - [Sprint 10](/equipe/sprints/sprint10.md)
+    - [Sprint 11](/equipe/sprints/sprint11.md)
+    - [Sprint 12](/equipe/sprints/sprint12.md)
 - [Reuniões](/equipe/reunioes/atas.md)
     - [Ata 01](/equipe/reunioes/ata1.md)
     - [Ata 02](/equipe/reunioes/ata2.md)
     - [Ata 03](/equipe/reunioes/ata3.md)
     - [Ata 04](/equipe/reunioes/ata4.md)
+    - [Ata 05](/equipe/reunioes/ata5.md)
 - [Landing Page](/docs/T2G4-Querido-Diario/docs/equipe/landingPage.html)
 
 <!--**Tópico Auxiliar**

diff --git a/docs/ambiente/configuracao_ambiente.md b/docs/ambiente/configuracao_ambiente.md
@@ -47,11 +47,10 @@ podman pull ghcr.io/okfn-brasil/querido-diario-apache-tika-server:latest
 make apache-tika-server
 ```
 
-```
-
 #### Agora o pod foi criado, assim como vários recursos como Opensearch, Postgres e Minio. Porém, eles ainda estão vazios. Vamos populá-los.
 
-## Repositório do querido-diario (raspadores)
+
+## Repositório do querido-diario
 
 1. Copie local.env do repo querido-diario para .env 
 
@@ -115,11 +114,6 @@ python -m cli setup --pod-name querido-diario --migrate --superuser
 ```bash
 wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh
 source ~/.bashrc        # para aplicar o script de instalação do nvm ao bash
-
-nvm install v16.2.0
-npm install --global yarn
-cd <raiz_do_repo_frontend>
-yarn
 ``` 
 
 1. Aplique esse patch no repo querido-diario-frontend
@@ -140,6 +134,18 @@ yarn
 
 2. Execute o ambiente de desenvolvimento de acordo com os passos descritos no README do repositório querido-diario-frontend.
 
+``` bash
+nvm install v16.2.0
+npm install --global yarn
+yarn
+``` 
+Com o terminal aberto no diretório raíz do repositório, o projeto pode ser servido localmente com o comando:
+
+``` bash
+yarn ng serve
+``` 
+
+
 Pronto! Agora o ambiente está todo configurado.
 
 # Usando o ambiente
@@ -176,4 +182,5 @@ Algumas maneiras úteis de usar o ambiente de desenvolvimento:
 |  1.1   | 08/04/2024 |       Revisão para release        | [Arthur Ferreira Rodrigues](https://github.com/ArthurFerreiraRodrigues) |      [Ester Lino](https://github.com/esteerlino)       |
 |  1.2   | 23/04/2024 | Atualização do documento e inclusão do erro com a porta 8000 |               [Ester Lino](https://github.com/esteerlino)               | [Raissa Oliveira](https://github.com/raissamsoliveira) |
 |  1.3   | 25/05/2024 | Atualização do documento incluindo detalhes do podman, apache tika, ordem dos comandos no raspador e comando para instalar o nvm |               [Cristian Furtado](https://github.com/csafurtado)               | [Ester Lino](https://github.com/esteerlino) |
-|  1.4   | 26/06/2024 | Conserto da ordem de execução dos comandos do data-processing |               [Cristian Furtado](https://github.com/csafurtado)               | [Ester Lino](https://github.com/esteerlino) |
+|  1.4   | 26/06/2024 | Conserto da ordem de execução dos comandos do data-processing |               [Cristian Furtado](https://github.com/csafurtado)               | [Ester Lino](https://github.com/esteerlino) |
+|  1.5   | 05/07/2024 | Ajuste de erros no documento e correção da ordem de execução dos comandos do front-end |               [Raissa Oliveira](https://github.com/raissamsoliveira)          | [Ester Lino](https://github.com/esteerlino) |
diff --git a/docs/equipe/reunioes/ata5.md b/docs/equipe/reunioes/ata5.md
@@ -0,0 +1,44 @@
+# Ata da Reunião 5
+
+### **1. Identificação**
+
+| Data       | Hora de início | Hora de Término | Local           | Redator(es)               | Projeto        |
+| ---------- | -------------- | --------------- | --------------- | --------------------- | -------------- |
+| 04-07-2024 | 10:00          | 11:30           | Discord         | Raissa Oliveira | Reunião com o Cliente |
+
+| Convocados                                | Presente | Área/Empresa | E-mail                                 |
+| ----------------------------------------- | -------- | ------------ | -------------------------------------- | 
+| 1. Cristian Furtado                       | ✅       | Discente     | E-mail: <[email protected]>  |
+| 2. Ester Lino                             | ✅       | Discente     | E-mail: <[email protected]>         |
+| 3. Pedro Cabeceira                        | ✅       | Discente     | E-mail: <[email protected]>      |
+| 4. Raissa Oliveira                        | ✅       | Discente     | E-mail: <[email protected]> |
+
+
+### **2. Pauta**
+
+| N°  | Descrição                                                        |
+| --- | ---------------------------------------------------------------- |
+| 1   | Reajuste das tarefas da US 3  |
+| 2   | Ficaram definidos alguns pontos relacionados a task da compactação e agregação de dados, como: |
+* Quebrar em várias funções (verificar condicionais, deixar as funções em até 2 níveis de identações)
+* Deixar a busca por ano mais abstrata: consultar qual o ano mais antigo do território atual, evitando consultas desnecessárias - analisar o processamento computacional.
+* Criar XML já formatado para download, utilizando python3.9
+* Criar a função para coletar todos os diários por estado
+
+
+### **3. Pendências Anteriores**
+
+| N°  | Pendência                              |
+| --- | -------------------------------------- |
+
+### **4. Compromissos**
+
+| N°  | Compromisso          | Responsável     |
+| --- | -------------------- | --------------- | 
+
+
+## Histórico de Versão
+
+| Versão |    Data    |                 Descrição                 |        Responsáveis          |       Revisor        |
+| :----: | :--------: | :---------------------------------------: | :------------------------------------------------------------------------------------------: | :---------------------------------------------: |
+|  1.0   | 05/07/2024  | Ata da Reunião 05  | [Raissa Oliveira](https://github.com/raissamsoliveira)          |  [Cristian Furtado](https://github.com/csafurtado)   |
diff --git a/docs/equipe/sprints/sprint10.md b/docs/equipe/sprints/sprint10.md
@@ -0,0 +1,38 @@
+# Sprint 10
+
+- Data de início: 02/06/2024
+- Data de término: 15/06/2024
+
+## Objetivos da sprint
+* Implementação das US1 e US2 no Querido Diário - aceite final do PR. 
+* Início de desenvolvimento da história de usuário 03 (US3)
+
+## Backlog da Sprint
+|**US**|**Responsáveis**|
+|--------|-------------|
+| [US-1](https://github.com/ResidenciaTICBrisa/T2G4-Querido-Diario/issues/4) | [Ester Lino](https://github.com/esteerlino), [Raissa Oliveira](https://github.com/raissamsoliveira) e [Wildemberg Sales](https://github.com/wildemberg-sales) |
+| [US-2](https://github.com/ResidenciaTICBrisa/T2G4-Querido-Diario/issues/2) | [Arthur Ferreira](https://github.com/ArthurFerreiraRodrigues), [Cristian Furtado](https://github.com/csafurtado) e [Pedro Cabeceira](https://github.com/pkbceira03) |
+| [US-3](https://github.com/ResidenciaTICBrisa/T2G4-Querido-Diario/issues/15) | [Arthur Ferreira](https://github.com/ArthurFerreiraRodrigues), [Cristian Furtado](https://github.com/csafurtado), [Ester Lino](https://github.com/esteerlino), [Pedro Cabeceira](https://github.com/pkbceira03), [Raissa Oliveira](https://github.com/raissamsoliveira) e [Wildemberg Sales](https://github.com/wildemberg-sales) |
+
+## Outras atividades
+|**Atividade**|**Responsáveis**|
+|--------|-------------|
+| [Issue 26](https://github.com/ResidenciaTICBrisa/T2G4-Querido-Diario/issues/26) | [Arthur Ferreira](https://github.com/ArthurFerreiraRodrigues) e [Cristian Furtado](https://github.com/csafurtado) |
+| [Issue 28](https://github.com/ResidenciaTICBrisa/T2G4-Querido-Diario/issues/28) |  [Pedro Cabeceira](https://github.com/pkbceira03) e [Wildemberg Sales](https://github.com/wildemberg-sales)  |
+| [Issue 29](https://github.com/ResidenciaTICBrisa/T2G4-Querido-Diario/issues/28) | [Ester Lino](https://github.com/esteerlino) e [Raissa Oliveira](https://github.com/raissamsoliveira) |
+
+## Duplas/Pareamento
+|**Dupla 1**|**Dupla 2**|**Dupla 3**|
+|-----------|-----------|-----------|
+| [Arthur Ferreira](https://github.com/ArthurFerreiraRodrigues) | [Pedro Cabeceira](https://github.com/pkbceira03) | [Ester Lino](https://github.com/esteerlino) |
+| [Cristian Furtado](https://github.com/csafurtado) | [Wildemberg Sales](https://github.com/wildemberg-sales) | [Raissa Oliveira](https://github.com/raissamsoliveira) |
+
+## Retrospectiva da sprint 
+* Após todas as correções realizadas na US1 e US2, o cliente aprovou a implementação final das funcionalidades de download na página geral e no portal educação do Querido Diário [Issue #262](https://github.com/okfn-brasil/querido-diario-frontend/pull/262)
+* Iniciamos o desenvolvimento da página de Dados, referente a US3, seguindo o protótipo criado no Figma. 
+
+## Histórico de versão
+
+| Versão |    Data    |   Descrição   |       Responsáveis        |                     Revisor                     |
+| :----: | :--------: | :-----------: | :-----------------------: | :---------------------------------------------: |
+|  1.0   | 05/07/2024  | Adicionando documento da Sprint 10 | [Raissa Oliveira](https://github.com/raissamsoliveira)                           |    [Ester Lino](https://github.com/esteerlino)|
diff --git a/docs/equipe/sprints/sprint11.md b/docs/equipe/sprints/sprint11.md
@@ -0,0 +1,39 @@
+# Sprint 11
+
+- Data de início: 16/06/2024
+- Data de término: 29/06/2024
+
+## Objetivos da sprint
+* Desenvolvimento da história de usuário 03 (US3): 
+    * **API** | Criação de rota na API para consumo da lista de arquivos agregados e compactados 
+    * **FRONT** | Criação da página de download dos arquivos agregados
+    * **DATA-PROCESSING** | Criar Job para agregação dos arquivos das cidades já cadastradas 
+
+
+## Backlog da Sprint
+|**US**|**Responsáveis**|
+|--------|-------------|
+| [US-3](https://github.com/ResidenciaTICBrisa/T2G4-Querido-Diario/issues/15) | [Arthur Ferreira](https://github.com/ArthurFerreiraRodrigues), [Cristian Furtado](https://github.com/csafurtado), [Ester Lino](https://github.com/esteerlino), [Pedro Cabeceira](https://github.com/pkbceira03), [Raissa Oliveira](https://github.com/raissamsoliveira) e [Wildemberg Sales](https://github.com/wildemberg-sales) |
+
+## Outras atividades
+|**Atividade**|**Responsáveis**|
+|--------|-------------|
+| [Issue 26](https://github.com/ResidenciaTICBrisa/T2G4-Querido-Diario/issues/26) | [Arthur Ferreira](https://github.com/ArthurFerreiraRodrigues) e [Cristian Furtado](https://github.com/csafurtado) |
+| [Issue 28](https://github.com/ResidenciaTICBrisa/T2G4-Querido-Diario/issues/28) |  [Pedro Cabeceira](https://github.com/pkbceira03) e [Wildemberg Sales](https://github.com/wildemberg-sales)  |
+| [Issue 29](https://github.com/ResidenciaTICBrisa/T2G4-Querido-Diario/issues/28) | [Ester Lino](https://github.com/esteerlino) e [Raissa Oliveira](https://github.com/raissamsoliveira) |
+
+## Duplas/Pareamento
+|**Dupla 1**|**Dupla 2**|**Dupla 3**|
+|-----------|-----------|-----------|
+| [Arthur Ferreira](https://github.com/ArthurFerreiraRodrigues) | [Pedro Cabeceira](https://github.com/pkbceira03) | [Ester Lino](https://github.com/esteerlino) |
+| [Cristian Furtado](https://github.com/csafurtado) | [Wildemberg Sales](https://github.com/wildemberg-sales) | [Raissa Oliveira](https://github.com/raissamsoliveira) |
+
+## Retrospectiva da sprint 
+* Finalizada a criação da [P0 | Dados agregados e compactados](https://www.figma.com/design/PTRrSgLiz6DOlkYwA3Tt6Q/Prot%C3%B3tipo-para-a-p%C3%A1gina-%22Tecnologia-na-Educa%C3%A7%C3%A3o%22?node-id=416-6&t=BNnCpDpNmojNy1q0-0), referente ao download do Dicionário de Dados.
+* Criada a rota na API, referente a Issue 28.
+
+## Histórico de versão
+
+| Versão |    Data    |   Descrição   |       Responsáveis        |                     Revisor                     |
+| :----: | :--------: | :-----------: | :-----------------------: | :---------------------------------------------: |
+|  1.0   | 05/07/2024  | Adicionando documento da Sprint 11 | [Raissa Oliveira](https://github.com/raissamsoliveira)                           |    [Ester Lino](https://github.com/esteerlino)|
diff --git a/docs/equipe/sprints/sprint12.md b/docs/equipe/sprints/sprint12.md
@@ -0,0 +1,37 @@
+# Sprint 12
+
+- Data de início: 30/06/2024
+- Data de término: 13/07/2024
+
+## Objetivos da sprint
+* Desenvolvimento da história de usuário 03 (US3): 
+    * **FRONT** | Criação da página de download dos arquivos agregados
+    * **DATA-PROCESSING** | Criar Job para agregação dos arquivos das cidades já cadastradas 
+
+
+## Backlog da Sprint
+|**US**|**Responsáveis**|
+|--------|-------------|
+| [US-3](https://github.com/ResidenciaTICBrisa/T2G4-Querido-Diario/issues/15) | [Arthur Ferreira](https://github.com/ArthurFerreiraRodrigues), [Cristian Furtado](https://github.com/csafurtado), [Ester Lino](https://github.com/esteerlino), [Pedro Cabeceira](https://github.com/pkbceira03), [Raissa Oliveira](https://github.com/raissamsoliveira) e [Wildemberg Sales](https://github.com/wildemberg-sales) |
+
+## Outras atividades
+|**Atividade**|**Responsáveis**|
+|--------|-------------|
+| [Issue 26](https://github.com/ResidenciaTICBrisa/T2G4-Querido-Diario/issues/26) | [Arthur Ferreira](https://github.com/ArthurFerreiraRodrigues), [Cristian Furtado](https://github.com/csafurtado) e [Wildemberg Sales](https://github.com/wildemberg-sales) |
+| [Issue 29](https://github.com/ResidenciaTICBrisa/T2G4-Querido-Diario/issues/28) | [Ester Lino](https://github.com/esteerlino),  [Raissa Oliveira](https://github.com/raissamsoliveira) e [Pedro Cabeceira](https://github.com/pkbceira03) |
+
+## Duplas/Pareamento
+|**Dupla 1**|**Dupla 2**|**Dupla 3**|
+|-----------|-----------|-----------|
+| [Arthur Ferreira](https://github.com/ArthurFerreiraRodrigues) | [Pedro Cabeceira](https://github.com/pkbceira03) | [Ester Lino](https://github.com/esteerlino) |
+| [Cristian Furtado](https://github.com/csafurtado) | [Wildemberg Sales](https://github.com/wildemberg-sales) | [Raissa Oliveira](https://github.com/raissamsoliveira) |
+
+## Retrospectiva da sprint 
+* Desenvolvimento da  [P1 e P2 | Página de busca por estado e município](https://www.figma.com/design/PTRrSgLiz6DOlkYwA3Tt6Q/Prot%C3%B3tipo-para-a-p%C3%A1gina-%22Tecnologia-na-Educa%C3%A7%C3%A3o%22?node-id=416-6&t=BNnCpDpNmojNy1q0-0).
+
+
+## Histórico de versão
+
+| Versão |    Data    |   Descrição   |       Responsáveis        |                     Revisor                     |
+| :----: | :--------: | :-----------: | :-----------------------: | :---------------------------------------------: |
+|  1.0   | 05/07/2024  | Adicionando documento da Sprint 12 | [Raissa Oliveira](https://github.com/raissamsoliveira)                           |    [Ester Lino](https://github.com/esteerlino)|