-
Notifications
You must be signed in to change notification settings - Fork 1.7k
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
Add contributor documentation for resource metadata #12620
Conversation
Hi there, I'm the Modular magician. I've detected the following information about your changes: Diff reportYour PR hasn't generated any diffs, but I'll let you know if a future commit does. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you have more context on this change or a doc I can reference?
docs/content/reference/metadata.md
Outdated
|
||
# MMv1 metadata reference | ||
|
||
This page documents all properties for metadata. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you add information about when this file is needed? You mention in you PR that most resources would be unaffected. When would they be affected?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I just added some clarification. The file is autogenerated for MMv1, so it is only really needed for handwritten resources (which is why that guide was updated as well).
Shared doc link with you internally |
Hi there, I'm the Modular magician. I've detected the following information about your changes: Diff reportYour PR hasn't generated any diffs, but I'll let you know if a future commit does. |
I have some concerns about the overhead here. commented on the doc. |
@ScottSuarez it sounds like maybe you have concerns about the approach, but the metadata described in this change is already implemented. Could we take that discussion offline, and move this through? Otherwise, we are in a place where we've introduced these fields/files without any documentation. cc @melinath |
|
||
# MMv1 metadata reference | ||
|
||
This page documents all properties for metadata. Metadata does not impact the provider itself, but is used by Google internally for coverage metrics. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Drive-by suggestion: maybe state this more generically (because that might not be the only thing it gets used for)
This page documents all properties for metadata. Metadata does not impact the provider itself, but is used by Google internally for coverage metrics. | |
This page documents all properties for metadata. Metadata does not impact the provider itself, but enables analysis of the provider that would otherwise be impractical or impossible. |
Adds some light documentation for working with these metadata files (ie.
*_meta.yaml
).Note that most regular mmv1 resources will not have to do anything additional, and we will be performing regular checks to correct/add files as needed.
Release Note Template for Downstream PRs (will be copied)
See Write release notes for guidance.