hashicorp/provider-docs

Erstellen, aktualisieren und überprüfen Sie Terraform-Provider-Dokumentationen für das Terraform Registry unter Verwendung von HashiCorp-empfohlenen Mustern, tfplugindocs-Vorlagen und Schemabeschreibungen.

Was ist provider-docs?

Diese Fähigkeit (Skill) ermöglicht die Erstellung, Aktualisierung und Überprüfung von Terraform-Provider-Dokumentationen, die für die Terraform Registry bestimmt sind. Sie basiert auf den von HashiCorp empfohlenen Mustern, nutzt `tfplugindocs`-Vorlagen und greift auf die Schemabeschreibungen des Providers zurück. Sie ist besonders nützlich, wenn neue Provider-Konfigurationen, Ressourcen, Datenquellen, ephemere Ressourcen, List-Ressourcen, Funktionen oder Guides hinzugefügt oder geändert werden. Zudem hilft sie bei der Validierung generierter Dokumentationen sowie bei der Fehlersuche, wenn Dokumentation in der Registry fehlt oder inkorrekt ist. Der Skill automatisiert die Einhaltung der offiziellen HashiCorp-Formatierungsstandards und stellt sicher, dass die Registry-Dokumentation vollständig und konsistent ist. Er arbeitet plattformunabhängig mit allen Terraform Providern, die das standardisierte `tfplugindocs`-Tooling unterstützen.

Funktioniert mit~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/hashicorp/agent-skills/tree/main/skills/provider-docs

Installed? Explore more Produktivität & Zusammenarbeit skills: steipete/gemini, steipete/gh-issues, steipete/skill-creator · View all 6 →

In Ihrer bevorzugten KI fragen

Öffnet einen neuen Chat, in dem dieser Agent-Skill bereits geladen ist.

Dokumentation

Was macht provider-docs?

Erstellen, aktualisieren und überprüfen Sie Terraform-Provider-Dokumentationen für das Terraform Registry unter Verwendung von HashiCorp-empfohlenen Mustern, tfplugindocs-Vorlagen und Schemabeschreibungen. Verwenden Sie diesen Skill beim Hinzufügen oder Ändern von Provider-Konfigurationen, Ressourcen, Datenquellen, ephemeren Ressourcen, List-Ressourcen, Funktionen oder Guides; beim Validieren generierter Dokumentationen; und bei der Fehlersuche bei fehlender oder falscher Registry-Dokumentation.

Individual skills in this repo

This repo contains 15 individual skills — each has its own dedicated page.

hashicorp/aws-ami-builder

Build Amazon Machine Images (AMIs) with Packer using the amazon-ebs builder. Use when creating custom AMIs for EC2 instances.

hashicorp/azure-image-builder

Build Azure managed images and Azure Compute Gallery images with Packer. Use when creating custom images for Azure VMs.

hashicorp/azure-verified-modules

Azure Verified Modules (AVM) requirements and best practices for developing certified Azure Terraform modules. Use when creating or reviewing Azure modules that need AVM certification.

hashicorp/new-terraform-provider

Use this when scaffolding a new Terraform provider.

hashicorp/provider-actions

Implement Terraform Provider actions using the Plugin Framework. Use when developing imperative operations that execute at lifecycle events (before/after create, update, destroy).

hashicorp/provider-resources

Implement Terraform Provider resources and data sources using the Plugin Framework. Use when developing CRUD operations, schema design, state management, and acceptance testing for provider resources.

hashicorp/provider-test-patterns

Terraform provider acceptance test patterns using terraform-plugin-testing with the Plugin Framework. Covers test structure, TestCase/TestStep fields, ConfigStateChecks with custom statecheck.StateCheck implementations, plan checks, CompareValue for cross-step assertions, config helpers, import testing with ImportStateKind, sweepers, and scenario patterns (basic, update, disappears, validation, regression), and ephemeral resource testing with the echoprovider package. Use when writing, reviewing, or debugging provider acceptance tests, including questions about statecheck, plancheck, TestCheckFunc, CheckDestroy, ExpectError, import state verification, ephemeral resources, or how to structure test files.

hashicorp/push-to-registry

Push Packer build metadata to HCP Packer registry for tracking and managing image lifecycle. Use when integrating Packer builds with HCP Packer for version control and governance.

hashicorp/refactor-module

Transform monolithic Terraform configurations into reusable, maintainable modules following HashiCorp's module design principles and community best practices.

hashicorp/run-acceptance-tests

Guide for running acceptance tests for a Terraform provider. Use this when asked to run an acceptance test or to run a test with the prefix `TestAcc`.

hashicorp/terraform-search-import

Discover existing cloud resources using Terraform Search queries and bulk import them into Terraform management. Use when bringing unmanaged infrastructure under Terraform control, auditing cloud resources, or migrating to IaC.

hashicorp/terraform-stacks

Comprehensive guide for working with HashiCorp Terraform Stacks. Use when creating, modifying, or validating Terraform Stack configurations (.tfcomponent.hcl, .tfdeploy.hcl files), working with stack components and deployments from local modules, public registry, or private registry sources, managing multi-region or multi-environment infrastructure, or troubleshooting Terraform Stacks syntax and structure.

hashicorp/terraform-style-guide

Generate Terraform HCL code following HashiCorp's official style conventions and best practices. Use when writing, reviewing, or generating Terraform configurations.

hashicorp/terraform-test

Comprehensive guide for writing and running Terraform tests. Use when creating test files (.tftest.hcl), writing test scenarios with run blocks, validating infrastructure behavior with assertions, mocking providers and data sources, testing module outputs and resource configurations, or troubleshooting Terraform test syntax and execution.

hashicorp/windows-builder

Build Windows images with Packer using WinRM communicator and PowerShell provisioners. Use when creating Windows AMIs, Azure images, or VMware templates.

Verwandte Skills