docs: encourage community patches #3794
Conversation
Hopefully this will provide a better guide on how to create patches.
Codecov ReportAll modified and coverable lines are covered by tests ✅
✅ All tests successful. No failed tests found. Additional details and impacted files@@ Coverage Diff @@
## master #3794 +/- ##
=======================================
Coverage 99.45% 99.45%
=======================================
Files 3 3
Lines 183 183
=======================================
Hits 182 182
Misses 1 1 ☔ View full report in Codecov by Sentry. |
|
|
||
| They should be run from the root directory. For example, the | ||
| `external-kafka` patches should be run as: | ||
| They should be run from the root directory. For example, the `external-kafka` patches should be run as: |
There was a problem hiding this comment.
Can we ensure patches work fine without conflicts as we change docker-compose.yml over time?
Maybe a GHA or something like that?
I'll whip up a PR if you're OK with it.
There was a problem hiding this comment.
Oops! I just saw #3793 :)
There was a problem hiding this comment.
Done that here #3793
There was a problem hiding this comment.
Oh, anyway, I was thinking of mentioning that there will be a CI job that runs weekly, if a patch is broken, it will create a new github issue, and I'll alert the original patch author.
I'd prefer to go with this current route first, then if we have enough interest, we may move into a plugin system. Currently I have no idea on how it looks like if you need to modify the docker compose and everything.
Honestly it's harder for me to get things merged on the docs rather than on self-hosted. |
Not if you ping me for this. |
Hopefully this will provide a better guide on how to create patches.