Improve docs

.github/workflows/deploy.yml

@@ -36,9 +36,9 @@ jobs:
                   aws-region: ${{ vars.AWS_REGION }}
 
             - name: Update kubeconfig
-              #if: github.ref == 'refs/heads/main' && github.event_name == 'push'
+              if: github.ref == 'refs/heads/main' && github.event_name == 'push'
               run: aws eks update-kubeconfig --name ${{ vars.AWS_EKS_CLUSTER_NAME }} --region ${{ vars.AWS_REGION }}
 
             - name: Deploy to EKS
-              #if: github.ref == 'refs/heads/main' && github.event_name == 'push'
+              if: github.ref == 'refs/heads/main' && github.event_name == 'push'
               run: kubectl apply -f .

.github/workflows/docs.yaml

@@ -35,5 +35,5 @@ jobs:
                   aws-region: ${{ vars.AWS_REGION }}
 
             - name: Sync S3 bucket
-              #if: github.ref == 'refs/heads/main' && github.event_name == 'push'
+              if: github.ref == 'refs/heads/main' && github.event_name == 'push'
               run: aws s3 sync ./site/ s3://${{ vars.AWS_S3_BUCKET_NAME }} --delete

.github/workflows/provision.yaml

@@ -70,5 +70,5 @@ jobs:
               run: exit 1
 
             - name: Terraform Apply
-              #if: github.ref == 'refs/heads/main' && github.event_name == 'push'
+              if: github.ref == 'refs/heads/main' && github.event_name == 'push'
               run: terraform apply -auto-approve -input=false

README.md

@@ -23,6 +23,17 @@
 
 Nosso MVP é uma versão simplificada para fins de demonstração dos requisitos atendidos durante o Hackathon. Compreende um monolito com um banco de dados relacional e uso de serviços serverless na AWS. Toda a infraestrutura descrita em Terraform e a imagem da aplicação são automatizados em nossas pipelines com GitHub Actions, que inclui verificação dos testes e análise estática no SonarCloud.
 
+O MVP inclui:
+
+- documentação abrangente, incluindo de DDD, diagramas C4, etc
+- 15 ADRs cobrindo requisitos não funcionais
+- pipelines para IaC com Terraform e deploy no Kubernetes
+- testes unitários e de integração com Cucumber
+- análise estática para qualidade e segurança
+- uso de EKS, RDS, S3, VPC, Cognito, ECR, KMS, SSM, etc.
+- estimativa de volumetria
+- setup para execução local (Docker Compose, Makefile, etc.)
+
 Projeto no SonarCloud: [https://sonarcloud.io/project/overview?id=FIAP-3SOAT-G15_healthmed-app](https://sonarcloud.io/project/overview?id=FIAP-3SOAT-G15_healthmed-app)
 
 Também criamos uma extensa documentação para suportar uma aplicação escalável e resiliente que atenda a todos os requisitos não funcionais.
@@ -93,7 +104,7 @@ Architectural Decision Records (ADRs):
 
 ### Schema do BD do MVP
 
-[![Schema do BD do MVP](diagrams/db-schema.png)](docs/diagrams/db-schema.png)
+[![Schema do BD do MVP](docs/diagrams/db-schema.png)](docs/diagrams/db-schema.png)
 
 ## CI/CD
 

docs/README.md

@@ -17,6 +17,17 @@
 
 Nosso MVP é uma versão simplificada para fins de demonstração dos requisitos atendidos durante o Hackathon. Compreende um monolito com um banco de dados relacional e uso de serviços serverless na AWS. Toda a infraestrutura descrita em Terraform e a imagem da aplicação são automatizados em nossas pipelines com GitHub Actions, que inclui verificação dos testes e análise estática no SonarCloud.
 
+O MVP inclui:
+
+- documentação abrangente, incluindo de DDD, diagramas C4, etc
+- 15 ADRs cobrindo requisitos não funcionais
+- pipelines para IaC com Terraform e deploy no Kubernetes
+- testes unitários e de integração com Cucumber
+- análise estática para qualidade e segurança
+- uso de EKS, RDS, S3, VPC, Cognito, ECR, KMS, SSM, etc.
+- estimativa de volumetria
+- setup para execução local (Docker Compose, Makefile, etc.)
+
 Projeto no SonarCloud: [https://sonarcloud.io/project/overview?id=FIAP-3SOAT-G15_healthmed-app](https://sonarcloud.io/project/overview?id=FIAP-3SOAT-G15_healthmed-app)
 
 Também criamos uma extensa documentação para suportar uma aplicação escalável e resiliente que atenda a todos os requisitos não funcionais.