Pular para o conteúdo
duxt

Publicar documentação de um provider Terraform

Transformar uma árvore Markdown do tfplugindocs numa referência versionada com navegação própria do provider.

O tfplugindocs já escreve Markdown. O duxt não o processa como outro artefacto gerado, mas como uma fonte cujas convenções de ficheiros e títulos transportam mais estrutura do que um manual comum.

Passos

  1. Gera a documentação no repositório do provider. Mantém a árvore docs/ e as suas pastas provider, resources, data sources, functions e guides. O duxt não executa o tfplugindocs durante a build do Nuxt.
  2. Declara o repositório como dialeto de fonte.
    sources: [{
  repo: 'acme/terraform-provider-acme',
  path: 'docs',
  slug: 'terraform',
  name: 'Terraform Provider',
  flavor: 'tfplugindocs',
  releases: { select: 'minor' }
}]
  3. Escolhe as versões cujos URLs devem permanecer. releases usa as mesmas políticas all, minor e major que qualquer fonte. Um { tag } explícito fixa uma versão; um branch pode publicar documentação futura.
  4. Constrói o site e verifica a navegação. O duxt deriva o título do primeiro H1, ordena as categorias conhecidas e conserva subcategorias como estrutura em vez de inventar páginas. Pesquisa, locales, versões e leitores automáticos continuam a usar as mesmas páginas Content.

Lista de verificação

  • O tfplugindocs gera a árvore Markdown antes da build do Nuxt.
  • Tags, branches e releases só são usados com um repo explícito.
  • path aponta para a pasta de documentação gerada.
  • flavor é exatamente 'tfplugindocs'.
  • slug, name e a política de versões preservam os URLs necessários.
  • Os grupos sintéticos não aparecem como rotas navegáveis.
Esta página foi útil?