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: update quickstart for beta #302

Merged
merged 18 commits into from
Mar 22, 2024

Conversation

robertjdominguez
Copy link
Collaborator

@robertjdominguez robertjdominguez commented Mar 14, 2024

Description

This PR updates the quickstart to match the recent DX updates including the quickstart and dev commands in the new CLI.

Quick Links 🚀

Notes for the reviewer 🔍

If you're testing this before the official beta launch, there's a few important caveats:

  1. The caveats mentioned in this document are validly reflected in this guide. There are a few extra steps that are called out by red admonitions, letting you know the DX will be more streamlined upon release. Of course, we'll have to update these admonitions and steps before the release.
  2. In a very inconsistent manner, builds would fail when starting ddn dev due to timeouts. This seems like an issue with connector deployment 🤷
  3. Do try to give it the end-to-end experience of starting with the overview (which will have an ERD / graphic updating it before the launch) and carry through to the next steps page to see if the flow feels complete.

🤖 DX: Assertion Tests

...to come soon, but there are too many TODO comments currently in the branch

@robertjdominguez robertjdominguez added the hold-for-beta This PR should be held for the beta release on 29 February 2024. label Mar 14, 2024
@robertjdominguez
Copy link
Collaborator Author

robertjdominguez commented Mar 14, 2024

Redirects 🔀

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

# TEST ME: https://stage.hasura.io/docs/3.0/ci-cd/tunnels/
location = /docs/3.0/ci-cd/tunnels/ {
    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/local-dev/
location = /docs/3.0/local-dev/ {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}

@robertjdominguez
Copy link
Collaborator Author

Hey, @robertjdominguez 👋

Thanks for this PR! Since you changed docs files, our automated Action assigned Rob as your reviewer 🎉

Before Rob looks over the changes, we ask you to take care of a couple of items:

  • Make sure you've checked over our PR guide on the wiki. It ensures you've done your due diligence on the basics: spelling, heading casings, etc.
  • Rob will need a review from someone on your team to ensure your team-specific content is accurate. Once that's done, ping Rob on Slack, and he'll give a docs review 🔥
  • Additionally, please check this box to confirm your feature works as expected when using the documentation you've written. This is critical to ensuring our users have the information they need.

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 👍

Copy link

cloudflare-workers-and-pages bot commented Mar 14, 2024

Deploying v3-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 7578713
Status: ✅  Deploy successful!
Preview URL: https://898b5808.v3-docs-eny.pages.dev
Branch Preview URL: https://rob-docs-update-quickstart-f.v3-docs-eny.pages.dev

View logs

@robertjdominguez
Copy link
Collaborator Author

Images automagically compressed by Calibre's image-actions

Compression reduced images by 35.1%, saving 587.54 KB.

Filename Before After Improvement Visual comparison
static/img/get-started/0.0.1_console_ac-dc.png 176.13 KB 116.18 KB -34.0% View diff
static/img/get-started/0.0.1_console_chinook-api.png 142.22 KB 92.17 KB -35.2% View diff
static/img/get-started/0.0.1_console_disallowed_roles.png 116.38 KB 74.63 KB -35.9% View diff
static/img/get-started/0.0.1_console_explorer.png 158.12 KB 97.98 KB -38.0% View diff
static/img/get-started/0.0.1_console_run-scoldUser.png 152.94 KB 100.41 KB -34.3% View diff
static/img/get-started/0.0.1_console-execute-query-on-build.png 191.55 KB 127.04 KB -33.7% View diff
static/img/get-started/0.0.1_vs-code_add-relationship.png 213.70 KB 139.12 KB -34.9% View diff
static/img/get-started/0.0.1_vs-code_existing-user-permissions.png 164.66 KB 105.26 KB -36.1% View diff
static/img/get-started/0.0.1_vs-code_track-chinook.png 158.09 KB 102.31 KB -35.3% View diff
static/img/get-started/0.0.1_vs-code_track-new-function.png 198.36 KB 129.51 KB -34.7% View diff

57 images did not require optimisation.

@robertjdominguez robertjdominguez marked this pull request as ready for review March 16, 2024 17:42
Copy link
Member

@soorajshankar soorajshankar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is awesome folks!
Adding some high level thoughts

docs/getting-started/1-create-a-project.mdx Outdated Show resolved Hide resolved
docs/getting-started/1-create-a-project.mdx Outdated Show resolved Hide resolved
docs/getting-started/2-add-business-logic.mdx Show resolved Hide resolved
docs/getting-started/2-add-business-logic.mdx Outdated Show resolved Hide resolved
docs/getting-started/2-add-business-logic.mdx Outdated Show resolved Hide resolved
docs/getting-started/2-add-business-logic.mdx Outdated Show resolved Hide resolved
docs/getting-started/2-add-business-logic.mdx Show resolved Hide resolved
docs/getting-started/2-add-business-logic.mdx Show resolved Hide resolved
static/img/get-started/0.0.1_console_explorer.png Outdated Show resolved Hide resolved
docs/getting-started/1-create-a-project.mdx Outdated Show resolved Hide resolved
@robertjdominguez
Copy link
Collaborator Author

Images automagically compressed by Calibre's image-actions

Compression reduced images by 33.8%, saving 50.29 KB.

Filename Before After Improvement Visual comparison
static/img/get-started/0.0.1_console_query-with-permissions.png 148.58 KB 98.29 KB -33.8% View diff

67 images did not require optimisation.

Copy link
Collaborator

@seanparkross seanparkross left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rad. Don't let the number of comments be a thing. It's mostly small stylistic stuff. 🚀

docs/getting-started/overview.mdx Outdated Show resolved Hide resolved
docs/getting-started/1-create-a-project.mdx Outdated Show resolved Hide resolved
docs/getting-started/1-create-a-project.mdx Outdated Show resolved Hide resolved
docs/getting-started/1-create-a-project.mdx Show resolved Hide resolved
docs/getting-started/1-create-a-project.mdx Outdated Show resolved Hide resolved
docs/getting-started/3-add-a-subgraph.mdx Outdated Show resolved Hide resolved
docs/getting-started/3-add-a-subgraph.mdx Show resolved Hide resolved
docs/getting-started/3-add-a-subgraph.mdx Outdated Show resolved Hide resolved
docs/getting-started/next-steps.mdx Outdated Show resolved Hide resolved
docs/getting-started/next-steps.mdx Outdated Show resolved Hide resolved
@robertjdominguez
Copy link
Collaborator Author

Images automagically compressed by Calibre's image-actions

Compression reduced images by 33.8%, saving 64.31 KB.

Filename Before After Improvement Visual comparison
static/img/get-started/0.0.1_console-execute-query-on-build.png 190.33 KB 126.02 KB -33.8% View diff

67 images did not require optimisation.

@robertjdominguez robertjdominguez merged commit 98d6881 into main Mar 22, 2024
3 of 4 checks passed
@robertjdominguez robertjdominguez deleted the rob/docs/update-quickstart-for-beta branch March 22, 2024 13:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hold-for-beta This PR should be held for the beta release on 29 February 2024.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants