Skip to content
This repository has been archived by the owner on May 15, 2023. It is now read-only.

Expand documentation on contributing new resources #245

Open
3 tasks
melinath opened this issue Jul 2, 2021 · 3 comments
Open
3 tasks

Expand documentation on contributing new resources #245

melinath opened this issue Jul 2, 2021 · 3 comments
Assignees

Comments

@melinath
Copy link
Member

melinath commented Jul 2, 2021

Contributing to terraform-validator is complex and in some cases requires modifying Magic Modules. We should more closely document the process. In particular, we should:

  • document how to modify handwritten files & reference them in compile_common_files and copy_common_files
  • document how to add IAM support specifically, including descriptions of what the merge and fetch functions do
  • document how to add tests in more detail
@melinath
Copy link
Member Author

melinath commented Jul 2, 2021

IAM docs should potentially explicitly mention providing project unless #206 (comment) has been resolved, since IAM often will not have a project field.

@melinath
Copy link
Member Author

I added some more detail for adding tests as part of #333 but maybe we want to do more.

@marktru
Copy link

marktru commented Dec 23, 2021

Internal issue: b/211902384

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants