Minor change for cloud since release of webhooks#3521
Minor change for cloud since release of webhooks#3521gillian-meilisearch wants to merge 1 commit intomainfrom
Conversation
📝 WalkthroughWalkthroughUpdated webhook configuration guidance in documentation by replacing the recommendation to use the Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
resources/self_hosting/webhooks.mdx (1)
13-13: Add a direct link to the Cloud Webhooks settings page for discoverability.This update is clear, but users cannot click through from this page. Please link
Project Settings > Webhooksto the relevant Meilisearch Cloud docs/settings page.As per coding guidelines, "When adding or moving content, update or add links from related pages so users can find it."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@resources/self_hosting/webhooks.mdx` at line 13, Replace the plain text "Project Settings > Webhooks" with a clickable link to the Meilisearch Cloud Webhooks settings/docs page (use the canonical URL for Meilisearch Cloud Webhooks), e.g., update the string in resources/self_hosting/webhooks.mdx so the phrase "Project Settings > Webhooks" becomes a Markdown/MDX anchor to the Cloud Webhooks settings/docs; ensure the link opens the correct Meilisearch Cloud page and follow existing link style used elsewhere in the repo for consistency.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed. Nitpick comments: In `@resources/self_hosting/webhooks.mdx`: - Line 13: Replace the plain text "Project Settings > Webhooks" with a clickable link to the Meilisearch Cloud Webhooks settings/docs page (use the canonical URL for Meilisearch Cloud Webhooks), e.g., update the string in resources/self_hosting/webhooks.mdx so the phrase "Project Settings > Webhooks" becomes a Markdown/MDX anchor to the Cloud Webhooks settings/docs; ensure the link opens the correct Meilisearch Cloud page and follow existing link style used elsewhere in the repo for consistency. ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: cae7ee66-54cd-4bb1-bc21-3e8243b7cbc4
📒 Files selected for processing (1)
resources/self_hosting/webhooks.mdx
| Preview deployment for your docs. Learn more about Mintlify Previews.
|
| This guide teaches you how to configure a single webhook via instance options to notify a URL when Meilisearch completes a [task](/learn/async/asynchronous_operations). | ||
| | ||
| <Tip> | ||
| If you are using Meilisearch Cloud or need to configure multiple webhooks, use the [`/webhooks` API route](/reference/api/webhooks) instead. |
There was a problem hiding this comment.
I thought we could keep the "use the /webhooks API route" in addition to "you can configure webhooks under Project Settings > Webhooks" to make it explicit that both are now possible for Cloud users (except if there's some other limitation on the Cloud?).
| I do think that with the new architecture, I would prefer to create a new capability named Platform, where we list most of the advantages of the cloud and all the management of the Meilisearch platform. Such as resources (architecture, region, upgrade, monitoring, dumps), webhooks, teams (bring back), billing, and sharding. This way we would have a clear separation and we would keep the self-hosting section only for the the people that want to self-host without mentioning the cloud 2 sentences. I will also allow us to have better presentation of those capabilities. |
Description
The ability to add, update and delete webhooks has been added to Meilisearch Cloud today. This doc change points to where this can be done in the Cloud
Checklist
For internal Meilisearch team member only:
For external maintainers
Summary by CodeRabbit