Descrição
O projeto SEI-Docker carece de documentação técnica centralizada. As informações sobre
configuração, uso e arquitetura estão espalhadas em arquivos README dentro de subpastas
(infra/docs/, dev/, containers/) e não cobrem o projeto de forma abrangente.
Proposta
Criar uma pasta docs/ na raiz do projeto com documentação técnica completa, incluindo:
- README.md - Índice com links para todos os documentos
- arquitetura.md - Diagrama de serviços, hierarquia de imagens, fluxo de inicialização
- containers.md - Referência dos 44+ containers Docker organizados por categoria
- variaveis-ambiente.md - Referência das 230+ variáveis de ambiente por categoria
- orquestracao.md - Docker Compose, Kubernetes, Makefile targets
- desenvolvimento.md - Setup do ambiente dev, XDebug, troca de banco, troubleshooting
- testes.md - Níveis de teste, matriz de combinações, Selenium
- guia-de-uso.md - Guia unificado de instalação, configuração e uso
Motivação
- Facilitar a adoção do projeto por novos contribuidores e órgãos
- Consolidar informações dispersas em um único local
- Documentar variáveis de ambiente que hoje só são encontradas lendo o código-fonte
Descrição
O projeto SEI-Docker carece de documentação técnica centralizada. As informações sobre
configuração, uso e arquitetura estão espalhadas em arquivos README dentro de subpastas
(infra/docs/, dev/, containers/) e não cobrem o projeto de forma abrangente.
Proposta
Criar uma pasta
docs/na raiz do projeto com documentação técnica completa, incluindo:Motivação