-
Notifications
You must be signed in to change notification settings - Fork 1.4k
[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
base: main
Are you sure you want to change the base?
[PM-17562] Update documentation for event integrations #5924
Conversation
Codecov ReportAttention: Patch coverage is
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. 🚀 New features to boost your workflow:
|
Great job, no security vulnerabilities found in this Pull Request |
There was a problem hiding this 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.
src/Core/AdminConsole/Services/Implementations/EventIntegrations/README.md
Outdated
Show resolved
Hide resolved
src/Core/AdminConsole/Services/Implementations/EventIntegrations/README.md
Outdated
Show resolved
Hide resolved
src/Core/AdminConsole/Services/Implementations/EventIntegrations/README.md
Outdated
Show resolved
Hide resolved
src/Core/AdminConsole/Services/Implementations/EventIntegrations/README.md
Outdated
Show resolved
Hide resolved
src/Core/AdminConsole/Services/Implementations/EventIntegrations/README.md
Outdated
Show resolved
Hide resolved
src/Core/AdminConsole/Services/Implementations/EventIntegrations/README.md
Outdated
Show resolved
Hide resolved
src/Core/AdminConsole/Services/Implementations/EventIntegrations/README.md
Outdated
Show resolved
Hide resolved
src/Core/AdminConsole/Services/Implementations/EventIntegrations/README.md
Outdated
Show resolved
Hide resolved
src/Core/AdminConsole/Services/Implementations/EventIntegrations/README.md
Outdated
Show resolved
Hide resolved
src/Core/AdminConsole/Services/Implementations/EventIntegrations/README.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Matt Bishop <[email protected]>
…or-event-integrations
…or of single bacticks for JSON
|
There was a problem hiding this 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.
🎟️ 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
🦮 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