hasura / ddn-docs

Repository for the Hasura DDN version of docs
https://hasura.io/docs
2 stars 6 forks source link

Decompose connector-link add-resources into components #572

Closed nullxone closed 1 month ago

nullxone commented 1 month ago

Description 📝

With the introduction of ddn relationship add in CLI v2.2.0, we prefer to

ddn model add mypg '*'
ddn command add mypg '*'
ddn relationship add mypg '*'

Instead of

ddn connector-link add-resources mypg

This is because

Should we replace this everywhere? Currently, I have made this change where the workflow commands are introduced, but have left the add-resources version on smaller hints across different pages. This provides an affordance for power users at the expense of consistency.

Quick Links 🚀

Assertion Tests 🤖

cloudflare-workers-and-pages[bot] commented 1 month ago

Deploying v3-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 6716d81
Status: ✅  Deploy successful!
Preview URL: https://6a1a032d.v3-docs-eny.pages.dev
Branch Preview URL: https://ak-docs-relationship-add-com.v3-docs-eny.pages.dev

View logs

robertjdominguez commented 1 month ago

DX: Assertion Testing

✅ Diff

The changes in the PR seem to clarify the correct usage of the CLI commands, standardizing the placeholder text and improving the example by specifying the placeholder parameters more precisely. It also breaks down a complex command into more granular steps. The addition of 'title' fields helps guide the user on what the command will achieve.

✅ Integrated

The PR updates are consistent with the existing documentation structure and provide a clearer path for users to follow when adding or updating models. By breaking down the process into distinct commands, it caters to the en masse scenario more effectively. The modifications in the quick start guide follow the overall documentation intent of providing a smooth user experience for newcomers and improve the comprehensibility of initial setup steps.