Open ctreatma opened 2 days ago
FYI @equinix/governor-digin-fabric @equinix/governor-ne-network-edge-engineering this PR doesn't require your review, but it is an example of how to switch from using a custom template for documentation to using the default templates. The default templates have support for one TF example file (although that file could contain multiple example usages) and the default resource template can pull in an example import script as well. The bullet list in the issue description lays out the steps for conversion; in particular there's a note in there about a mismatch between the file paths that were used by tfplugindocs migrate
when I created the templates from existing docs and the conventional file paths for examples that are used by make docs
(which is eventually equivalent to tfplugindocs generate
).
This removes the custom templates for the
metal_virtual_circuit
resource and data source so that it we can generate those docs from code and better ensure that docs stay up-to-date as we add, change, and remove functionality.This required:
metal_virtual_circuit
resource and data sourcetfplugindocs migrate
to align with the conventional paths.equinix_metal_virtual_circuit
, even though theequinix_
prefix is omitted for all other files