VPS 4 Deploy Agent
43 lines
2.5 KiB
Markdown
43 lines
2.5 KiB
Markdown
# LEIA PRIMEIRO
|
|
|
|
> Documentação **única e oficial** da stack (Clube67 / ScoreOdonto e demais projetos).
|
|
> Repositório (fonte da verdade): **`git.clube67.com/ruicesar/Documentos-Unicos`**.
|
|
> **Leia este arquivo antes de qualquer outra coisa.**
|
|
|
|
---
|
|
|
|
## Regras obrigatórias
|
|
|
|
1. **Idioma: PORTUGUÊS.** Tudo — explicações, documentos, comentários, commits, conversas — em português. Sem exceção.
|
|
|
|
2. **Fonte única.** Este repositório é a documentação oficial e vigente. Qualquer `.md` fora daqui que divergir **não vale**.
|
|
|
|
3. **Uma situação = um arquivo.** Organização em **pastas por tipo**; dentro, **um `.md` por situação**. **Nunca** misturar situações num mesmo arquivo. Situação nova = arquivo novo (ou pasta nova de tipo).
|
|
|
|
4. **Atualizar = REESCREVER o arquivo da situação** (nunca "v2" ao lado). O arquivo descreve o **estado ATUAL real**, nunca o desejado.
|
|
|
|
5. **Versão antiga → `desuso/`.** Antes de reescrever, copie a versão anterior para `desuso/` com data no nome e aviso **EM DESUSO** no topo.
|
|
|
|
6. **Cada projeto só tem um `LEIA.md`** na raiz, que **aponta** para este repositório — **nunca** guarda documentação própria espalhada.
|
|
|
|
7. **`desuso/` é só CONSULTA.** Em dúvida, **consulte o `desuso/`** para entender o histórico / tirar dúvida ou como base para **corrigir/melhorar**. Mas ele **nunca** é instrução vigente: **toda instrução nova ou atualizada vai na doc oficial** (fora do `desuso/`).
|
|
|
|
8. **Sempre testar em `https://dev.<projeto>`** antes de qualquer coisa.
|
|
|
|
9. **Sempre pedir aprovação** do administrador antes de ir para **produção** ou implementar **novas melhorias/implementações**.
|
|
|
|
10. **Antes de anotar, checar duplicação.** Verifique se o tema **já existe** aqui — não duplicar. **Prefira sempre doc UNIVERSAL** (serve a todos os projetos). Se um projeto **for diferente**: **cite o que o torna diferente** e crie a doc específica dele em `projetos/<projeto>/` — para a **doc universal ficar sempre alinhada** (não poluída com exceções).
|
|
|
|
---
|
|
|
|
## Organização deste repositório
|
|
|
|
| Pasta | Conteúdo |
|
|
|---|---|
|
|
| `deploy/` | Deploy (universal): `modelo`, `subir-release`, `rollback`, `versionamento`. |
|
|
| `infra/` | Infraestrutura (universal): `maquinas-e-rede`, `ambiente-dev`. |
|
|
| `projetos/<projeto>/` | **Só o que DIFERE** do universal, por projeto (cita o delta + referencia o universal). |
|
|
| `desuso/` | Histórico/obsoletos (datado, "EM DESUSO"). Só consulta. |
|
|
|
|
> Tipo de assunto novo (ex.: segurança, banco, monitoramento)? Crie uma **pasta nova** aqui com os `.md` das situações.
|