hasura / ddn-docs

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

add legacy configs and new upgrade guide #558

Closed rikinsk closed 1 month ago

rikinsk commented 2 months ago

Description

Quick Links 🚀

https://rikinsk-update-legacy-config.v3-docs-eny.pages.dev/project-configuration/upgrading-project-config/upgrade-project-v3

🤖 DX: Assertion Tests

cloudflare-workers-and-pages[bot] commented 2 months ago

Deploying v3-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: e78c3d0
Status: ✅  Deploy successful!
Preview URL: https://2b0d3af5.v3-docs-eny.pages.dev
Branch Preview URL: https://rikinsk-update-legacy-config.v3-docs-eny.pages.dev

View logs

robertjdominguez commented 2 months ago

DX: Assertion Testing

✅ Diff

The PR successfully introduces comprehensive details on the legacy project structure, showing the format and providing clear descriptions for each file type. The use of collapsible details is a good approach to maintain readability for users who need these specifics. The structured layout, with syntax-highlighted examples, makes it easy to follow and understand how the old project configuration was set up. Furthermore, adding consistent highlighting for the newly added segments aids readers in focusing on important parts of the documentation.

✅ Integrated

The provided diff dovetails well with the overarching goal of the documentation to aid in upgrading project configurations across different versions. By covering the old configuration files and their descriptions, it enables users to have a clear understanding of the changes and the new requirements. It contributes to the overall usability by positioning this information after the upgrade guides for v2 and v3, which might help users who are lagging behind in upgrading their project structure. This supports the natural progression of reading through upgrade paths sequentially. The integration of the diff adds value to the entire document, maintaining a coherent flow and ensuring valuable legacy information is accessible without overwhelming users who are up-to-date with more recent versions.