@codigodoleo/wp-kit 2.0.4 → 3.0.1

package/modules/docs/templates/docs/Getting-Started.md

@@ -5,16 +5,19 @@ Guia completo para configurar o ambiente de desenvolvimento local do site Pipefy
 ## 📋 **Pré-requisitos**
 
 ### Obrigatórios
+
 - **[Lando](https://lando.dev/)** (v3.0+) - Ambiente de desenvolvimento local
 - **[Docker](https://docker.com/)** (v20.0+) - Containerização
 - **[Git](https://git-scm.com/)** - Controle de versão
 - **Acesso ao GitLab** - Para download do banco de dados
 
 ### Recomendados
+
 - **[Visual Studio Code](https://code.visualstudio.com/)** - Editor recomendado
 - **[GitLab CLI](https://gitlab.com/gitlab-org/cli)** - Para interação com GitLab
 
 ### Verificação dos Pré-requisitos
+
 ```bash
 # Verificar instalações
 lando version          # v3.0+
@@ -25,6 +28,7 @@ git --version          # Qualquer versão recente
 ## 🏁 **Setup Inicial**
 
 ### 1. **Clone do Repositório**
+
 ```bash
 # SSH (recomendado)
 git clone git@gitlab.com:pipefy/wordpress/pipefy-website.git
@@ -40,6 +44,7 @@ cd pipefy-website
 **⚠️ Importante**: Antes de inicializar o Lando, você precisa baixar o banco de dados de produção.
 
 #### No GitLab:
+
 1. **Acesse**: [CI/CD → Schedules](https://gitlab.com/pipefy/wordpress/pipefy-website/-/pipeline_schedules)
 2. **Execute**: Clique no botão ▶️ (play) no pipeline **"Download Prod Database"**
 3. **Aguarde**: O pipeline executar completamente
@@ -58,6 +63,7 @@ pipefy-website/
 ```
 
 ### 3. **Inicialização do Lando**
+
 ```bash
 # Inicializar ambiente
 lando start
@@ -67,6 +73,7 @@ lando info
 ```
 
 ### 4. **💾 Restauração do Banco de Dados**
+
 ```bash
 # Importar banco de produção ANTES da inicialização
 lando db-import database/production-dump-YYYY-MM-DD.sql
@@ -76,6 +83,7 @@ lando wp db check
 ```
 
 ### 5. **⚡ Configuração WordPress (Tooling Customizado)**
+
 ```bash
 # Usar nosso tooling para inicialização
 lando init-wp --user=seu-email@pipefy.com
@@ -84,6 +92,7 @@ lando init-wp --user=seu-email@pipefy.com
 ```
 
 ### 6. **Verificação do Setup**
+
 ```bash
 # Verificar se WordPress está funcionando
 curl -I https://pipefy.lndo.site
@@ -99,6 +108,7 @@ lando wp post list --post_type=page --posts_per_page=5
 > **📌 Nota Importante**: Sempre que precisar sincronizar seu ambiente local com a produção (dados atualizados, novos conteúdos, etc.), repita os seguintes passos:
 
 ### Processo de Sincronização:
+
 ```bash
 # 1. Download do banco atualizado
 # Repita os passos da seção "Download do Banco de Dados"
@@ -114,6 +124,7 @@ lando wp post list --post_type=page --posts_per_page=5
 ```
 
 ### Quando Sincronizar:
+
 - **🗓️ Semanalmente**: Para ter conteúdo sempre atualizado
 - **🚀 Antes de features**: Que dependem de dados específicos de produção
 - **🔧 Troubleshooting**: Quando houver problemas com dados locais
@@ -121,16 +132,17 @@ lando wp post list --post_type=page --posts_per_page=5
 
 ## 🌐 **Acessos Locais**
 
-| Serviço | URL | Credenciais |
-|---------|-----|-------------|
-| **Site Frontend** | [https://pipefy.lndo.site](https://pipefy.lndo.site) | - |
-| **WordPress Admin** | [https://pipefy.lndo.site/wp-admin](https://pipefy.lndo.site/wp-admin) | Definidas no setup |
-| **Database (phpMyAdmin)** | [https://pipefy.lndo.site:8080](https://pipefy.lndo.site:8080) | Ver `.lando.yml` |
-| **MailHog** | [https://pipefy.lndo.site:8025](https://pipefy.lndo.site:8025) | - |
+| Serviço                   | URL                                                                    | Credenciais        |
+| ------------------------- | ---------------------------------------------------------------------- | ------------------ |
+| **Site Frontend**         | [https://pipefy.lndo.site](https://pipefy.lndo.site)                   | -                  |
+| **WordPress Admin**       | [https://pipefy.lndo.site/wp-admin](https://pipefy.lndo.site/wp-admin) | Definidas no setup |
+| **Database (phpMyAdmin)** | [https://pipefy.lndo.site:8080](https://pipefy.lndo.site:8080)         | Ver `.lando.yml`   |
+| **MailHog**               | [https://pipefy.lndo.site:8025](https://pipefy.lndo.site:8025)         | -                  |
 
 ## 🛠️ **Comandos Essenciais**
 
 ### Lando Básico
+
 ```bash
 # Iniciar ambiente
 lando start
@@ -149,6 +161,7 @@ lando destroy
 ```
 
 ### ⚡ **Toolings Customizados (Configurados no .lando.yml)**
+
 ```bash
 # Inicialização completa do WordPress
 lando init-wp --user=seu-email@pipefy.com
@@ -167,6 +180,7 @@ lando clear-cache
 ```
 
 ### WordPress via Lando
+
 ```bash
 # WP-CLI (todas as ferramentas dentro do container)
 lando wp --help
@@ -178,6 +192,7 @@ lando logs
 ```
 
 ### Database
+
 ```bash
 # Backup usando nosso tooling
 lando backup-db
@@ -196,6 +211,7 @@ lando wp db repair
 ```
 
 ### Ferramentas de Build
+
 ```bash
 # Node.js/NPM dentro do container
 lando node --version
@@ -213,6 +229,7 @@ lando bash -c "cd /app/dist/wp-content/themes/pipefy-2020 && npm run dev"
 ## 📁 **Estrutura de Desenvolvimento**
 
 ### Arquivos Importantes
+
 ```
 pipefy-website/
 ├── 📄 .lando.yml              # ⭐ Configuração com toolings customizados
@@ -233,6 +250,7 @@ pipefy-website/
 ```
 
 ### Workflow de Desenvolvimento
+
 ```bash
 # 1. Sincronizar com produção (quando necessário)
 # Baixar nova versão via GitLab CI/CD → Schedules
@@ -262,6 +280,7 @@ git push origin feature/nova-funcionalidade
 ## 🔧 **Configurações Avançadas**
 
 ### Variáveis de Ambiente
+
 ```bash
 # Copiar arquivo exemplo
 cp .env.example .env
@@ -271,6 +290,7 @@ nano .env
 ```
 
 ### Customizar .lando.yml (se necessário)
+
 ```yaml
 # Exemplo de override local
 # .lando.local.yml
@@ -288,6 +308,7 @@ tooling:
 ```
 
 ### Xdebug (Debugging)
+
 ```bash
 # Habilitar Xdebug
 lando xdebug-on
@@ -302,6 +323,7 @@ lando php -m | grep xdebug
 ## 🎨 **Desenvolvimento do Tema**
 
 ### Estrutura do Tema Pipefy 2020
+
 ```
 themes/pipefy-2020/
 ├── 📄 style.css              # CSS principal
@@ -314,6 +336,7 @@ themes/pipefy-2020/
 ```
 
 ### Build Process (usando nossos toolings)
+
 ```bash
 # Usar toolings customizados (se configurados)
 lando build-theme     # Build de produção
@@ -333,6 +356,7 @@ npm run watch
 ## 🧪 **Testes Locais**
 
 ### Verificações de Saúde
+
 ```bash
 # Testar URLs principais
 curl -I https://pipefy.lndo.site/
@@ -353,6 +377,7 @@ lando wp option get siteurl
 ```
 
 ### Performance Local
+
 ```bash
 # Verificar queries pesadas (Query Monitor plugin)
 # Acessar: https://pipefy.lndo.site/?qm_debug=1
@@ -367,6 +392,7 @@ lando bash -c "tail -f /app/dist/wp-content/debug.log"
 ## 🆘 **Troubleshooting Comum**
 
 ### Problemas com Banco de Dados
+
 ```bash
 # Erro na importação
 lando db-import database/dump.sql --no-autocommit
@@ -386,6 +412,7 @@ lando init-wp --user=seu-email@pipefy.com
 ```
 
 ### Problemas de SSL
+
 ```bash
 # Regenerar certificados SSL
 lando poweroff
@@ -396,6 +423,7 @@ lando info | grep ssl
 ```
 
 ### Problemas de Permissões
+
 ```bash
 # Usar tooling para corrigir permissões (se configurado)
 lando fix-permissions
@@ -407,6 +435,7 @@ lando bash -c "chmod 600 /app/dist/wp-config.php"
 ```
 
 ### Cache Issues
+
 ```bash
 # Usar nosso tooling para limpeza
 lando clear-cache
@@ -422,6 +451,7 @@ lando rebuild -y
 ```
 
 ### Debug e Logs
+
 ```bash
 # Usar nosso tooling para logs em tempo real
 lando logs-live
@@ -490,4 +520,4 @@ Agora que seu ambiente está funcionando:
 ✨ **Ambiente local**: `pipefy.lndo.site`  
 💾 **Banco de dados**: Produção via GitLab CI/CD Schedules  
 🔄 **Sincronização**: Processo repetível para manter ambiente atualizado  
-⚡ **Toolings**: Usando comandos customizados do `.lando.yml`
+⚡ **Toolings**: Usando comandos customizados do `.lando.yml`

package/modules/docs/templates/docs/Infraestrutura.md

@@ -5,11 +5,13 @@ Documentação da infraestrutura do Pipefy Website, incluindo componentes, confi
 ## 🌍 **Visão Geral da Infraestrutura**
 
 ### **Cloud Provider**
+
 - **Provedor**: Oracle Cloud Infrastructure (OCI)
 - **Região**: `[SRE_DETAIL: Especificar região e availability zones]`
 - **Recursos principais**: Compute instances, Load Balancer, Block Storage
 
 ### **Arquitetura de Rede**
+
 - **VPC**: `[SRE_DETAIL: CIDR blocks e subnets configuradas]`
 - **Load Balancer**: OCI Load Balancer
 - **CDN**: CloudFlare
@@ -18,29 +20,33 @@ Documentação da infraestrutura do Pipefy Website, incluindo componentes, confi
 ## 🎛️ **Kubernetes Cluster**
 
 ### **Cluster Configuration**
+
 - **Tipo**: `[SRE_DETAIL: Managed ou self-hosted]`
 - **Versão**: `[SRE_DETAIL: Versão atual do K8s]`
 - **Node Groups**: `[SRE_DETAIL: Tipos de instância e scaling policies]`
 - **Networking**: `[SRE_DETAIL: CNI, Network policies, Ingress controller]`
 
 ### **Namespaces**
-| Namespace | Ambiente | Finalidade |
-|-----------|----------|------------|
-| `website-dev` | Development | Testes contínuos |
-| `website-stg` | Staging | Homologação |
-| `website-prod` | Production | Site oficial |
+
+| Namespace      | Ambiente    | Finalidade       |
+| -------------- | ----------- | ---------------- |
+| `website-dev`  | Development | Testes contínuos |
+| `website-stg`  | Staging     | Homologação      |
+| `website-prod` | Production  | Site oficial     |
 
 ### **Recursos por Ambiente**
-| Recurso | Development | Staging | Production |
-|---------|-------------|---------|------------|
-| **Replicas** | 1 | 1 | `[SRE_DETAIL: Número de réplicas]` |
-| **CPU** | `[SRE_DETAIL: Requests/Limits]` | `[SRE_DETAIL: Requests/Limits]` | `[SRE_DETAIL: Requests/Limits]` |
-| **Memory** | `[SRE_DETAIL: Requests/Limits]` | `[SRE_DETAIL: Requests/Limits]` | `[SRE_DETAIL: Requests/Limits]` |
-| **Storage** | `[SRE_DETAIL: Tamanho PVC]` | `[SRE_DETAIL: Tamanho PVC]` | `[SRE_DETAIL: Tamanho PVC]` |
+
+| Recurso      | Development                     | Staging                         | Production                         |
+| ------------ | ------------------------------- | ------------------------------- | ---------------------------------- |
+| **Replicas** | 1                               | 1                               | `[SRE_DETAIL: Número de réplicas]` |
+| **CPU**      | `[SRE_DETAIL: Requests/Limits]` | `[SRE_DETAIL: Requests/Limits]` | `[SRE_DETAIL: Requests/Limits]`    |
+| **Memory**   | `[SRE_DETAIL: Requests/Limits]` | `[SRE_DETAIL: Requests/Limits]` | `[SRE_DETAIL: Requests/Limits]`    |
+| **Storage**  | `[SRE_DETAIL: Tamanho PVC]`     | `[SRE_DETAIL: Tamanho PVC]`     | `[SRE_DETAIL: Tamanho PVC]`        |
 
 ## 💾 **Persistência de Dados**
 
 ### **Banco de Dados**
+
 - **Tipo**: `[SRE_DETAIL: MySQL managed service ou self-hosted]`
 - **Versão**: `[SRE_DETAIL: Versão do MySQL]`
 - **Configuração**: `[SRE_DETAIL: Instance type, storage, backup policy]`
@@ -48,6 +54,7 @@ Documentação da infraestrutura do Pipefy Website, incluindo componentes, confi
 - **Backup**: `[SRE_DETAIL: Frequência, retenção, restore procedures]`
 
 ### **Armazenamento de Arquivos**
+
 - **WordPress Uploads**: `[SRE_DETAIL: Object Storage ou PVC]`
 - **Assets Estáticos**: CloudFlare CDN
 - **Logs**: `[SRE_DETAIL: Centralized logging solution]`
@@ -56,18 +63,21 @@ Documentação da infraestrutura do Pipefy Website, incluindo componentes, confi
 ## 🔐 **Segurança**
 
 ### **Network Security**
+
 - **Firewall**: `[SRE_DETAIL: Regras de firewall OCI]`
 - **WAF**: CloudFlare Web Application Firewall
 - **DDoS Protection**: CloudFlare
 - **VPN Access**: `[SRE_DETAIL: VPN configuration para acesso interno]`
 
 ### **Authentication & Authorization**
+
 - **RBAC**: `[SRE_DETAIL: Kubernetes RBAC policies]`
 - **Service Accounts**: `[SRE_DETAIL: K8s service accounts configurados]`
 - **Secrets Management**: `[SRE_DETAIL: Kubernetes secrets ou external vault]`
 - **Image Security**: `[SRE_DETAIL: Registry scanning, admission controllers]`
 
 ### **SSL/TLS**
+
 - **Certificados**: `[SRE_DETAIL: Let's Encrypt ou certificados próprios]`
 - **Renovação**: `[SRE_DETAIL: Processo automático de renovação]`
 - **Cipher Suites**: `[SRE_DETAIL: Configurações de segurança SSL]`
@@ -75,18 +85,21 @@ Documentação da infraestrutura do Pipefy Website, incluindo componentes, confi
 ## 📊 **Monitoramento e Observabilidade**
 
 ### **Monitoring Stack**
+
 - **Metrics**: `[SRE_DETAIL: Prometheus, CloudWatch, ou OCI Monitoring]`
 - **Logging**: `[SRE_DETAIL: ELK, Fluentd, ou solução OCI]`
 - **APM**: `[SRE_DETAIL: Application Performance Monitoring solution]`
 - **Dashboards**: `[SRE_DETAIL: Grafana ou OCI Console]`
 
 ### **Alerting**
+
 - **Notification Channels**: `[SRE_DETAIL: Slack, email, PagerDuty]`
 - **Alert Rules**: `[SRE_DETAIL: Métricas críticas e thresholds]`
 - **Escalation**: `[SRE_DETAIL: Escalation policies]`
 - **Runbooks**: `[SRE_DETAIL: Automated remediation procedures]`
 
 ### **Health Checks**
+
 - **Liveness Probes**: `[SRE_DETAIL: Endpoint e configuração]`
 - **Readiness Probes**: `[SRE_DETAIL: Endpoint e configuração]`
 - **External Monitoring**: `[SRE_DETAIL: Uptime monitoring service]`
@@ -94,12 +107,14 @@ Documentação da infraestrutura do Pipefy Website, incluindo componentes, confi
 ## 🔄 **Backup e Disaster Recovery**
 
 ### **Backup Strategy**
+
 - **Database Backups**: `[SRE_DETAIL: Automated backup schedule]`
 - **File System Backups**: `[SRE_DETAIL: PVC snapshot policy]`
 - **Configuration Backups**: `[SRE_DETAIL: K8s manifests backup]`
 - **Cross-Region Backup**: `[SRE_DETAIL: Geographic redundancy]`
 
 ### **Disaster Recovery**
+
 - **RTO (Recovery Time Objective)**: `[SRE_DETAIL: Target recovery time]`
 - **RPO (Recovery Point Objective)**: `[SRE_DETAIL: Acceptable data loss]`
 - **DR Site**: `[SRE_DETAIL: Secondary region or provider]`
@@ -108,12 +123,14 @@ Documentação da infraestrutura do Pipefy Website, incluindo componentes, confi
 ## 🚀 **Performance e Scaling**
 
 ### **Auto Scaling**
+
 - **HPA (Horizontal Pod Autoscaler)**: `[SRE_DETAIL: Métricas e thresholds]`
 - **VPA (Vertical Pod Autoscaler)**: `[SRE_DETAIL: Se habilitado]`
 - **Cluster Autoscaler**: `[SRE_DETAIL: Node scaling policies]`
 - **Load Testing**: `[SRE_DETAIL: Performance benchmarks]`
 
 ### **CDN Configuration**
+
 - **Cache Rules**: `[SRE_DETAIL: CloudFlare cache policies]`
 - **Purge Strategy**: `[SRE_DETAIL: Cache invalidation process]`
 - **Geographic Distribution**: `[SRE_DETAIL: Edge locations]`
@@ -122,12 +139,14 @@ Documentação da infraestrutura do Pipefy Website, incluindo componentes, confi
 ## 🔧 **DevOps Tools**
 
 ### **CI/CD**
+
 - **GitLab CI/CD**: Pipeline configuration
 - **Container Registry**: `[SRE_DETAIL: GitLab Registry ou external]`
 - **Image Scanning**: `[SRE_DETAIL: Security scanning tools]`
 - **Deployment Strategy**: `[SRE_DETAIL: Blue/Green, Rolling, Canary]`
 
 ### **Infrastructure as Code**
+
 - **Terraform**: `[SRE_DETAIL: Estado atual da IaC]`
 - **Kubernetes Manifests**: `[SRE_DETAIL: Estrutura dos manifests]`
 - **Helm Charts**: `[SRE_DETAIL: Planejamento para migração]`
@@ -136,12 +155,14 @@ Documentação da infraestrutura do Pipefy Website, incluindo componentes, confi
 ## 🌐 **Rede e Conectividade**
 
 ### **External Connectivity**
+
 - **Public IPs**: `[SRE_DETAIL: IP addresses e DNS records]`
 - **Domain Management**: `[SRE_DETAIL: DNS provider e configuração]`
 - **API Gateways**: `[SRE_DETAIL: Rate limiting, authentication]`
 - **Third-party Integrations**: `[SRE_DETAIL: External services connectivity]`
 
 ### **Internal Networking**
+
 - **Service Mesh**: `[SRE_DETAIL: Istio, Linkerd, ou similar]`
 - **Network Policies**: `[SRE_DETAIL: Pod-to-pod communication rules]`
 - **Internal DNS**: `[SRE_DETAIL: CoreDNS configuration]`
@@ -150,6 +171,7 @@ Documentação da infraestrutura do Pipefy Website, incluindo componentes, confi
 ## 💰 **Custos e Otimização**
 
 ### **Cost Management**
+
 - **Resource Allocation**: `[SRE_DETAIL: Current resource usage]`
 - **Cost Monitoring**: `[SRE_DETAIL: Billing alerts e budgets]`
 - **Optimization Opportunities**: `[SRE_DETAIL: Right-sizing recommendations]`
@@ -158,11 +180,13 @@ Documentação da infraestrutura do Pipefy Website, incluindo componentes, confi
 ## 🔄 **Migração para Helm (Planejado)**
 
 ### **Current State**
+
 - **Deployment Method**: Kubernetes manifests diretos
 - **Configuration Management**: Kustomize ou similar
 - **Challenges**: `[SRE_DETAIL: Pontos de dor atuais]`
 
 ### **Target State**
+
 - **Helm Version**: 3.x
 - **Chart Structure**: `[SRE_DETAIL: Estrutura planejada]`
 - **Migration Plan**: `[SRE_DETAIL: Cronograma e etapas]`
@@ -171,18 +195,21 @@ Documentação da infraestrutura do Pipefy Website, incluindo componentes, confi
 ## 📋 **Action Items para SRE**
 
 ### **🔴 Crítico (Documentação Necessária)**
+
 - [ ] Especificar configurações de rede (VPC, subnets, security groups)
 - [ ] Detalhar configuração do banco de dados (versão, backup, HA)
 - [ ] Documentar estratégia de monitoramento e alertas
 - [ ] Definir políticas de backup e disaster recovery
 
 ### **🟡 Importante (Melhoria)**
+
 - [ ] Implementar Infrastructure as Code com Terraform
 - [ ] Configurar monitoring stack completo
 - [ ] Estabelecer políticas de auto-scaling
 - [ ] Planejar migração para Helm
 
 ### **🟢 Desejável (Futuro)**
+
 - [ ] Implementar service mesh
 - [ ] Configurar GitOps com ArgoCD
 - [ ] Otimizar custos de infraestrutura
@@ -191,12 +218,14 @@ Documentação da infraestrutura do Pipefy Website, incluindo componentes, confi
 ## 📞 **Contatos e Responsabilidades**
 
 ### **Equipes Responsáveis**
+
 - **SRE Team**: Infraestrutura, monitoramento, DR
 - **DevOps Team**: CI/CD, deployments, automação
 - **Security Team**: Políticas de segurança, compliance
 - **Development Team**: Application requirements, troubleshooting
 
 ### **Escalation**
+
 - **Incidentes P1**: `[SRE_DETAIL: Procedimento de escalação]`
 - **Mudanças de Infraestrutura**: `[SRE_DETAIL: Change management process]`
 - **Emergency Access**: `[SRE_DETAIL: Break-glass procedures]`
@@ -208,4 +237,4 @@ Documentação da infraestrutura do Pipefy Website, incluindo componentes, confi
 🎛️ **Orquestração**: Kubernetes  
 🔄 **Estado**: Migração para Helm planejada  
 📊 **Documentação SRE**: Detalhamentos técnicos necessários  
-🎯 **Próximos passos**: Preenchimento dos `[SRE_DETAIL]` pela equipe especializada
+🎯 **Próximos passos**: Preenchimento dos `[SRE_DETAIL]` pela equipe especializada