Add contributor documentation for resource metadata #12620
Conversation
roaks3
requested review from
a team and
ScottSuarez
and removed request for
a team
|
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. |
docs/content/reference/metadata.md
Outdated
|
|
||
| # MMv1 metadata reference | ||
|
|
||
| This page documents all properties for metadata. |
There was a problem hiding this comment.
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.
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. |
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.