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

Caching plugin docs #772

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open

Caching plugin docs #772

wants to merge 11 commits into from

Conversation

i-am-tom
Copy link
Contributor

@i-am-tom i-am-tom commented Nov 20, 2024

Description 📝

This PR adds a quickstart guide for the caching plugin. It also renames the current quickstart guide for plugins to be allowlist-specific.

Quick Links 🚀

Assertion Tests 🤖

The documentation now describes how to add server-side caching to an existing Hasura project.

@hasura-bot
Copy link
Contributor

Error testing the assertions. Check the logs.

@hasura-bot
Copy link
Contributor

hasura-bot commented Nov 20, 2024

Redirects 🔀

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

# TEST ME: https://stage.hasura.io/docs/3.0/plugins/quickstart/
location = /docs/3.0/plugins/quickstart/ {
    return 301 https://$host/docs/3.0/plugins/allowlist/;
}

@hasura-bot
Copy link
Contributor

@i-am-tom Thanks for your PR! I've assigned @robertjdominguez to review it.

Copy link

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

Deploying v3-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: f0a648b
Status: ✅  Deploy successful!
Preview URL: https://87de2b3a.v3-docs-eny.pages.dev
Branch Preview URL: https://i-am-tom-caching-plugin-docs.v3-docs-eny.pages.dev

View logs

@i-am-tom i-am-tom marked this pull request as ready for review November 20, 2024 14:34
@i-am-tom i-am-tom changed the title [WIP] Caching plugin docs Caching plugin docs Nov 20, 2024
Copy link
Collaborator

@robertjdominguez robertjdominguez left a comment

Choose a reason for hiding this comment

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

Overall, this is a great addition @i-am-tom 🎉

I made a few suggestions for ordering clarity. One important thing: it was quite clear in @paritosh-08's example for allowlists how this should eventually be deployed. While the docker setup is great for local dev, can we add a section at the end that explains how users should handle referencing the deployed version of this plugin?

From my understanding, we don't host plugins. So, maybe taking the url value for the plugin and throwing it into an env would be a good start? Then, simply explain that in their .env.cloud they'd modify that value to reflect the deployed instance?

docs/plugins/caching.mdx Outdated Show resolved Hide resolved
docs/plugins/allowlist.mdx Outdated Show resolved Hide resolved
docs/plugins/caching.mdx Outdated Show resolved Hide resolved
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.

3 participants