Add metadata upgrade codemods for aggregates and boolean expressions

nullxone commented 1 month ago

Description 📝

For upcoming CLI codemod commands to upgrade metadata.

Please help find the right place for this. It is not project configuration. I mirrored the existing upgrade legacy configuration section from there into the metadata section.

CLI release not out yet, please hold off on merging till then.

Quick Links 🚀

https://ak-docs-metadata-upgrade-cod.v3-docs-eny.pages.dev/

Assertion Tests 🤖

hasura-bot commented 1 month ago

DX: Assertion Testing

✅ Diff

The changes you've made to 'subgraph-prefixing.mdx' clarify the purpose of prefixing and its importance in avoiding naming collisions. The addition of descriptive headings and examples of how to use the codemod command enhance understanding. Please ensure to add a newline at the end of the file to maintain file formatting standards.

✅ Integrated

The contribution appears to integrate well with the overall document structure. The updated section provides users with additional context on the necessity for prefixing and detailed instruction on how to implement it, contributing to the usability of the document. In the 'deprecated-metadata-upgrades.mdx', the inclusion of codemod instructions helps users understand how to upgrade their metadata, which is aligned with the needs of users aiming to use the latest features. Good job ensuring that 'sidebar_position', 'sidebar_label', 'description', and 'keywords' adhere to the documentation's existing taxonomy and will be easily discoverable by users.

hasura-bot commented 1 month ago

Hey, @nullxone :wave:

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

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

[ ] Make sure you've checked over our PR guide on the wiki. It ensures you've done your due diligence on the basics: spelling, heading casings, etc.
[ ] Sean will need a review from someone on your team to ensure your team-specific content is accurate. Once that's done, ping Sean on Slack, and he'll give a docs review :fire:
[ ] Additionally, please check this box to confirm your feature works as expected when using the documentation you've written. This is critical to ensuring our users have the information they need.

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 Sean know the level of urgency on Slack :+1:

nullxone commented 1 month ago

@robertjdominguez @seanparkross please help get this ready for an upcoming CLI release.

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

Deploying v3-docs with Cloudflare Pages

Latest commit:	`a391637`
Status:	✅ Deploy successful!
Preview URL:	https://99901374.v3-docs-eny.pages.dev
Branch Preview URL:	https://ak-docs-metadata-upgrade-cod.v3-docs-eny.pages.dev

View logs

seanparkross commented 1 month ago

@nullxone 👍

seanparkross commented 1 month ago

The project configuration section is expanding its scope (and name) in another PR to include, for example, scripts, renaming etc. So this new section I think is the perfect place for this, in the existing "Upgrading legacy configurations" section.

seanparkross commented 1 month ago

Is it cool if I move these there @nullxone ?

nullxone commented 1 month ago

Sounds good, please do!

nullxone commented 4 weeks ago

@seanparkross CLI 2.6.0 released with support for upgraded metadata and these codemods. This is now ready to be merged.

nullxone commented 3 weeks ago

Added documentation for codemod to rename graphql root field and type name prefixes.

nullxone commented 3 weeks ago

cc @aayshasura

hasura / ddn-docs