search

hasura / ddn-docs

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

Docs: Refactor Getting Started #731

Open robertjdominguez opened 1 day ago

robertjdominguez commented 1 day ago

Description 📝

Moves:

Adds:

Quick Links 🚀

☝️

TODO

Instructions for other contributors

  1. Create a new branch off rob/docs/refactor-quickstart
  2. Duplicate the getting-started/with-postgresql.mdx file
  3. Update the frontmatter: MongoDB should be 4 and ClickHouse should be 5
  4. Update Step 1 to include creating an entity in your data source
  5. Modify the env vars table in Step 4 to be connector-specific
  6. Modify the query and response to match your entity in Step 4
  7. Grep for any instances of post and clean them up
  8. Open a PR and ping Rob

NB: The Next steps section is intentionally a dead-end. Once the other PR is up, we'll clean these up and link to the connector-specific data modeling sections there 🤙

Instructions for reviewers

These changes are based off a set of conversations with Tanmai. Critical to upcoming launches is a coherent getting-started experience that lets users of our three key sources (PostgreSQL, MongoDB, and ClickHouse) get hands-on as quickly as possible with DDN. By shifting to this format, we're dropping users into familiar territory with their native data source and then having them wire up a single model — they can see it from "end to end" via creation » tracking » query.

This guide is purposefully absent of educational material or any content that may produce a cognitive overload.

A subsequent PR will scaffold out a new Data Modeling directory that we'll link to from these guides and will contain connector-specific and abstracted lifecycle information for entities like Models, Commands, and Relationships.

hasura-bot commented 1 day ago

Redirects 🔀

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

# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/explore/_category_.json
location = /docs/3.0/getting-started/explore/_category_.json {
    return 301 https://$host/docs/3.0/basics/explore/_category_.json;
}
# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/explore/explore-your-api/
location = /docs/3.0/getting-started/explore/explore-your-api/ {
    return 301 https://$host/docs/3.0/basics/explore/explore-your-api/;
}
# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/explore/index/
location = /docs/3.0/getting-started/explore/index/ {
    return 301 https://$host/docs/3.0/basics/explore/index/;
}
# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/explore/interact/
location = /docs/3.0/getting-started/explore/interact/ {
    return 301 https://$host/docs/3.0/basics/explore/interact/;
}
# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/explore/monitor/
location = /docs/3.0/getting-started/explore/monitor/ {
    return 301 https://$host/docs/3.0/basics/explore/monitor/;
}
# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/deployment/01-create-a-project/
location = /docs/3.0/getting-started/deployment/01-create-a-project/ {
    return 301 https://$host/docs/3.0/deployment/deployment/01-create-a-project/;
}
# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/deployment/02-create-a-subgraph/
location = /docs/3.0/getting-started/deployment/02-create-a-subgraph/ {
    return 301 https://$host/docs/3.0/deployment/deployment/02-create-a-subgraph/;
}
# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/deployment/03-deploy-a-connector/
location = /docs/3.0/getting-started/deployment/03-deploy-a-connector/ {
    return 301 https://$host/docs/3.0/deployment/deployment/03-deploy-a-connector/;
}
# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/deployment/04-deploy-your-supergraph/
location = /docs/3.0/getting-started/deployment/04-deploy-your-supergraph/ {
    return 301 https://$host/docs/3.0/deployment/deployment/04-deploy-your-supergraph/;
}
# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/deployment/_databaseDocs/_clickHouse/_03-deploy-a-connector/
location = /docs/3.0/getting-started/deployment/_databaseDocs/_clickHouse/_03-deploy-a-connector/ {
    return 301 https://$host/docs/3.0/deployment/deployment/_databaseDocs/_clickHouse/_03-deploy-a-connector/;
}
# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/deployment/_databaseDocs/_go/_03-deploy-a-connector/
location = /docs/3.0/getting-started/deployment/_databaseDocs/_go/_03-deploy-a-connector/ {
    return 301 https://$host/docs/3.0/deployment/deployment/_databaseDocs/_go/_03-deploy-a-connector/;
}
# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/deployment/_databaseDocs/_graphql/_03-deploy-a-connector/
location = /docs/3.0/getting-started/deployment/_databaseDocs/_graphql/_03-deploy-a-connector/ {
    return 301 https://$host/docs/3.0/deployment/deployment/_databaseDocs/_graphql/_03-deploy-a-connector/;
}
# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/deployment/_databaseDocs/_mongoDB/_03-deploy-a-connector/
location = /docs/3.0/getting-started/deployment/_databaseDocs/_mongoDB/_03-deploy-a-connector/ {
    return 301 https://$host/docs/3.0/deployment/deployment/_databaseDocs/_mongoDB/_03-deploy-a-connector/;
}
# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/deployment/_databaseDocs/_openAPI/_03-deploy-a-connector/
location = /docs/3.0/getting-started/deployment/_databaseDocs/_openAPI/_03-deploy-a-connector/ {
    return 301 https://$host/docs/3.0/deployment/deployment/_databaseDocs/_openAPI/_03-deploy-a-connector/;
}
# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/deployment/_databaseDocs/_postgreSQL/_03-deploy-a-connector/
location = /docs/3.0/getting-started/deployment/_databaseDocs/_postgreSQL/_03-deploy-a-connector/ {
    return 301 https://$host/docs/3.0/deployment/deployment/_databaseDocs/_postgreSQL/_03-deploy-a-connector/;
}
# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/deployment/_databaseDocs/_python/_03-deploy-a-connector/
location = /docs/3.0/getting-started/deployment/_databaseDocs/_python/_03-deploy-a-connector/ {
    return 301 https://$host/docs/3.0/deployment/deployment/_databaseDocs/_python/_03-deploy-a-connector/;
}
# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/deployment/_databaseDocs/_typeScript/_03-deploy-a-connector/
location = /docs/3.0/getting-started/deployment/_databaseDocs/_typeScript/_03-deploy-a-connector/ {
    return 301 https://$host/docs/3.0/deployment/deployment/_databaseDocs/_typeScript/_03-deploy-a-connector/;
}
# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/deployment/index/
location = /docs/3.0/getting-started/deployment/index/ {
    return 301 https://$host/docs/3.0/deployment/deployment/index/;
}
# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/build/00-prerequisites/
location = /docs/3.0/getting-started/build/00-prerequisites/ {
    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/01-init-supergraph/
location = /docs/3.0/getting-started/build/01-init-supergraph/ {
    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/02-init-subgraph/
location = /docs/3.0/getting-started/build/02-init-subgraph/ {
    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/01-connect-a-source/
location = /docs/3.0/getting-started/build/03-connect-to-data/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/02-create-source-metadata/
location = /docs/3.0/getting-started/build/03-connect-to-data/02-create-source-metadata/ {
    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/_category_.json
location = /docs/3.0/getting-started/build/03-connect-to-data/_category_.json {
    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/_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/03-connect-to-data/index/
location = /docs/3.0/getting-started/build/03-connect-to-data/index/ {
    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/04-build-your-api/
location = /docs/3.0/getting-started/build/04-build-your-api/ {
    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/05-add-permissions/
location = /docs/3.0/getting-started/build/05-add-permissions/ {
    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/06-add-business-logic/
location = /docs/3.0/getting-started/build/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/07-create-a-relationship/
location = /docs/3.0/getting-started/build/07-create-a-relationship/ {
    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/08-mutate-data/
location = /docs/3.0/getting-started/build/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/_category_.json
location = /docs/3.0/getting-started/build/_category_.json {
    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/_graphql/_08-mutate-data/
location = /docs/3.0/getting-started/build/_databaseDocs/_graphql/_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/_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;
}
# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/build/index/
location = /docs/3.0/getting-started/build/index/ {
    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/deployment/_category_.json
location = /docs/3.0/getting-started/deployment/_category_.json {
    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/collaborate/_category_.json
location = /docs/3.0/getting-started/collaborate/_category_.json {
    return 301 https://$host/docs/3.0/hasura-cloud/collaborate/_category_.json;
}
# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/collaborate/best-practices/
location = /docs/3.0/getting-started/collaborate/best-practices/ {
    return 301 https://$host/docs/3.0/hasura-cloud/collaborate/best-practices/;
}
# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/collaborate/comment/
location = /docs/3.0/getting-started/collaborate/comment/ {
    return 301 https://$host/docs/3.0/hasura-cloud/collaborate/comment/;
}
# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/collaborate/federation/
location = /docs/3.0/getting-started/collaborate/federation/ {
    return 301 https://$host/docs/3.0/hasura-cloud/collaborate/federation/;
}
# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/collaborate/index/
location = /docs/3.0/getting-started/collaborate/index/ {
    return 301 https://$host/docs/3.0/hasura-cloud/collaborate/index/;
}
# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/collaborate/invite/
location = /docs/3.0/getting-started/collaborate/invite/ {
    return 301 https://$host/docs/3.0/hasura-cloud/collaborate/invite/;
}
hasura-bot commented 1 day ago

@robertjdominguez Thanks for your PR! I've assigned @robertjdominguez to review it.

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

Deploying v3-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 081217a
Status: ✅  Deploy successful!
Preview URL: https://783f09c6.v3-docs-eny.pages.dev
Branch Preview URL: https://rob-docs-refactor-quickstart.v3-docs-eny.pages.dev

View logs