update help for metadata export command #661
Conversation
|
|
|
Beep boop! 🤖 Hey @scriptonist! Thanks for your PR! ✨ I can't wait to merge it 🤞 🛠️, but I don't have the permissions to do so. ❌ One of my human 👩 friends will review the changes 📝 and get back to you as soon as possible. 🕐 Stay awesome! 😎 |
|
Review app available at: https://hge-ci-pull-661.herokuapp.com |
shahidhk
left a comment
There was a problem hiding this comment.
Thanks for the contribution @scriptonist 🙏 😄
Should have been more explicit on the issue that it is for exhaustively documenting the contents of metadata file at docs.hasura.io. Not on the CLI 😄.
The CLI can have a link to the documentation page once its ready. But the current info is not particularly helpful.
Maybe you can update the PR to remove the file contents and talk about the file location and some generic info? Something like:
Export Hasura metadata and save it in migrations/metadata.yaml file.
The output is a yaml file which captures all the metadata required
by GraphQL Engine. This includes info about tables that are tracked,
permission rules, relationships and event triggers that are defined
on those tables.
This can be added as the Long description property of the command, leaving the example as
# Export metadata and save it in migrations/metadata.yaml file:
hasura metadata export|
Thanks @shahidhk 🙏 for the feedback, I was also pretty unsure about the change. On inspection I felt like the change was to be made to command help and docs will be generated for the same. |
|
Review app available at: https://hge-ci-pull-661.herokuapp.com |
|
Review app available at: https://hge-ci-pull-661.herokuapp.com |
|
Beep boop! 🤖 Whoa! 🎉 🎉 💃 Awesome work @scriptonist! 💪 🏆 All of us at Hasura ❤️ what you did. We would love to send you some swag! 👕 Please allow us to do so by filling this form. If you have any questions, ask us on our Discord & Twitter! Thanks again 🤗 |
|
Review app https://hge-ci-pull-661.herokuapp.com is deleted |
1. Always name the struct when calling `default()`. 2. Sort construction according to the definitions. 3. Approve allowing `struct_field_names` because it doesn't seem to be helpful. 4. Enable `manual_string_new`; nothing seems to be triggering it now. V3_GIT_ORIGIN_REV_ID: 868742114b0bf27bc3ea03cdf1e63a0f710ebe33
Description
Document what's inside the
metadata.yamlfile exported byhasura metadata exportcommand.What component does this PR affect?
Requires changes from other components? If yes, please mark the components:
Related Issue
Fixes #400
Solution and Design
Type
Checklist: