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 o11y and query plans for beta #304

Merged
merged 8 commits into from
Mar 21, 2024

Conversation

robertjdominguez
Copy link
Collaborator

@robertjdominguez robertjdominguez commented Mar 18, 2024

Description

This PR updates the o11y section for Beta by doing the following:

  • Changes the top-level directory from observability to query-plan
  • Moves docs for the Explain API from graphql-api to query-plan
  • Adds screenshot for query and SQL execution in the console

DOCS-1814

Quick Links 🚀

Copy link

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

Deploying v3-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 841d5f8
Status:⚡️  Build in progress...

View logs

@robertjdominguez
Copy link
Collaborator Author

robertjdominguez commented Mar 18, 2024

Redirects 🔀

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

# TEST ME: https://stage.hasura.io/docs/3.0/graphql-api/explain/_category_.json
location = /docs/3.0/graphql-api/explain/_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/graphql-api/explain/api-reference/
location = /docs/3.0/graphql-api/explain/api-reference/ {
    return 301 https://$host/docs/3.0/observability/explain/api-reference/;
}
# TEST ME: https://stage.hasura.io/docs/3.0/graphql-api/explain/index/
location = /docs/3.0/graphql-api/explain/index/ {
    return 301 https://$host/docs/3.0/observability/explain/index/;
}

@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 👍

@robertjdominguez
Copy link
Collaborator Author

Images automagically compressed by Calibre's image-actions

Compression reduced images by 47.8%, saving 181.42 KB.

Filename Before After Improvement Visual comparison
static/img/explain/0.0.1_console_explain-api-sql.png 379.58 KB 198.16 KB -47.8% View diff

58 images did not require optimisation.

@robertjdominguez robertjdominguez added the hold-for-beta This PR should be held for the beta release on 29 February 2024. label Mar 18, 2024
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.

🚀

docs/query-plan/_category_.json Outdated Show resolved Hide resolved
docs/query-plan/overview.mdx Outdated Show resolved Hide resolved
docs/query-plan/overview.mdx Outdated Show resolved Hide resolved
docs/query-plan/overview.mdx Outdated Show resolved Hide resolved
docs/query-plan/overview.mdx Outdated Show resolved Hide resolved
docs/query-plan/traces.mdx Outdated Show resolved Hide resolved
docs/query-plan/traces.mdx Outdated Show resolved Hide resolved
docs/query-plan/traces.mdx Outdated Show resolved Hide resolved
docs/graphql-api/overview.mdx Outdated Show resolved Hide resolved
@robertjdominguez robertjdominguez enabled auto-merge (squash) March 21, 2024 17:31
@robertjdominguez robertjdominguez merged commit e5403cb into main Mar 21, 2024
2 of 4 checks passed
@robertjdominguez robertjdominguez deleted the rob/docs/update-o11y branch March 21, 2024 17:31
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