Zum Inhalt springen
duxt

Terraform-Provider-Dokumentation veröffentlichen

Einen tfplugindocs-Markdown-Baum als versionierte Provider-Referenz mit passender Navigation veröffentlichen.

tfplugindocs schreibt bereits Markdown. duxt behandelt es nicht als weiteres generiertes Artefakt, sondern als Quelle, deren Datei- und Überschriftenkonventionen mehr Struktur als ein gewöhnliches Handbuch tragen.

Schritte

  1. Erzeuge die Provider-Dokumentation im Provider-Repository. Behalte den docs/-Baum samt Provider-, Resource-, Data-Source-, Function- und Guide-Ordnern. duxt führt tfplugindocs nicht während des Nuxt-Builds aus.
  2. Deklariere das Repository als Quellen-Dialekt.
    sources: [{
  repo: 'acme/terraform-provider-acme',
  path: 'docs',
  slug: 'terraform',
  name: 'Terraform Provider',
  flavor: 'tfplugindocs',
  releases: { select: 'minor' }
}]
  3. Wähle die aufzubewahrenden Versionen. releases nutzt dieselben all-, minor- und major-Richtlinien wie jede andere Quelle. Ein expliziter { tag } pinnt genau einen Release; ein Branch kann kommende Dokumentation daneben zeigen.
  4. Baue die Site und prüfe die Navigation. duxt leitet den Provider-Titel aus dem ersten H1 ab, ordnet bekannte Kategorien und hält Unterkategorien als Struktur statt als erfundene Seiten. Suche, Locale-Fallbacks, Versionen und Machine-Reader verwenden weiter dieselben Content-Seiten.

Checkliste

  • tfplugindocs hat den Markdown-Baum vor dem Nuxt-Build erzeugt.
  • Tags, Branches und Releases werden nur mit explizitem repo verwendet.
  • path zeigt auf den erzeugten Dokumentationsordner.
  • flavor ist exakt 'tfplugindocs'.
  • slug, name und Release-Richtlinie passen zu den beständigen URLs.
  • Synthetische Gruppen erscheinen nicht als aufrufbare Routen.
War diese Seite hilfreich?