Skip to content

Add events for Sites#2780

Merged
eldadfux merged 1 commit intomainfrom
sites-events
Mar 3, 2026
Merged

Add events for Sites#2780
eldadfux merged 1 commit intomainfrom
sites-events

Conversation

@atharvadeosthale
Copy link
Member

@atharvadeosthale atharvadeosthale commented Mar 3, 2026

Summary by CodeRabbit

  • Documentation
    • Introduced new Sites events documentation, detailing event definitions for site and deployment lifecycle events including creation, deletion, updates, and related deployment operations with comprehensive descriptions and object type references.
    • Enhanced the platform events documentation by integrating Sites as a key event category alongside existing categories, improving overall event reference accessibility.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 3, 2026

Walkthrough

This pull request adds documentation for cloud events related to Sites functionality. A new partial file documents site-related event definitions in a table format, including generic sites.* events, site create/delete operations, deployment events, and site updates with their descriptions and return object types. The main events documentation page is updated to include a new Sites accordion section linking to this partial, positioned between Functions and Messaging sections.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Add events for Sites' directly matches the main change: adding a new documentation partial listing cloud events for Sites to the events documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch sites-events

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@src/partials/sites-events.md`:
- Line 9: Update the awkward plural phrasing in the generic event descriptions
by replacing "any sites event" with "any site event" and "any deployments event"
with "any deployment event" wherever they appear (e.g., the strings "any sites
event" and "any deployments event" in the sites-events partial); ensure singular
noun usage is applied consistently across the file.

ℹ️ Review info

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 41f211d and 42ef348.

📒 Files selected for processing (2)
  • src/partials/sites-events.md
  • src/routes/docs/advanced/platform/events/+page.markdoc

---

- `sites.*`
- This event triggers on any sites event.
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Tighten wording for grammar in generic event descriptions.

Two phrases read awkwardly: “any sites event” and “any deployments event”. Recommend singular noun forms.

✏️ Proposed wording fix
- This event triggers on any sites event.
+ This event triggers on any site event.
...
- This event triggers on any deployments event.
+ This event triggers on any deployment event.

Also applies to: 27-27

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@src/partials/sites-events.md` at line 9, Update the awkward plural phrasing
in the generic event descriptions by replacing "any sites event" with "any site
event" and "any deployments event" with "any deployment event" wherever they
appear (e.g., the strings "any sites event" and "any deployments event" in the
sites-events partial); ensure singular noun usage is applied consistently across
the file.

@eldadfux eldadfux merged commit 5e61761 into main Mar 3, 2026
6 checks passed
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.

2 participants