hasura / ddn-docs

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

update outdated getting started sections #627

Closed rikinsk closed 1 month ago

rikinsk commented 1 month ago

Description 📝

Quick Links 🚀

https://rikinsk-update-getting-start.v3-docs-eny.pages.dev/getting-started/build/connect-to-data/connect-a-source

https://rikinsk-update-getting-start.v3-docs-eny.pages.dev/getting-started/build/add-business-logic

Assertion Tests 🤖

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/getting-started/build/03-connect-to-data/_databaseDocs/_clickHouse/_01-connect-a-source/
location = /docs/3.0/getting-started/build/03-connect-to-data/_databaseDocs/_clickHouse/_01-connect-a-source/ {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}
# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/build/03-connect-to-data/_databaseDocs/_graphql/_01-connect-a-source/
location = /docs/3.0/getting-started/build/03-connect-to-data/_databaseDocs/_graphql/_01-connect-a-source/ {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}
# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/build/03-connect-to-data/_databaseDocs/_mongoDB/_01-connect-a-source/
location = /docs/3.0/getting-started/build/03-connect-to-data/_databaseDocs/_mongoDB/_01-connect-a-source/ {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}
# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/build/03-connect-to-data/_databaseDocs/_openAPI/_01-connect-a-source/
location = /docs/3.0/getting-started/build/03-connect-to-data/_databaseDocs/_openAPI/_01-connect-a-source/ {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}
# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/build/03-connect-to-data/_databaseDocs/_postgreSQL/_01-connect-a-source/
location = /docs/3.0/getting-started/build/03-connect-to-data/_databaseDocs/_postgreSQL/_01-connect-a-source/ {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}
# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/build/_databaseDocs/_go/_06-add-business-logic/
location = /docs/3.0/getting-started/build/_databaseDocs/_go/_06-add-business-logic/ {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}
# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/build/_databaseDocs/_python/_06-add-business-logic/
location = /docs/3.0/getting-started/build/_databaseDocs/_python/_06-add-business-logic/ {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}
# 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;
}
hasura-bot commented 1 month 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:

hasura-bot commented 1 month ago

DX: Assertion Testing

✅ Diff

The changes in PR #627 appear consistent and precise. Renaming 'format_timezone_data' to 'format_timezone_date' makes the function's purpose clearer, suggesting that it deals with date formatting rather than broader timezone data. The addition of instructions for running commands and the creation of models/relationships is clearly documented. However, the removal of 'T08:00:00Z' in the example query should be accompanied by an explanation, as this could alter the result of the date formatting operation depending on the implementation.

✅ Integrated

The changes introduced in the PR integrate well with the overall structure. The updates enhance clarity, such as the changes from 'init' to 'initialize' and adding specific titles like 'What did connector init do?'. Removing repetitive notes on port matching in '.env' files across different databases helps to declutter the documentation. Adding the 'Step 3. Track your tables' section for ClickHouse provides necessary detail for users to follow through with setting up their API. The reformatting of the GraphQL introspection step to explicitly separate 'Track your types' from the build and restart steps improves the documentation flow and usability.

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

Deploying v3-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: efe6fdf
Status: ✅  Deploy successful!
Preview URL: https://d2af0a20.v3-docs-eny.pages.dev
Branch Preview URL: https://rikinsk-update-getting-start.v3-docs-eny.pages.dev

View logs