add architecture docs and refctor deployment docs #805

shahidhk · 2024-12-11T00:24:43Z

Description 📝

Revamp the deployment docs section and refactor that into architecture and deployment sections.

Quick Links 🚀

https://shahidhk-architecture-docs.v3-docs-eny.pages.dev/architecture/overview/
https://shahidhk-architecture-docs.v3-docs-eny.pages.dev/deployment/overview/

Assertion Tests 🤖

Architecture docs are added to understand different options of deploying DDN platform. Deployment docs are refactored to have only how-to guides.

hasura-bot · 2024-12-11T00:24:59Z

Error testing the assertions. Check the logs.

hasura-bot · 2024-12-11T00:25:18Z

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

hasura-bot · 2024-12-11T00:25:57Z

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 52.7%, saving 500.88 KB.

Filename	Before	After	Improvement	Visual comparison
`static/img/deployment/private_ddn.png`	950.16 KB	449.28 KB	-52.7%	View diff

207 images did not require optimisation.

cloudflare-workers-and-pages · 2024-12-11T00:25:59Z

Deploying ddn-docs with Cloudflare Pages

Latest commit:	`66315b3`
Status:	⚡️ Build in progress...

View logs

seanparkross · 2024-12-11T13:01:31Z

Awaiting further info and for this to come out of draft to review @shahidhk

hasura-bot · 2024-12-12T08:18:28Z

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 57.5%, saving 670.37 KB.

Filename	Before	After	Improvement	Visual comparison
`static/img/deployment/private_ddn_byoc_detailed.png`	277.04 KB	89.81 KB	-67.6%	View diff
`static/img/deployment/private_ddn_byoc.png`	888.82 KB	405.68 KB	-54.4%	View diff

208 images did not require optimisation.

shahidhk · 2024-12-12T19:39:12Z

any idea why deploy failed? @hasura/docs ?

robertjdominguez · 2024-12-12T19:46:26Z

any idea why deploy failed? @hasura/docs ?

