hasura / ddn-docs

Repository for the Hasura DDN version of docs

https://hasura.io/docs

2 stars 6 forks source link

Docs: Add compatiblity configuration #593

Closed rakeshkky closed 1 month ago

rakeshkky commented 1 month ago

Description 📝

Add a new section Compatibility Configuration under existing Project Configuration -> Configuration page, that outlines the compatibility date configuration with available features.

Quick Links 🚀

https://rakeshkky-apipg-853-compatib.v3-docs-eny.pages.dev/project-configuration/config/compatibility

Assertion Tests 🤖

linear[bot] commented 1 month ago

APIPG-853 Docs | `relations_comparison` bypass feature compatibility

Add docs for compatibility date for `relations_comparison` bypass feature.

hasura-bot commented 1 month ago

Redirects 🔀

Hey, @robertjdominguez & @seanparkross — the following redirects will be needed for deployment:

# TEST ME: https://stage.hasura.io/docs/3.0/project-configuration/config/
location = /docs/3.0/project-configuration/config/ {
    return 301 https://$host/docs/3.0/project-configuration/config/index/;
}

hasura-bot commented 1 month ago

Hey, @rakeshkky :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:

[x] 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.
[ ] Rob will need a review from someone on your team to ensure your team-specific content is accurate. Once that's done, ping Rob on Slack, and he'll give a docs review :fire:
[x] 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 Rob know the level of urgency on Slack :+1:

hasura-bot commented 1 month ago

DX: Assertion Testing

✅ Diff

The PR updates the links to reflect renamed files which maintains the integrity of the documentation. The addition of the compatibility.mdx file is outlined clearly and serves an important role in guiding users through the setup of compatibility dates, further enhancing the documentation quality.

✅ Integrated

The changes complement the existing documentation by ensuring that links remain functional after file renames. The newly added compatibility.mdx file integrates well with the set of changed files, providing necessary context on backward incompatible features and delivering improved usability by clearly explaining how to set and utilize compatibility dates within Hasura DDN.

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

Deploying v3-docs with Cloudflare Pages

Latest commit:	`16fc468`
Status:	✅ Deploy successful!
Preview URL:	https://e139507f.v3-docs-eny.pages.dev
Branch Preview URL:	https://rakeshkky-apipg-853-compatib.v3-docs-eny.pages.dev

View logs

robertjdominguez commented 1 month ago

Thanks for this @rakeshkky!

I've taken your work and am applying it to this PR: closing in favor #591. We're updating the Supergraph Modeling section and this largely belongs there. Next week, we've another task: cleaning up the Project Configuration section as well.

Thanks for your contribution and know that it will live on in Supergraph Modeling!