#31 | Revisão da página de Config Ambiente

docs/ambiente/configuracao_ambiente.md

@@ -9,40 +9,48 @@ O QD usa podman para sua infra. Para criar um ambiente onde todos os containers
 
 1. Execute  
 
-```
+```bash
 make build
 ```
-2. No Makefile, mude a variável FULL_PROJECT para true
+
+2. No Makefile, mude a variável FULL_PROJECT para `true`
 3. Execute
 
-```
+``` bash
 make setup
 ```
+
 4. Para resolver o problema com o Apache Tike, execute os comandos abaixo:
-```
+
+```bash
 podman image rm --force localhost/okfn-brasil/querido-diario-apache-tika-server 
 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 (raspadores)
 
 1. Copie local.env do repo querido-diario para .env 
 2. Configure o ambiente de desenvolvimento do repo querido-diario
-```
+
+``` bash
 python3 -m venv .venv
 source .venv/bin/activate
 pip install --no-deps -r data\_collection/requirements-dev.txt
 sudo apt-get install pre-commit
 ```
-3. Execute um raspador no repo querido-diario, por exemplo
-```
+
+1. Execute um raspador no repo querido-diario, por exemplo
+
+``` bash
 scrapy crawl rn_natal -a start_date=2024-03-01
 ```
-4. Execute no repo querido-diario-data-processing
-```
+
+1. Execute no repo querido-diario-data-processing
+
+``` bash
 make re-run
 ```
 
@@ -51,11 +59,14 @@ make re-run
 ## Repositório do querido-diario-api
 
 1. Execute 
-```
+
+``` bash
 make build
 ``` 
-2. Execute 
-```
+
+1. Execute 
+
+``` bash
 make re-run
 ```
 
@@ -64,21 +75,23 @@ make re-run
 ## Repositório do querido-diario-backend
 
 1. Configure o ambiente de desenvolvimento do repo querido-diario-backend
-```
+
+```bash
 python3 -m venv .venv
 source .venv/bin/activate
 pip install -r requirements-dev.txt
 python -m cli setup --pod-name querido-diario --migrate --superuser 
 ```
-2. Faça o cadastro do superuser como pedido.
+
+1. Faça o cadastro do superuser como pedido.
 
 #### Com o backend disponível, o frontend que usa API e backend locais também pode ser configurado.
 
 ## Repositório do querido-diario-frontend
 
 1. Aplique esse patch no repo querido-diario-frontend
 
-```
+```bash
 diff --git a/src/app/constants.ts b/src/app/constants.ts
 index 97c93b5..7e38851 100644
 --- a/src/app/constants.ts 
@@ -107,8 +120,7 @@ diff --git a/src/app/services/utils/index.ts b/src/app/services/utils/index.ts i
 +export const educationApi = 'http://localhost:8000/api/'; 
 ```
 
-2. Execute o ambiente de desenvolvimento
-```
+2. Execute o ambiente de desenvolvimento de acordo com os passos descritos no README do repositório querido-diario-frontend.
 
 Pronto! Agora o ambiente está todo configurado.
 
@@ -117,29 +129,30 @@ Pronto! Agora o ambiente está todo configurado.
 Algumas maneiras úteis de usar o ambiente de desenvolvimento:
 
 1. Quer acessar o banco postgres para ver registros de diários oficiais, usuários do backend, etc.?<br>
-    Execute "make shell-database" no repo querido-diario-data-processing e estará na linha de comando psql.
+    Execute `make shell-database` no repo querido-diario-data-processing e estará na linha de comando psql.
 
 2. Quer acessar o motor de busca para ver os índices textuais de diários e excertos temáticos?<br>
-    Execute "curl -k -u admin:admin -X GET "localhost:9200/\_cat/indices?v&pretty=true" 
+    Execute `curl -k -u admin:admin -X GET "localhost:9200/\_cat/indices?v&pretty=true`
 > Outros endpoints  funcionarão  igualmente  de  acordo  com  a  documentação  do  opensearch.
 
 3. Quer acessar o sistema de arquivos para ver onde foram baixados?<br>
-    Acesse  localhost:9000 com  as  credenciais localizadas  no  envvars do repo  querido-diario- data-processing.
+    Acesse  [localhost:9000](http://localhost:9000) com  as  credenciais localizadas  no  envvars do repo  querido-diario- data-processing.
 
 4. Quer baixar mais arquivos de diários e processá-los?<br>
-    Execute outro scrapy crawl no repo querido-diario e então execute make re-run no querido-diario-data-processing novamente. 
+    Execute outro scrapy crawl no repo querido-diario e então execute `make re-run` no querido-diario-data-processing novamente. 
 
 5. No frontend o live reload está habilitado e na API e backend não. Como checar as mudanças?<br>
-    Na API, execute make re-run novamente. No backend, execute python -m cli setup -- pod-name querido-diario.
+    Na API, execute make re-run novamente. No backend, execute `python -m cli setup -- pod-name querido-diario`.
 
 6. Como acessar a documentação da API?<br>
-    Acesse localhost:8080/docs. 
+    Acesse [localhost:8080/docs](http://localhost:8080). 
 
 7. Como acessar o painel de admin do backend?<br>
-    Acesse localhost:8000/api/admin com as credenciais de superuser criadas anteriormente.
+    Acesse [localhost:8000/api/admin](http://localhost:8080/api/admin) com as credenciais de superuser criadas anteriormente.
 
 ## Histórico de versão
 
-| Versão |    Data    |                 Descrição                 |        Responsáveis          |       Revisor        |
-| :----: | :--------: | :---------------------------------------: | :------------------------------------------------------------------------------------------: | :---------------------------------------------: |
-|  1.0   | 08/04/2024  | Criação da estrutura do documento | [Ester Lino](https://github.com/esteerlino)                           |    [Raissa Oliveira](https://github.com/raissamsoliveira) |
+| Versão |    Data    |             Descrição             |                              Responsáveis                               |                        Revisor                         |
+| :----: | :--------: | :-------------------------------: | :---------------------------------------------------------------------: | :----------------------------------------------------: |
+|  1.0   | 08/04/2024 | Criação da estrutura do documento |               [Ester Lino](https://github.com/esteerlino)               | [Raissa Oliveira](https://github.com/raissamsoliveira) |
+|  1.1   | 08/04/2024 |       Revisão para release        | [Arthur Ferreira Rodrigues](https://github.com/ArthurFerreiraRodrigues) |      [Ester Lino](https://github.com/esteerlino)       |