Skip to content

[PM-17562] Update documentation for event integrations #5924

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

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

Conversation

brant-livefront
Copy link
Contributor

@brant-livefront brant-livefront commented Jun 5, 2025

🎟️ Tracking

PM-17562

📔 Objective

This PR migrates over and expands the documentation for the event integrations feature. Previously, some parts of this were documented in the contributing-docs repo. The goal is to modify those docs to simply refer to configuration and setup and have a local README file that documents more of the architecture and code. This PR restructures the directories a bit to unify on the EventIntegrations naming and adds the README file with more thorough documentation.

⏰ Reminders before review

  • Contributor guidelines followed
  • All formatters and local linters executed and passed
  • Written new unit and / or integration tests where applicable
  • Protected functional changes with optionality (feature flags)
  • Used internationalization (i18n) for all UI strings
  • CI builds passed
  • Communicated to DevOps any deployment requirements
  • Updated any necessary documentation (Confluence, contributing docs) or informed the documentation team

🦮 Reviewer guidelines

  • 👍 (:+1:) or similar for great changes
  • 📝 (:memo:) or ℹ️ (:information_source:) for notes or general info
  • ❓ (:question:) for questions
  • 🤔 (:thinking:) or 💭 (:thought_balloon:) for more open inquiry that's not quite a confirmed issue and could potentially benefit from discussion
  • 🎨 (:art:) for suggestions / improvements
  • ❌ (:x:) or ⚠️ (:warning:) for more significant problems or concerns needing attention
  • 🌱 (:seedling:) or ♻️ (:recycle:) for future improvements or indications of technical debt
  • ⛏ (:pick:) for minor or nitpick changes

@brant-livefront brant-livefront requested a review from a team as a code owner June 5, 2025 13:31
@brant-livefront brant-livefront requested a review from JimmyVo16 June 5, 2025 13:31
Copy link

codecov bot commented Jun 5, 2025

Codecov Report

Attention: Patch coverage is 0% with 5 lines in your changes missing coverage. Please review.

Project coverage is 47.73%. Comparing base (2435063) to head (5e3fcc0).
Report is 5 commits behind head on main.

Files with missing lines Patch % Lines
...ntegrations/AzureServiceBusEventListenerService.cs 0.00% 5 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #5924      +/-   ##
==========================================
- Coverage   51.06%   47.73%   -3.33%     
==========================================
  Files        1665     1665              
  Lines       75008    75019      +11     
  Branches     6755     6757       +2     
==========================================
- Hits        38300    35811    -2489     
- Misses      35188    37748    +2560     
+ Partials     1520     1460      -60     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Contributor

github-actions bot commented Jun 5, 2025

Logo
Checkmarx One – Scan Summary & Details386c8f4a-44fc-4e03-b527-06531b0e7402

Great job, no security vulnerabilities found in this Pull Request

JimmyVo16
JimmyVo16 previously approved these changes Jun 5, 2025
Copy link
Contributor

@withinfocus withinfocus left a comment

Choose a reason for hiding this comment

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

Bunch of little things. Include diagrams next too.

Independently, I am setting up some CI and tooling to get better lint feedback on Markdown.

Copy link

sonarqubecloud bot commented Jun 6, 2025

Copy link
Contributor

@withinfocus withinfocus left a comment

Choose a reason for hiding this comment

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

@JimmyVo16 for your final approval.

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