Saltar al contenido
duxt

Publicar documentación de un proveedor de Terraform

Convierte un árbol Markdown de tfplugindocs en una referencia versionada con navegación de proveedor.

tfplugindocs ya escribe Markdown. duxt no lo procesa como otro artefacto generado, sino como una fuente cuyas convenciones de archivos y encabezados aportan más estructura que un manual corriente.

Pasos

  1. Genera la documentación en el repositorio del proveedor. Conserva el árbol docs/ con sus carpetas de provider, resources, data sources, functions y guides. duxt no ejecuta tfplugindocs durante la build de Nuxt.
  2. Declara el repositorio como dialecto de fuente.
    sources: [{
  repo: 'acme/terraform-provider-acme',
  path: 'docs',
  slug: 'terraform',
  name: 'Terraform Provider',
  flavor: 'tfplugindocs',
  releases: { select: 'minor' }
}]
  3. Elige las versiones que conservarán sus URL. releases usa las mismas políticas all, minor y major que cualquier fuente. Un { tag } explícito fija una versión; una rama puede publicar documentación futura.
  4. Construye el sitio y revisa la navegación. duxt deriva el título del primer H1, ordena las categorías conocidas y conserva las subcategorías como estructura en vez de inventar páginas. Búsqueda, locales, versiones y lectores automáticos siguen usando las mismas páginas Content.

Lista de comprobación

  • tfplugindocs genera el árbol Markdown antes de la build de Nuxt.
  • Tags, ramas y releases solo se usan con un repo explícito.
  • path apunta a la carpeta de documentación generada.
  • flavor es exactamente 'tfplugindocs'.
  • slug, name y la política de versiones preservan las URL necesarias.
  • Los grupos sintéticos no aparecen como rutas navegables.
¿Le ha resultado útil esta página?