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

Make tpgtools generate beta docs into GA as well for parity with mmv1. #3848

Conversation

modular-magician
Copy link
Collaborator

Also, minor changes to make sure that the docs are a little bit better - allow overrides of documentation values, for instance.

Also, includes the actual description of the resource, which, at the moment is not acceptable in the DCL. Will need to implement an override in the DCL.

Fixes the worst of hashicorp/terraform-provider-google#10252, bringing the urgency down to "we need better docstrings for these fields". I'll get to that soon.

If this PR is for Terraform, I acknowledge that I have:

  • Searched through the issue tracker for an open issue that this either resolves or contributes to, commented on it to claim it, and written "fixes {url}" or "part of {url}" in this PR description. If there were no relevant open issues, I opened one and commented that I would like to work on it (not necessary for very small changes).
  • Generated Terraform, and ran make test and make lint to ensure it passes unit and linter tests.
  • Ensured that all new fields I added that can be set by a user appear in at least one example (for generated resources) or third_party test (for handwritten resources or update tests).
  • Ran relevant acceptance tests (If the acceptance tests do not yet pass or you are unable to run them, please let your reviewer know).
  • Read the Release Notes Guide before writing my release note below.

Release Note Template for Downstream PRs (will be copied)

all: fixed an issue where some documentation for new resources was not showing up in the GA provider if it was beta-only.

Derived from GoogleCloudPlatform/magic-modules#5325

hashicorp#5325)

* Make tpgtools generate beta docs into GA as well for parity with mmv1.

Also, minor changes to make sure that the docs are a little bit better - allow overrides of documentation values, for instance.

Also, includes the actual description of the resource, which, at the moment is not acceptable in the DCL.  Will need to implement an override in the DCL.

* Generate reasonable documentation for autogenerated and handwritten tests.

* Default to - instead of _

* Improve documentation further with links and guides.

Signed-off-by: Modular Magician <magic-modules@google.com>
@modular-magician modular-magician merged commit b0fa3b5 into hashicorp:master Nov 10, 2021
@modular-magician modular-magician deleted the downstream-pr-a89ee321148bda97150445a96243a8e930c7e898 branch November 16, 2024 03:47
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.

1 participant