hashicorp / hashicorp/terraform-docs-common

Add support for migration in the code generation documentation

Open
#477 1 comment 0 reactions 0 assignees View on GitHub
documentation plugin
Dominant language
Makefile
Stars
36
Forks
133
PR merge metrics
No merged PRs in 30d

Description

As a provider maintainer I got existing provider code. I would like to migrate progressively to the new code generation tool that is offered and based on openapi. Could you add content about how to migrate progressively to this new way of writing code?

How can I organize my code to make this migration as easy as possible? Where should the code generation configuration code live? How can I manage custom logic? How can I handle waiting operation when an operation in ongoing? How can I handle override and validation?

This content could help a lot to migrate to this new code generation phase of terraform plugin development :)

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing the existing code generation documentation and its surrounding migration guidance. Document a progressive migration path covering code organization, configuration placement, custom logic, waiting operations, overrides, and validation; done means provider maintainers can use the guidance to plan each migration step.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, terraform
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.