Metadados e rodapé da documentação (hub)
Modelo do Pages do meta-repo:
- Badges no índice (e páginas que quiserem): branch, versão, maturidade, status, public.
- Frontmatter no
.md(fica no fonte GitHub/IDE; não gera faixa no HTML). - Rodapé gerado no HTML a partir de
docs/_site.yaml+ Git.
Gerador: scripts/build-docs-site.py · config: ../_site.yaml.
Badges (índice)
Ordem padrão:
| Badge | Exemplo |
|---|---|
| branch | develop |
| versão | 0.7.07.X |
| maturidade | MVP |
| status | oficial |
| public | interno |
Convenções da plataforma
| Campo | Regra | Exemplo |
|---|---|---|
| Versão | Três primeiros blocos A.B.C; build é o 4º (YYYYMMDDN). Na doc exibir A.B.C.X |
0.7.07.X |
| Maturidade | Qualitativa, não repetir a versão | MVP |
| Auth | Padrão híbrido (JWT ECOSIF + Azure) — no rodapé, não em badge | híbrido (ECOSIF_JWT + Azure) |
Prefixo hub- |
Proibido em badges, versão e labels | usar ecosif / 0.7.07.X |
Frontmatter (opcional no arquivo; recomendado)
No topo do arquivo (metadados de fonte; não renderiza faixa no Pages):
---
doc_status: oficial
owner: José Augusto L. Pereira
audience: desenvolvedores
confidentiality: interno
review_due: 2026-12-31
title: Título opcional da aba do browser
---
| Campo | Valores sugeridos | Onde aparece |
|---|---|---|
doc_status |
oficial · rascunho · legado · interno |
Fonte (+ badge status se colocado no MD) |
owner |
Nome/papel responsável | Fonte |
audience |
Público-alvo | Fonte |
confidentiality |
publico · interno · confidencial |
Fonte (+ badge public se colocado no MD) |
review_due |
YYYY-MM-DD |
Fonte |
title |
string | <title> HTML (senão usa o # do MD) |
Config do site (docs/_site.yaml): maturity, version (linha A.B.C), default_branch, auth_mode, stack_* — entram no rodapé de todas as páginas HTML.
Rodapé gerado (todas as páginas HTML)
| Campo | Origem |
|---|---|
Projeto · MVP · A.B.C.X |
_site.yaml (project, maturity, version → display .X) |
| Auth híbrido · Java · Angular · branch | _site.yaml |
| Alterado em / por / SHA | git log -1 do arquivo sob docs/ |
| Gerado em (UTC) | horário do build (CI ou local) |
| Início · Pages · Editar no GitHub | links gerados |
CI
O workflow .github/workflows/pages-docs.yml usa fetch-depth: 0 para o histórico Git alimentar data/autor/SHA.