hashicorp / hashicorp/terraform-docs-common

Rework plugin Section Documentation for Provider Concepts (Schema, Resource, Data Source)

Open
#7 0 comments 1 reaction 1 assignee Claimed by @bflad View on GitHub
clarification plugin
Dominant language
Makefile
Stars
36
Forks
133
PR merge metrics
No merged PRs in 30d

Description

## Description

Currently, there are terraform-plugin-sdk/v2 documentation pages which describe various Terraform Provider concepts, such as:

- [Schemas](https://www.terraform.io/plugin/sdkv2/schemas)
- [Resources](https://www.terraform.io/plugin/sdkv2/resources)
- Data Sources (turns out we don't have a dedicated page for this 😢 )

[terraform-plugin-framework](https://github.com/hashicorp/terraform-plugin-framework/), [terraform-plugin-go](https://github.com/hashicorp/terraform-plugin-go), and [terraform-plugin-mux](https://github.com/hashicorp/terraform-plugin-mux/) also implement or reference these concepts in some fashion. There is no website documentation which succinctly correlates these concepts to the underlying protocol.

## Proposal

Since the concepts themselves are not specific to the implementations and rather than duplicate content across all these pages, it seems ideal to:

- Create top level plugin development pages that is similar to the existing sdk/v2 page content (minus the sdk/v2 specific pieces) with links to sdk/v2, framework, go, and mux specific pages
- Additionally, these top level pages should also link or reference the specific protocol RPCs involved (which maybe the protocol documentation needs to be expanded into its own page with references to each RPC)
- Pare down the sdk/v2 page to just reference links and the sdk/v2 specific content
- Create a framework page that is similar to the updated sdk/v2 page with framework-specific code
- When onboarded, create a go page that is similar to the updated sdk/v2 page with go-specific code
- Handle any necessary mux page changes/references

## References

- https://github.com/hashicorp/terraform-website/issues/2131

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.