Docs: Mark outdated documentation files and create documentation index
This commit is contained in:
50
DOCUMENTATION.md
Normal file
50
DOCUMENTATION.md
Normal file
@@ -0,0 +1,50 @@
|
||||
# 📚 Documentação - OpenShift Resource Governance Tool
|
||||
|
||||
## 🎯 Documentação Atual
|
||||
|
||||
### ✅ **Documentação Ativa (Atualizada)**
|
||||
- **[README.md](README.md)** - 📖 **Documentação principal e completa**
|
||||
- **[AIAgents-Support.md](AIAgents-Support.md)** - 🤖 Suporte para agentes de IA
|
||||
|
||||
### ⚠️ **Documentação Desatualizada (Referência)**
|
||||
- [AUTO-DEPLOY-GUIDE.md](AUTO-DEPLOY-GUIDE.md) - Deploy automático (desatualizado)
|
||||
- [GITHUB-ACTIONS-GUIDE.md](GITHUB-ACTIONS-GUIDE.md) - GitHub Actions (desatualizado)
|
||||
- [README-DEPLOYMENT.md](README-DEPLOYMENT.md) - Guia de deploy (desatualizado)
|
||||
- [DOCKERHUB-SETUP.md](DOCKERHUB-SETUP.md) - Configuração Docker Hub (desatualizado)
|
||||
- [DEPLOY.md](DEPLOY.md) - Deploy no OpenShift (desatualizado)
|
||||
- [QUICK-START.md](QUICK-START.md) - Quick Start (desatualizado)
|
||||
|
||||
## 🚀 Como Usar
|
||||
|
||||
### Para Usuários
|
||||
1. **Leia o [README.md](README.md)** - Documentação completa e atualizada
|
||||
2. **Use o script de deploy**: `./scripts/deploy-complete.sh`
|
||||
|
||||
### Para Desenvolvedores
|
||||
1. **Leia o [README.md](README.md)** - Instruções de desenvolvimento
|
||||
2. **Consulte [AIAgents-Support.md](AIAgents-Support.md)** - Contexto do projeto
|
||||
|
||||
## 📋 Status da Documentação
|
||||
|
||||
| Arquivo | Status | Última Atualização | Observações |
|
||||
|---------|--------|-------------------|-------------|
|
||||
| README.md | ✅ Ativo | 2025-01-27 | Documentação principal atualizada |
|
||||
| AIAgents-Support.md | ✅ Ativo | 2025-01-27 | Suporte para IA agents |
|
||||
| AUTO-DEPLOY-GUIDE.md | ⚠️ Desatualizado | - | Menciona daemonset, scripts antigos |
|
||||
| GITHUB-ACTIONS-GUIDE.md | ⚠️ Desatualizado | - | Nome da imagem incorreto |
|
||||
| README-DEPLOYMENT.md | ⚠️ Desatualizado | - | Menciona daemonset, scripts antigos |
|
||||
| DOCKERHUB-SETUP.md | ⚠️ Desatualizado | - | Nome da imagem incorreto |
|
||||
| DEPLOY.md | ⚠️ Desatualizado | - | Menciona daemonset, scripts antigos |
|
||||
| QUICK-START.md | ⚠️ Desatualizado | - | Menciona daemonset, scripts antigos |
|
||||
|
||||
## 🔄 Próximos Passos
|
||||
|
||||
1. **Manter README.md atualizado** como fonte única da verdade
|
||||
2. **Considerar remover arquivos desatualizados** em versão futura
|
||||
3. **Atualizar AIAgents-Support.md** conforme necessário
|
||||
|
||||
## 📞 Suporte
|
||||
|
||||
- **Documentação principal**: [README.md](README.md)
|
||||
- **Issues**: [GitHub Issues](https://github.com/andersonid/openshift-resource-governance/issues)
|
||||
- **Suporte IA**: [AIAgents-Support.md](AIAgents-Support.md)
|
||||
Reference in New Issue
Block a user