hasura / ddn-docs

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

quickstart tweaks #542

Closed rikinsk closed 2 months ago

rikinsk commented 2 months ago

Description

Quick Links 🚀

🤖 DX: Assertion Tests

robertjdominguez commented 2 months ago

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

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:

robertjdominguez commented 2 months ago

DX: Assertion Testing

✅ Diff

The updates to the CLI installation commands correctly reflect the new versioning (v4), ensuring users download the latest version. Changes in the Quickstart guide also improve clarity, highlighting key steps such as installing Docker and initializing a new supergraph. The removal of redundancies and reordering of sections contribute to a more streamlined reading experience. The direct inclusion of the InstallTheCli component also helps maintain consistency across the documentation.

✅ Integrated

The changes integrate well with the entire set of documentation, contributing to overall usability. The documentation remains coherent, and added emphases, such as bold text for key steps, make the process more user-friendly. Adjustments to GraphQL examples and clear demarcations of required software in the prerequisites section further enhance usability. Moreover, the added 'Next steps' section with a focus on integrating custom business logic is a valuable addition for users looking to extend their implementations.

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

Deploying v3-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 8386daa
Status:⚡️  Build in progress...

View logs

robertjdominguez commented 2 months ago

Redirects 🔀

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

# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/build/_databaseDocs/_typescript/_06-add-business-logic/
location = /docs/3.0/getting-started/build/_databaseDocs/_typescript/_06-add-business-logic/ {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}