Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: start restructure #776

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from
Draft

Conversation

robertjdominguez
Copy link
Collaborator

@robertjdominguez robertjdominguez commented Nov 21, 2024

Description 📝

  • Moves quickstart out to the top-level and resolves refs.
  • Slims down quickstart by:
    • Removing extra context and information about what's happening under the hood.
    • Modifying left-hand text for each step to be a directive and imperatively tell a user what to do.
    • Additionally, as we're directing them to use our sample db, we're ensuring a reproducible outcome
      each time, giving them the steps to validate each step works, and directing them to the next steps with
      their own sources.
  • Changes the Basics section into a How to Build with DDN section.
  • Turns the PostgreSQL guide into a tutorial. We should decide on a standard here and then make modifications to the existing MongoDB and ClickHouse guides.

TODO:

  • Update the overview (Basics) for the new section
  • Modify the MongoDB tutorial
  • Modify the ClickHouse tutorial

Quick Links 🚀

Moves quickstart out to the top-level and resolves refs.
Slims down quickstart by:
* Removing extra context and information about what's happening under the hood.
* Modifying left-hand text for each step to be a directive and imperatively tell a user what to do.

Additionally, as we're directing them to use our sample db, we're ensuring a reproducible outcome
each time, giving them the steps to validate each step works, and direcing them to next steps with
their own sources.
Change the Basics section into a How to Build with DDN section.

Still need to:
* Gut and stub the overview page to serve as an explainer.
* Modify the tutorials for each data source.
Turns the PostgreSQL guide into a tutorial. We should decide on a standard _here_ and then make modifications to the existing MongoDB and ClickHouse guides.
@hasura-bot
Copy link
Contributor

hasura-bot commented Nov 21, 2024

Redirects 🔀

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

# TEST ME: https://stage.hasura.io/docs/3.0/deployment/deployment/_databaseDocs/_clickHouse/_03-deploy-a-connector/
location = /docs/3.0/deployment/deployment/_databaseDocs/_clickHouse/_03-deploy-a-connector/ {
    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/deployment/deployment/_databaseDocs/_go/_03-deploy-a-connector/
location = /docs/3.0/deployment/deployment/_databaseDocs/_go/_03-deploy-a-connector/ {
    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/deployment/deployment/_databaseDocs/_graphql/_03-deploy-a-connector/
location = /docs/3.0/deployment/deployment/_databaseDocs/_graphql/_03-deploy-a-connector/ {
    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/deployment/deployment/_databaseDocs/_mongoDB/_03-deploy-a-connector/
location = /docs/3.0/deployment/deployment/_databaseDocs/_mongoDB/_03-deploy-a-connector/ {
    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/deployment/deployment/_databaseDocs/_openAPI/_03-deploy-a-connector/
location = /docs/3.0/deployment/deployment/_databaseDocs/_openAPI/_03-deploy-a-connector/ {
    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/deployment/deployment/_databaseDocs/_postgreSQL/_03-deploy-a-connector/
location = /docs/3.0/deployment/deployment/_databaseDocs/_postgreSQL/_03-deploy-a-connector/ {
    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/deployment/deployment/_databaseDocs/_python/_03-deploy-a-connector/
location = /docs/3.0/deployment/deployment/_databaseDocs/_python/_03-deploy-a-connector/ {
    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/deployment/deployment/_databaseDocs/_typeScript/_03-deploy-a-connector/
location = /docs/3.0/deployment/deployment/_databaseDocs/_typeScript/_03-deploy-a-connector/ {
    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/overview-old-content/.wip
location = /docs/3.0/getting-started/overview-old-content/.wip {
    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/quickstart/
location = /docs/3.0/getting-started/quickstart/ {
    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/with-postgresql/
location = /docs/3.0/getting-started/with-postgresql/ {
    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/_category_.json
location = /docs/3.0/getting-started/_category_.json {
    return 301 https://$host/docs/3.0/how-to-build-with-ddn/_category_.json;
}
# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/overview/
location = /docs/3.0/getting-started/overview/ {
    return 301 https://$host/docs/3.0/how-to-build-with-ddn/overview/;
}
# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/with-clickhouse/
location = /docs/3.0/getting-started/with-clickhouse/ {
    return 301 https://$host/docs/3.0/how-to-build-with-ddn/with-clickhouse/;
}
# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/with-mongodb/
location = /docs/3.0/getting-started/with-mongodb/ {
    return 301 https://$host/docs/3.0/how-to-build-with-ddn/with-mongodb/;
}
# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/with-others/
location = /docs/3.0/getting-started/with-others/ {
    return 301 https://$host/docs/3.0/how-to-build-with-ddn/with-others/;
}

@hasura-bot
Copy link
Contributor

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

Copy link

cloudflare-workers-and-pages bot commented Nov 22, 2024

Deploying v3-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: be2c4fc
Status: ✅  Deploy successful!
Preview URL: https://e6af0097.v3-docs-eny.pages.dev
Branch Preview URL: https://rob-docs-start-restructure.v3-docs-eny.pages.dev

View logs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants