Conversation
bflad
left a comment
There was a problem hiding this comment.
Overall this is looking pretty good! Some high level comments/questions and then its probably good to go! 👍
Co-authored-by: Brian Flad <bflad417@gmail.com>
|
I do also wonder if we should have a flag (or bake the behavior in) to remove the old |
# Conflicts: # go.mod
austinvalle
left a comment
There was a problem hiding this comment.
This is awesome @SBGoods! I left some random thoughts/questions but everything LGTM ![]()
|
|
||
| --examples-dir <ARG> examples directory based on provider-dir (default: "examples") | ||
| --provider-dir <ARG> relative or absolute path to the root provider code directory when running the command outside the root provider code directory | ||
| --templates-dir <ARG> new website templates directory based on provider-dir; files will be migrated to this directory (default: "templates") |
There was a problem hiding this comment.
At first glance, it wasn't immediately obvious what the input directories were vs. the output directory without reading the help text. Would it be confusing/misleading to name the --templates-dir as --output-dir?
There was a problem hiding this comment.
I think the name should be the same to keep it in parity with the generate command with the same flag. If we changed the flag to something like --output-dir it might not be obvious to the user that they would need to specify generate --template-dir to that directory after migration.
There was a problem hiding this comment.
Ah okay that's helpful context! Makes sense to me 👍🏻
Co-authored-by: Austin Valle <austinvalle@gmail.com>
|
I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions. |
Implements a new
migratesubcommand that migrates existing provider docs using the old website directory structure (website/docs/) to aterraform-plugin-docs-supported templates directory.The
migratesubcommand takes the following actions:--old-website-source-dirfolder to the--tempates-dirfolder (will create this folder if it doesn't exist)docs/d/anddocs/r/subdirectories todata-sources/andresources/respectively.html.markdownto.md.tmpl--examples-dir(will create this folder if it doesn't exist)tfplugindocstemplate code referring to example files.--templates-dirfolder