magic-modules icon indicating copy to clipboard operation
magic-modules copied to clipboard

Published 20 hours ago • verified publisher icon GoogleCloudPlatform

Documentation updates

Open nphilbrook opened this issue 1 year ago • 2 comments

Recently while working on my first TPG contribution I discovered a few details that I didn't see covered in the docs. I think these will make future contributors' experiences better. Please give me any feedback!

You can preview these changes at my fork's root page

I hope this qualifies as a "very small change" that doesn't require an issue 😁 .

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

  • [n/a] 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).
  • [n/a] Generated Terraform, and ran make test and make lint to ensure it passes unit and linter tests.
  • [n/a] 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).
  • [n/a] Ran relevant acceptance tests (If the acceptance tests do not yet pass or you are unable to run them, please let your reviewer know).
  • [X] Read the Release Notes Guide before writing my release note below.

Release Note Template for Downstream PRs (will be copied)

Documentation updates only.

nphilbrook avatar Jul 21 '22 12:07 nphilbrook

Hey @nphilbrook! Thank you so much for contributing to our documentation! These changes can definitely benefits future contributors. I am currently working on rewriting the Magic Modules ReadMe Page to contain more information and guidance, and I believe it contains some of these changes. I'll let you know when the PR is out and you can take a look and let us know if there's more content we should add. Again thank you so much!

shuyama1 avatar Jul 22 '22 17:07 shuyama1

Hey @nphilbrook! Thank you so much for contributing to our documentation! These changes can definitely benefits future contributors. I am currently working on rewriting the Magic Modules ReadMe Page to contain more information and guidance, and I believe it contains some of these changes. I'll let you know when the PR is out and you can take a look and let us know if there's more content we should add. Again thank you so much!

Sounds great, have fun with the rewrite.

nphilbrook avatar Jul 22 '22 18:07 nphilbrook

Hey @nphilbrook! I've added your change in https://github.com/GoogleCloudPlatform/magic-modules/pull/6547 and also added you as the co-author to the PR. Please let me know if there's more I should add. Thank you so much for helping with the documentation! Feel free to make more changes if you think there's area should be modified or added! Really appreciate it!

shuyama1 avatar Sep 16 '22 16:09 shuyama1

Hey @nphilbrook! I've added your change in #6547 and also added you as the co-author to the PR. Please let me know if there's more I should add. Thank you so much for helping with the documentation! Feel free to make more changes if you think there's area should be modified or added! Really appreciate it!

Looks great, thank you for including my changes and giving credit, really appreciate it.

nphilbrook avatar Sep 19 '22 12:09 nphilbrook