update engine plugin docs

[paritosh-08]

Description 📝

This PR updates the docs for engine plugins.

• Add an architecture diagram on the introduction page.
• Update the quickstart page to add missing/unclear steps.
• Remove LeafConfig from the metadata ref page.

Quick Links 🚀

• Introduction page: https://paritosh-apipg-890.v3-docs-eny.pages.dev/plugins/introduction/
• Quickstart page: https://paritosh-apipg-890.v3-docs-eny.pages.dev/plugins/quickstart
• Metadata ref page: https://paritosh-apipg-890.v3-docs-eny.pages.dev/supergraph-modeling/engine-plugins

Assertion Tests 🤖

[linear[bot]]

APIPG-890 Add more info to docs as per user feedback

[https://hasurahq.slack.com/archives/C06P2U8U55G/p1726170627499649](https://hasurahq.slack.com/archives/C06P2U8U55G/p1726170627499649)

[hasura-bot]

Hey, @paritosh-08 :wave:

Thanks for this PR! Since you changed docs files, our automated Action assigned Sean as your reviewer :tada:

Before Sean 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.
• [ ] Sean will need a review from someone on your team to ensure your team-specific content is accurate. Once that's done, ping Sean on Slack, and he'll give a docs review :fire:
• [ ] 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 Sean know the level of urgency on Slack :+1:

[hasura-bot]

DX: Assertion Testing

✅ Diff

The PR updates terminology consistently (e.g., 'cloudflare allow list' to 'cloudflare allowlist'), improves session and rawRequest config object declarations (replacing LeafConfig with {}), and adds valuable visual context with the 'Architecture' section including an image. However, there's a typo in the 'quickstart.mdx' file: 'Wranlger' should be corrected to 'Wrangler'. Also, ensure that the 'hasura-m-auth' key is properly safeguarded if it's sensitive.

✅ Integrated

Integration of the new sections and fixes appears to be seamless with the overall documentation structure. The new subsection 'Pre-Parse Plugin Request' with a sample request adds practical guidance on how a plugin configuration translates into an actual request. The restructuring of the quickstart guide streamlines the setup process. The addition of the local testing steps in 'quickstart.mdx' (Step 2 to Step 5) and the graphical representation of the architecture in 'introduction.mdx' augment the usability by making the setup and test process clearer for the user. Make sure the image file 'architecture.jpg' is correctly checked into the repository with the right path specified.

[hasura-bot]

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 26.1%, saving 17.48 KB.

Filename	Before	After	Improvement	Visual comparison
static/img/plugins/architecture.jpg	66.89 KB	49.41 KB	-26.1%	View diff

177 images did not require optimisation.

[cloudflare-workers-and-pages[bot]]

Deploying v3-docs with    Cloudflare Pages

Latest commit:	a92e8e6
Status:	✅  Deploy successful!
Preview URL:	https://8b72fa63.v3-docs-eny.pages.dev
Branch Preview URL:	https://paritosh-apipg-890.v3-docs-eny.pages.dev

View logs

[seanparkross]

Q: What is m-auth?

[seanparkross]

Hi @rahulagarwal13 As chatted to @paritosh-08 about... This new repo https://github.com/hasura/plugin-allowlist Should we name it engine-plugin-allowlist so that we don’t confuse CLI and engine plugins down the line? It’s new so I thought I’d bring it up now to hopefully catch it while we can.

[paritosh-08]

Q: What is m-auth?

M-auth stands for mutual authentication. The engine will send a random (pre-selected) string in the header, which will be checked by the plugin server to allow/disallow the request.

[seanparkross]

Q: What is m-auth?

M-auth stands for mutual authentication. The engine will send a random (pre-selected) string in the header, which will be checked by the plugin server to allow/disallow the request.

Nice! Can we document this? Maybe for now just an admonition in this (engine plugins) section?

[seanparkross]

:) Will approve as soon as you've added that 👍

[rahulagarwal13]

Hi @rahulagarwal13 As chatted to @paritosh-08 about... This new repo https://github.com/hasura/plugin-allowlist Should we name it engine-plugin-allowlist so that we don’t confuse CLI and engine plugins down the line? It’s new so I thought I’d bring it up now to hopefully catch it while we can.

@seanparkross - nice catch! yes let's make it explicit. I am fine with changing the repo name to "engine-plugin-"