Logs return a ton of errors around /Architecture/* not being found.

Update the sidebar pathname in the _category_.json to architecture, and it should be fine.

You can test it locally by running yarn build to see if any errors are returned, @shahidhk.

hasura-bot · 2024-12-17T00:07:33Z

Redirects 🔀

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

# TEST ME: https://stage.hasura.io/docs/3.0/deployment/architecture/
location = /docs/3.0/deployment/architecture/ {
    return 301 https://$host/docs/3.0/architecture/overview/;
}

# TEST ME: https://stage.hasura.io/docs/3.0/deployment/private/hasura-hosted/
location = /docs/3.0/deployment/private/hasura-hosted/ {
    return 301 https://$host/docs/3.0/architecture/private/dedicated/;
}

# TEST ME: https://stage.hasura.io/docs/3.0/deployment/deployment/01-create-a-project/
location = /docs/3.0/deployment/deployment/01-create-a-project/ {
    return 301 https://$host/docs/3.0/deployment/ddn/01-create-a-project/;
}

# TEST ME: https://stage.hasura.io/docs/3.0/deployment/deployment/02-create-a-subgraph/
location = /docs/3.0/deployment/deployment/02-create-a-subgraph/ {
    return 301 https://$host/docs/3.0/deployment/ddn/02-create-a-subgraph/;
}

# TEST ME: https://stage.hasura.io/docs/3.0/deployment/deployment/03-deploy-a-connector/
location = /docs/3.0/deployment/deployment/03-deploy-a-connector/ {
    return 301 https://$host/docs/3.0/deployment/ddn/03-deploy-a-connector/;
}

# TEST ME: https://stage.hasura.io/docs/3.0/deployment/deployment/04-deploy-your-supergraph/
location = /docs/3.0/deployment/deployment/04-deploy-your-supergraph/ {
    return 301 https://$host/docs/3.0/deployment/ddn/04-deploy-your-supergraph/;
}

# 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/deployment/ddn/_databaseDocs/_clickHouse/_03-deploy-a-connector/;
}

# 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/deployment/ddn/_databaseDocs/_go/_03-deploy-a-connector/;
}

# 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/deployment/ddn/_databaseDocs/_graphql/_03-deploy-a-connector/;
}

# 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/deployment/ddn/_databaseDocs/_mongoDB/_03-deploy-a-connector/;
}

# 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/deployment/ddn/_databaseDocs/_openAPI/_03-deploy-a-connector/;
}

# 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/deployment/ddn/_databaseDocs/_postgreSQL/_03-deploy-a-connector/;
}

# 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/deployment/ddn/_databaseDocs/_python/_03-deploy-a-connector/;
}

# 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/deployment/ddn/_databaseDocs/_typeScript/_03-deploy-a-connector/;
}

# TEST ME: https://stage.hasura.io/docs/3.0/deployment/deployment/index/
location = /docs/3.0/deployment/deployment/index/ {
    return 301 https://$host/docs/3.0/deployment/ddn/index/;
}

# TEST ME: https://stage.hasura.io/docs/3.0/deployment/deployment/_category_.json
location = /docs/3.0/deployment/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/deployment/private/data-plane-collaboration/
location = /docs/3.0/deployment/private/data-plane-collaboration/ {
    return 301 https://$host/docs/3.0/deployment/private-ddn/data-plane-collaboration/;
}

# TEST ME: https://stage.hasura.io/docs/3.0/deployment/private/_category_.json
location = /docs/3.0/deployment/private/_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/deployment/private/self-hosted/_category_.json
location = /docs/3.0/deployment/private/self-hosted/_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/deployment/private/self-hosted/self-hosted-deployment/
location = /docs/3.0/deployment/private/self-hosted/self-hosted-deployment/ {
    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/serverless/
location = /docs/3.0/deployment/serverless/ {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}

hasura-bot · 2024-12-17T00:08:28Z

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 55.4%, saving 468.85 KB.

Filename	Before	After	Improvement	Visual comparison
`static/img/deployment/private_ddn_self_hosted.png`	846.88 KB	378.03 KB	-55.4%	View diff

211 images did not require optimisation.

…cs into shahidhk/architecture-docs

seanparkross

I have applied a bunch of nit commits directly. Main thing is there was no consistency with the capitalisation of Data Plane and Control Plane. I have gone with title case throughout as that was more common. Can change to all lowercase if needed.

shahidhk added 2 commits December 10, 2024 16:23

change sidebar positions

71a539b

add basic architecture docs structure

ed37723

hasura-bot requested a review from seanparkross December 11, 2024 00:25

Optimised images with calibre/image-actions

880e9b1

shahidhk and others added 2 commits December 12, 2024 00:17

rewrite byoc docs

dd52709

Optimised images with calibre/image-actions

bd57ac0

robertjdominguez and others added 4 commits December 12, 2024 17:18

Fix booboo

a3efb6d

add self hosted docs

9ddab9f

refactor deployment docs

aece896

fix links

fafd31b

shahidhk marked this pull request as ready for review December 16, 2024 23:54

shahidhk changed the title ~~add architecture docs~~ add architecture docs and refctor deployment docs Dec 16, 2024

Merge branch 'main' into shahidhk/architecture-docs

116af9e

Optimised images with calibre/image-actions

4a087cf

seanparkross added 6 commits December 18, 2024 11:11

docs review nit

5efdda7

Merge branch 'shahidhk/architecture-docs' of github.com:hasura/ddn-do…

4cd6a20

…cs into shahidhk/architecture-docs

docs nits

b4f73b9

docs nits

4e685e4

docs nits

dcda1ca

docs nits

31aeed1

seanparkross added 2 commits December 18, 2024 11:56

docs nits

43b87ba

docs nits

26f79ea

seanparkross approved these changes Dec 18, 2024

View reviewed changes

Merge main

66315b3

seanparkross enabled auto-merge (squash) December 19, 2024 12:28

seanparkross merged commit 67fea30 into main Dec 19, 2024
4 of 5 checks passed

seanparkross deleted the shahidhk/architecture-docs branch December 19, 2024 12:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add architecture docs and refctor deployment docs #805

add architecture docs and refctor deployment docs #805

shahidhk commented Dec 11, 2024 •

edited

Loading

hasura-bot commented Dec 11, 2024

hasura-bot commented Dec 11, 2024

hasura-bot commented Dec 11, 2024

cloudflare-workers-and-pages bot commented Dec 11, 2024 •

edited

Loading

seanparkross commented Dec 11, 2024

hasura-bot commented Dec 12, 2024

shahidhk commented Dec 12, 2024

robertjdominguez commented Dec 12, 2024 •

edited

Loading

hasura-bot commented Dec 17, 2024 •

edited

Loading

hasura-bot commented Dec 17, 2024

seanparkross left a comment

add architecture docs and refctor deployment docs #805

add architecture docs and refctor deployment docs #805

Conversation

shahidhk commented Dec 11, 2024 • edited Loading

Description 📝

Quick Links 🚀

Assertion Tests 🤖

hasura-bot commented Dec 11, 2024

hasura-bot commented Dec 11, 2024

hasura-bot commented Dec 11, 2024

cloudflare-workers-and-pages bot commented Dec 11, 2024 • edited Loading

Deploying ddn-docs with Cloudflare Pages

seanparkross commented Dec 11, 2024

hasura-bot commented Dec 12, 2024

shahidhk commented Dec 12, 2024

robertjdominguez commented Dec 12, 2024 • edited Loading

hasura-bot commented Dec 17, 2024 • edited Loading

Redirects 🔀

hasura-bot commented Dec 17, 2024

seanparkross left a comment

Choose a reason for hiding this comment

shahidhk commented Dec 11, 2024 •

edited

Loading

cloudflare-workers-and-pages bot commented Dec 11, 2024 •

edited

Loading

robertjdominguez commented Dec 12, 2024 •

edited

Loading

hasura-bot commented Dec 17, 2024 •

edited

Loading