provider-docs
Create, update, and review Terraform provider documentation for Terraform Registry using HashiCorp-recommended patterns, tfplugindocs templates, and schema descriptions. Use when adding or changing provider configuration, resources, data sources, ephemeral resources, list resources, functions, or guides; when validating generated docs; and when troubleshooting missing or incorrect Registry documentation.
What this skill does
# Terraform Provider Docs ## Follow This Workflow 1. Confirm scope and documentation targets. - Map code changes to the exact doc targets: provider index, resources, data sources, ephemeral resources, list resources, functions, or guides. - Decide whether content should come from schema descriptions, templates, or both. 2. Write schema descriptions first. - Add precise user-facing descriptions to schema fields so generated docs stay aligned with behavior. - Keep wording specific to argument purpose, constraints, defaults, and computed behavior. 3. Add or update template files in `docs/`. - Create only files that map to implemented provider objects. - Use HashiCorp-recommended template paths: - `docs/index.md.tmpl` - `docs/data-sources/<name>.md.tmpl` - `docs/resources/<name>.md.tmpl` - `docs/ephemeral-resources/<name>.md.tmpl` - `docs/list-resources/<name>.md.tmpl` - `docs/functions/<name>.md.tmpl` - `docs/guides/<name>.md.tmpl` - Keep templates focused on overview and examples; rely on generated sections for field-by-field details. 4. Generate documentation with `tfplugindocs`. - Prefer repository defaults when configured: ```bash go generate ./... ``` - Otherwise run the generator directly: ```bash go run github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs generate --provider-name <provider_name> ``` - Re-run generation after every schema or template edit. 5. Validate the generated markdown. - Verify files in `docs/` match the current provider implementation. - Verify examples are valid HCL and reflect current argument/attribute names. - Verify required/optional/computed semantics in docs match schema behavior. 6. Apply Registry publication rules before release. - Use semantic version tags prefixed with `v` (for example `v1.2.3`). - Create release tags from the default branch. - Keep `terraform-registry-manifest.json` in the repository root. - Expect docs to be versioned in Registry and switchable with the version selector. 7. Preview or troubleshoot publication when needed. - Use the HashiCorp preview process to inspect rendered docs before release when accuracy risk is high. - If docs are missing in Registry, check tag format, tag source branch, manifest file presence, and provider publication status. ## Enforce Quality Bar - Keep documentation behaviorally accurate; never describe unsupported arguments or attributes. - Keep examples minimal, realistic, and runnable. - Keep terminology and naming consistent across provider, resources, and data sources. - Avoid duplicating generated argument/attribute blocks in manual templates. - Keep doc changes tied to the same PR as schema/API changes whenever possible. ## Load References On Demand - Read `references/hashicorp-provider-docs.md` for source-backed rules and official links. - Load only the sections needed for the current change to keep context lean.
Related in Cloud & DevOps
appbuilder-action-scaffolder
IncludedCreate, implement, deploy, and debug Adobe Runtime actions with consistent layout, validation, and error handling. Use this skill whenever the user needs to add actions to an App Builder project, understand action structure (params, response format, web/raw actions), configure actions in the manifest, use App Builder SDKs (State, Files, Events, database), deploy and invoke actions via CLI, debug action issues, or implement patterns such as webhook receivers, custom event providers, journaling consumers, large payload redirects, action sequence pipelines, and Asset Compute workers. Also trigger when users mention serverless functions in Adobe context, action logging, IMS authentication for actions, or cron-style scheduled actions.
orchestrating-datacloud
IncludedSalesforce Data Cloud product orchestrator for connect→prepare→harmonize→segment→act workflows. Use this skill when the user needs a multi-step Data Cloud pipeline, cross-phase troubleshooting, or data space and data kit management. TRIGGER when: user needs a multi-step Data Cloud pipeline, asks to set up or troubleshoot Data Cloud across phases, manages data spaces or data kits, or wants a cross-phase sf data360 workflow. DO NOT TRIGGER when: work is isolated to a single phase (use the matching phase-specific skill), the task is STDM/session tracing/parquet telemetry (use observing-agentforce), standard CRM SOQL (use querying-soql), or Apex implementation (use generating-apex).
github-project-automation
IncludedAutomate GitHub repository setup with CI/CD workflows, issue templates, Dependabot, and CodeQL security scanning. Includes 12 production-tested workflows and prevents 18 errors: YAML syntax, action pinning, and configuration. Use when: setting up GitHub Actions CI/CD, creating issue/PR templates, enabling Dependabot or CodeQL scanning, deploying to Cloudflare Workers, implementing matrix testing, or troubleshooting YAML indentation, action version pinning, secrets syntax, runner versions, or CodeQL configuration. Keywords: github actions, github workflow, ci/cd, issue templates, pull request templates, dependabot, codeql, security scanning, yaml syntax, github automation, repository setup, workflow templates, github actions matrix, secrets management, branch protection, codeowners, github projects, continuous integration, continuous deployment, workflow syntax error, action version pinning, runner version, github context, yaml indentation error
sf-datacloud
IncludedSalesforce Data Cloud product orchestrator for connect→prepare→harmonize→segment→act workflows. TRIGGER when: user needs a multi-step Data Cloud pipeline, asks to set up or troubleshoot Data Cloud across phases, manages data spaces or data kits, or wants a cross-phase `sf data360` workflow. DO NOT TRIGGER when: work is isolated to a single phase (use the matching sf-datacloud-* skill), the task is STDM/session tracing/parquet telemetry (use sf-ai-agentforce-observability), standard CRM SOQL (use sf-soql), or Apex implementation (use sf-apex).
fabric-cli
IncludedUse this skill for Fabric.so CLI workflows with the `fabric` terminal command: diagnose/install/login, search or browse a Fabric library, save notes/links/files, create folders, ask the Fabric AI assistant, manage tasks/workspaces, generate shell completion, check subscription usage, produce JSON output, and use Fabric as persistent agent memory. Do not use for Microsoft Fabric/Azure/Power BI `fab`, Daniel Miessler's Fabric framework, Python Fabric SSH, Fabric.js, or textile/fashion fabric.
lark
IncludedLark/Feishu CLI skills: lark-cli operations for docs, markdown, sheets, base, calendar, im, mail, task, okr, drive, wiki, slides, whiteboard, apps, approval, attendance, contact, vc, minutes, event. Use when the user needs to operate Lark/Feishu resources via lark-cli, send messages, manage documents, spreadsheets, calendars, tasks, OKRs, deploy web pages, or any Feishu/Lark workspace operations.