Closed varundey closed 1 month ago
Hey, @varundey :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:
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:
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/_clickHouse/_08-mutate-data/
location = /docs/3.0/getting-started/build/_databaseDocs/_clickHouse/_08-mutate-data/ {
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/_mongoDB/_08-mutate-data/
location = /docs/3.0/getting-started/build/_databaseDocs/_mongoDB/_08-mutate-data/ {
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/_openAPI/_08-mutate-data/
location = /docs/3.0/getting-started/build/_databaseDocs/_openAPI/_08-mutate-data/ {
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/_postgreSQL/_08-mutate-data/
location = /docs/3.0/getting-started/build/_databaseDocs/_postgreSQL/_08-mutate-data/ {
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;
}
The PR diff shows a consistent update across multiple documentation files, replacing a detailed command setup with a simplified command alias ddn run docker-start
which enhances usability and provides a cleaner setup process for the user. The removal of direct docker compose
command along with the explicit HASURA_DDN_PAT
environment setup simplifies the user experience and reduces the complexity of starting the services.
The PR's integration with the existing documentation provides an improved user experience by contributing to a standardized and more maintainable approach for starting services. This integration appears to be consistent and well-documented across all instances where the services need to be started. The added 'tip' blocks are particularly useful, providing additional context and ensuring users don't forget to start their engines, thus contributing positively to the overall usability of the documentation.
Added a separate PR since this will have changes around its accompanying text which can be reviewed separately from the parent PR
Quick Links 🚀
Assertion Tests 🤖