Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Automatically validate that YAML structure is consistently ordered with biggest standard conventions #20128

Open
melinath opened this issue Oct 31, 2024 · 0 comments
Open

Automatically validate that YAML structure is consistently ordered with biggest standard conventions #20128

melinath opened this issue Oct 31, 2024 · 0 comments
Labels
magician-pr-ux size/m technical-debt
Milestone
Goals

Comments

@melinath
Copy link
Collaborator

melinath commented Oct 31, 2024 •
edited by rileykarson
Loading

What kind of contribution is this issue about?

Pull request UX

Details

There are a few ordering conventions that are standard that we should maintain across all products & resources so that they are easy to scan/read:

  • Product name & display name come first
  • Resource name & description come first (followed by api_resource_type_kind, if present)
  • parameters & properties are the last two top-level properties (and in that order)

References

GoogleCloudPlatform/magic-modules#11989
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
magician-pr-ux size/m technical-debt
Projects
None yet
Milestone
Goals
Development

No branches or pull requests
2 participants
@melinath @rileykarson