Skip to content
This repository has been archived by the owner on Jul 5, 2023. It is now read-only.

Rework plugin Section Documentation for Debugging Providers #2131

Closed
bflad opened this issue Feb 3, 2022 · 1 comment · Fixed by #2247
Closed

Rework plugin Section Documentation for Debugging Providers #2131

bflad opened this issue Feb 3, 2022 · 1 comment · Fixed by #2247
Assignees
@bflad
Labels
clarification Something could be explained more usefully plugin Docs for extending terraform and writing providers

Comments

@bflad
Copy link
Contributor

bflad commented Feb 3, 2022

Description

Currently, there is a singular terraform-plugin-sdk/v2 documentation page which describes how to setup a provider codebase for debugging, then actually how use a debugger. Both terraform-plugin-framework and terraform-plugin-mux now also support debugging as well (refer also to the terraform-plugin-mux documentation onboarding issue).

Proposal

Rather than duplicate content across all these pages, it seems ideal to:

  • Create a top level plugin development page that is similar to the existing sdk/v2 page content (minus the sdk/v2 specific pieces) with links to sdk/v2, framework, and mux specific pages
  • 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 mux page that is similar to the updated sdk/v2 page with mux-specific code
@bflad bflad added clarification Something could be explained more usefully plugin Docs for extending terraform and writing providers labels Feb 3, 2022
@bflad bflad self-assigned this Feb 3, 2022
@bflad
Copy link
Contributor Author

bflad commented Feb 17, 2022

This new documentation should also mention Terraform CLI development overrides configuration, which is another helpful debugging option for provider developers. I'm going to close a few other issues in preference of this one.

This was referenced Feb 17, 2022
Closed
Closed
Closed
@bflad bflad mentioned this issue May 2, 2022
Open
bflad added a commit that referenced this issue Apr 20, 2022
@bflad
plugin: Rework Documentation for Debugging Providers
3496814 
Reference: #2131

This includes the following changes:

- Lift and shift of /plugin/sdkv2/debugging to /plugin/debugging
- Recreate /plugin/sdkv2/debugging with specific code implementation
- Create /plugin/framework/debugging similar to /plugin/sdkv2/debugging
- Add Terraform CLI Develoment Overrides section to /plugin/debugging
- Replace SDKv2 code in Enabling Debugging In A Provider section of /plugin/debugging with links to all specific code implementations
@bflad bflad mentioned this issue Apr 20, 2022
Merged
13 tasks
bflad added a commit that referenced this issue Apr 25, 2022
@bflad
plugin: Rework Documentation for Debugging Providers (#2247)
4168056 
Reference: #2131

This includes the following changes:

- Lift and shift of /plugin/sdkv2/debugging to /plugin/debugging
- Recreate /plugin/sdkv2/debugging with specific code implementation
- Create /plugin/framework/debugging similar to /plugin/sdkv2/debugging
- Add Terraform CLI Develoment Overrides section to /plugin/debugging
- Replace SDKv2 code in Enabling Debugging In A Provider section of /plugin/debugging with links to all specific code implementations
thiskevinwang pushed a commit to hashicorp/terraform-docs-common that referenced this issue Apr 27, 2022
@bflad @thiskevinwang
plugin: Rework Documentation for Debugging Providers (#2247)
46e22a1 
Reference: hashicorp/terraform-website#2131

This includes the following changes:

- Lift and shift of /plugin/sdkv2/debugging to /plugin/debugging
- Recreate /plugin/sdkv2/debugging with specific code implementation
- Create /plugin/framework/debugging similar to /plugin/sdkv2/debugging
- Add Terraform CLI Develoment Overrides section to /plugin/debugging
- Replace SDKv2 code in Enabling Debugging In A Provider section of /plugin/debugging with links to all specific code implementations
thiskevinwang pushed a commit to hashicorp/terraform-docs-common that referenced this issue Apr 29, 2022
@bflad @thiskevinwang
plugin: Rework Documentation for Debugging Providers (#2247)
ff7f93a 
Reference: hashicorp/terraform-website#2131

This includes the following changes:

- Lift and shift of /plugin/sdkv2/debugging to /plugin/debugging
- Recreate /plugin/sdkv2/debugging with specific code implementation
- Create /plugin/framework/debugging similar to /plugin/sdkv2/debugging
- Add Terraform CLI Develoment Overrides section to /plugin/debugging
- Replace SDKv2 code in Enabling Debugging In A Provider section of /plugin/debugging with links to all specific code implementations
thiskevinwang pushed a commit to hashicorp/terraform-docs-common that referenced this issue Apr 29, 2022
@bflad @thiskevinwang
plugin: Rework Documentation for Debugging Providers (#2247)
167555e 
Reference: hashicorp/terraform-website#2131

This includes the following changes:

- Lift and shift of /plugin/sdkv2/debugging to /plugin/debugging
- Recreate /plugin/sdkv2/debugging with specific code implementation
- Create /plugin/framework/debugging similar to /plugin/sdkv2/debugging
- Add Terraform CLI Develoment Overrides section to /plugin/debugging
- Replace SDKv2 code in Enabling Debugging In A Provider section of /plugin/debugging with links to all specific code implementations

git mv file
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@bflad bflad

Labels
clarification Something could be explained more usefully plugin Docs for extending terraform and writing providers
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

plugin: Rework Documentation for Debugging Providers hashicorp/terraform-website
1 participant
@bflad