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

docs: use default template for metal_virtual_circuit #719

Merged
merged 1 commit into from
Jul 10, 2024

Conversation

ctreatma
Copy link
Contributor

@ctreatma ctreatma commented Jul 2, 2024

This removes the custom templates for the metal_virtual_circuit resource and data source so that 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:

  • Deleting the custom templates for the metal_virtual_circuit resource and data source
  • Renaming examples directories and files that were created by tfplugindocs migrate to align with the conventional paths.
    • NOTE: in particular, example files go in directories called, e.g., equinix_metal_virtual_circuit, even though the equinix_ prefix is omitted for all other files
  • Moving the resource import script out of the template and into the examples directory

@ctreatma
Copy link
Contributor Author

ctreatma commented Jul 3, 2024

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).

@ctreatma
Copy link
Contributor Author

@RaptorGandalf when you have a moment, please review this PR. This updates the virtual circuit resource and data source docs to cover the new attributes that were added for IPv6 support. Until recently the provider docs were all/mostly hand-written; as the docs begin to leverage more generation features, it will be easier to update them alongside the code. The files under docs are the important changes here; the rest the changes were needed to generate the docs instead of hand-writing them, and those changes won't appear in future PRs for virtual circuit docs.

@ctreatma ctreatma merged commit 112d6eb into main Jul 10, 2024
6 of 7 checks passed
@ctreatma ctreatma deleted the virtual_circuit_docs branch July 10, 2024 18:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants