Aller au contenu
duxt

Publier la documentation d’un provider Terraform

Transformer un arbre Markdown tfplugindocs en référence versionnée avec une navigation adaptée au provider.

tfplugindocs écrit déjà du Markdown. duxt ne le traite pas comme un nouvel artefact généré, mais comme une source dont les conventions de fichiers et de titres portent plus de structure qu’un manuel ordinaire.

Étapes

  1. Générez la documentation dans le dépôt du provider. Conservez l’arbre docs/ et ses dossiers provider, resources, data sources, functions et guides. duxt n’exécute pas tfplugindocs pendant le build Nuxt.
  2. Déclarez le dépôt comme dialecte de source.
    sources: [{
  repo: 'acme/terraform-provider-acme',
  path: 'docs',
  slug: 'terraform',
  name: 'Terraform Provider',
  flavor: 'tfplugindocs',
  releases: { select: 'minor' }
}]
  3. Choisissez les versions dont les URL doivent rester disponibles.releases utilise les mêmes politiques all, minor et major que toute autre source. Un { tag } explicite épingle une version ; une branche peut publier la documentation à venir.
  4. Construisez le site et vérifiez la navigation. duxt déduit le titre du premier H1, ordonne les catégories connues et conserve les sous-catégories comme structure plutôt que comme pages fictives. Recherche, locales, versions et lecteurs machines utilisent toujours les mêmes pages Content.

Liste de contrôle

  • tfplugindocs génère l’arbre Markdown avant le build Nuxt.
  • Tags, branches et releases ne sont utilisés qu’avec un repo explicite.
  • path pointe vers le dossier de documentation généré.
  • flavor vaut exactement 'tfplugindocs'.
  • slug, name et la politique de versions préservent les URL requises.
  • Les groupes synthétiques n’apparaissent pas comme routes consultables.
Cette page vous a-t-elle été utile ?