From 3106bca61ced849dda092503ed892315b43f8af0 Mon Sep 17 00:00:00 2001 From: andersonid Date: Mon, 29 Sep 2025 12:28:54 -0300 Subject: [PATCH] Docs: Mark outdated documentation files and create documentation index --- AUTO-DEPLOY-GUIDE.md | 2 ++ DEPLOY.md | 2 ++ DOCKERHUB-SETUP.md | 2 ++ DOCUMENTATION.md | 50 +++++++++++++++++++++++++++++++++++++++++ GITHUB-ACTIONS-GUIDE.md | 2 ++ QUICK-START.md | 2 ++ README-DEPLOYMENT.md | 2 ++ 7 files changed, 62 insertions(+) create mode 100644 DOCUMENTATION.md diff --git a/AUTO-DEPLOY-GUIDE.md b/AUTO-DEPLOY-GUIDE.md index 36faf27..8e9477b 100644 --- a/AUTO-DEPLOY-GUIDE.md +++ b/AUTO-DEPLOY-GUIDE.md @@ -4,6 +4,8 @@ Este guia explica como configurar deploy automático após o GitHub Actions criar a imagem no Docker Hub. +**⚠️ NOTA: Este guia está desatualizado. Use o README.md principal para instruções atuais.** + ## 🔍 **SITUAÇÃO ATUAL:** ### ✅ **GitHub Actions (Funcionando):** diff --git a/DEPLOY.md b/DEPLOY.md index 642831b..e886d56 100644 --- a/DEPLOY.md +++ b/DEPLOY.md @@ -2,6 +2,8 @@ Este documento explica como fazer deploy da OpenShift Resource Governance Tool no seu cluster OpenShift. +**⚠️ NOTA: Este guia está desatualizado. Use o README.md principal para instruções atuais.** + ## 📋 Pré-requisitos - Cluster OpenShift 4.x diff --git a/DOCKERHUB-SETUP.md b/DOCKERHUB-SETUP.md index 05171c7..2719b90 100644 --- a/DOCKERHUB-SETUP.md +++ b/DOCKERHUB-SETUP.md @@ -4,6 +4,8 @@ Para o GitHub Actions funcionar com Docker Hub, configure estes secrets: +**⚠️ NOTA: Este guia está desatualizado. Use o README.md principal para instruções atuais.** + ### 1. **DOCKERHUB_USERNAME** - **Nome**: `DOCKERHUB_USERNAME` - **Valor**: `andersonid` diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md new file mode 100644 index 0000000..d90ded0 --- /dev/null +++ b/DOCUMENTATION.md @@ -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) diff --git a/GITHUB-ACTIONS-GUIDE.md b/GITHUB-ACTIONS-GUIDE.md index 0f0b4d7..70828d6 100644 --- a/GITHUB-ACTIONS-GUIDE.md +++ b/GITHUB-ACTIONS-GUIDE.md @@ -4,6 +4,8 @@ O GitHub Actions está configurado para **buildar e fazer push automático** da imagem Docker para o Docker Hub sempre que você fizer push para o repositório. +**⚠️ NOTA: Este guia está desatualizado. Use o README.md principal para instruções atuais.** + ## 🔧 Configuração Necessária ### 1. Secrets do GitHub diff --git a/QUICK-START.md b/QUICK-START.md index 5dfd556..f960a70 100644 --- a/QUICK-START.md +++ b/QUICK-START.md @@ -1,5 +1,7 @@ # 🚀 Quick Start - OpenShift Resource Governance Tool +**⚠️ NOTA: Este guia está desatualizado. Use o README.md principal para instruções atuais.** + ## ⚡ Deploy em 3 Passos ### 1. Clone o Repositório diff --git a/README-DEPLOYMENT.md b/README-DEPLOYMENT.md index 80e0514..97fb9f5 100644 --- a/README-DEPLOYMENT.md +++ b/README-DEPLOYMENT.md @@ -4,6 +4,8 @@ Esta aplicação monitora e analisa recursos (CPU/Memory) de pods em clusters OpenShift, fornecendo validações e recomendações baseadas em melhores práticas. +**⚠️ NOTA: Este guia está desatualizado. Use o README.md principal para instruções atuais.** + ## 🔧 Pré-requisitos - **OpenShift CLI (oc)** instalado e configurado