Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
bflad opened this issue Apr 8, 2022 · 0 comments

Comments

@bflad
Copy link
Contributor

bflad commented Apr 8, 2022

Description

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

  • Schemas
  • Resources
  • Data Sources (turns out we don't have a dedicated page for this 😢 )

terraform-plugin-framework, terraform-plugin-go, and 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

@bflad bflad self-assigned this May 2, 2022
@bflad bflad transferred this issue from hashicorp/terraform-website May 2, 2022
hashibot-web pushed a commit that referenced this issue Oct 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant