hasura / ddn-docs

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

Update CLI commands docs, including relationship subcommand #573

Closed nullxone closed 1 month ago

nullxone commented 1 month ago

Description 📝

Updated the ddn CLI documentation for v2.2.0 following instructions on the README.md . I did not use the npm script write-cli-docs .

This includes the new relationship subcommand, and a host of other minor changes.

Quick Links 🚀

Assertion Tests 🤖

robertjdominguez commented 1 month ago

Hey, @nullxone :wave:

Thanks for this PR! Since you changed docs files, our automated Action assigned Rob as your reviewer :tada:

Before Rob looks over the changes, we ask you to take care of a couple of items:

The docs team aims to get all PRs reviewed within 48 hours of your team doing a review in the form of a content pass. Let Rob know the level of urgency on Slack :+1:

robertjdominguez commented 1 month ago

DX: Assertion Testing

✅ Diff

The PR makes several improvements. Wrapping the wildcard '*' in quotes for CLI commands is a great fix as some shells could expand it unpredictably. The clarification in the description of the '--pattern' flag from 'glob' to 'string' and its values is more accurate. Adding the new 'ddn relationship' command section expands the available documentation and fills a gap for relationship management operations.

✅ Integrated

The changes integrate well with the rest of the documentation, maintaining consistency in formatting and style. The rearrangement of the order of keys (e.g., 'Allowed keys...' section) creates a uniform look across different command files. The updates to the '--pattern' flag descriptions help to standardize the terminology used across various command files, and the addition of the 'ddn relationship' command section seems to be in line with the existing structure, augmenting the comprehensive nature of the documentation.

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

Deploying v3-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 2c8889a
Status: ✅  Deploy successful!
Preview URL: https://d0bea389.v3-docs-eny.pages.dev
Branch Preview URL: https://ak-docs-update-cli-command-d.v3-docs-eny.pages.dev

View logs