Add comments support for deployment.yaml

[jlowin]

Summary

Opening this as a separate PR for @cicdw evaluation. Essentially allows deployment.yaml to have inline help in the form of comments, that are provided as Field(..., yaml_comment="my comment"). For example (see work queue name):

Steps Taken to QA Changes

Checklist

This pull request is:

• A documentation / typographical error fix
  • No tests or issue needed
• A short code fix
  • Please reference the related issue by including "closes <link to issue>" in this Pull Request's summary section.
    • If no issue exists, please create a bug report issue
  • Please include tests. One-line fixes without tests will not be accepted unless it's related to the documentation only.
• A new feature implementation
  • Please reference the related issue by including "closes <link to issue>" in this Pull Request's summary section.
    • If no issue exists, please create a feature enhancement issue
  • Please include tests
  • Please make sure that your QA steps are both thorough and easy to reproduce by somebody with limited knowledge of the feature that you are submitting

Happy engineering!

[cicdw]

I like this!! I would really like us to move to smaller PRs so if you'd like to open this as an isolated PR I'd review 👍

[jlowin]

@cicdw this is now standalone against main

[zanieb]

Test coverage for yaml_comment and the consequent output would be nice

[jlowin]

If #6343 is merged, I'll add yaml_comment for the work queue name field (as in the screenshot at the top of this PR) and use that as a non-contrived test

[zanieb]

This one seems simpler to move forward, we can add the test over there?

[jlowin]

Sure

[jlowin]

For posterity: test added here 042de3c (#6343)