Add option to opt out of channel documentation for EventBridge
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 32/100
- Issue type
- Feature
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- aws, typescript
- Domain
- cloud
Research direction
Start by locating the EventBridge plugin in this repository and reviewing how channel documentation is currently generated. The issue provides no proposed behavior, files, or tests, so clarify the opt-out design with maintainers before coding. Done means the option prevents channel documentation while preserving other generated output.
Written by the indexing model from the issue text.
Description
Use Case
Just a nice to have... make it optional to document channels in the EventBridge plugin, some may not want this
Proposed Solution
No response
Implementation Notes
No response
Community Notes
- Please vote by adding a 👍 reaction to the issue to help us prioritize.
- If you are interested to work on this issue, please leave a comment.
- If this issue is labeled needs-discussion, it means the spec has not been finalized yet. Please reach out in the EventCatalog Discord.
- Dominant language
- TypeScript
- Stars
- 16
- Forks
- 15
- Avg merge
- 3m
- Merged PRs (30d)
- 7
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- No contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from event-catalog/generators
-
Difficulty 4/5 3-5 days Newbie friendliness 56/100
event-catalog/generators#458 ·
-
generator-asyncapi: option to default message (and channel) versions to the document's info.versionOpen
Difficulty 4/5 3-5 days Newbie friendliness 55/100
event-catalog/generators#457 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 48/100
event-catalog/generators#451 · 1 reaction ·
-
Difficulty 4/5 3-5 days Newbie friendliness 48/100
event-catalog/generators#450 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 45/100
event-catalog/generators#449 · 1 comment ·
All issues in event-catalog/generators
Similar issues
-
unwrapDatabaseError masks real DB errors with TypeError: Cannot convert object to primitive valueOpen
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
NEARBuilders/everything-dev#798 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
vercel-labs/durable-harness#53 ·
Maintainers usually reply within 1 day
-
[Bug]: Redesign tab bars ignore clicks on Linux: hidden chat layers keep window drag regionsPossibly taken A pull request linked to this issue is open or already merged. Open
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
experiência: a doc manda subir para o Micro do Supabase, mas não diz que exige plano pago nem quanto custaPossibly taken A pull request linked to this issue is open or already merged. Openarea/docs area/ui enhancement
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
melgarafael/DeskcommCRM#4098 ·
Maintainers usually reply within 1 day
-
dependencies platform: ios
Difficulty 1/5 1-3 hours Newbie friendliness 78/100
software-mansion/react-native-executorch#1617 ·
Maintainers usually reply within 1 day