Update the doc of the IRC bridge integration.#870
Update the doc of the IRC bridge integration.#870Niloth-p wants to merge 1 commit intozulip:mainfrom
Conversation
|
Thank you for the review! Updated as recommended. |
| 1. [Subscribe the bot][subscribe-channels] to the Zulip channel that will | ||
| contain the mirror. |
There was a problem hiding this comment.
| 1. [Subscribe the bot][subscribe-channels] to the Zulip channel that will | |
| contain the mirror. | |
| 1. [Subscribe the bot][subscribe-channels] to the Zulip channel where IRC messages should be mirrored. |
|
Is this 1-way mirroring or 2-way mirroring? Everything in the doc sounded like 1-way mirroring until I got to the screenshots. |
|
Thank you for the review! Updates:
|
|
Why is it |
|
Passing on to @timabbott for review. |
That screenshot is pretty old. It's probably just a random bot name, I'm not sure. I would have expected the bot's nick to end with "_zulip" too, to avoid echoing. We'll need to update the IRC screenshot in sync with the Zulip screenshot, which we would update once we have support for generating screenshots of message threads. So, the image updates would go in a separate update later. |
| 1. Messages will be mirrored only when the terminal session with the bot | ||
| remains open. Consider using `screen` to run the bot in the background. | ||
| You can restart the integration at any time by re-running the | ||
| `irc-mirror.py` script. |
There was a problem hiding this comment.
screen is a weird way to do it. We should suggest supervisor as a tool intended for keeping a job running.
We use it in the botserver (And zulip/zulip server), if you aren't familiar with it.
|
|
||
| ``` | ||
| cd zulip/integrations/bridge_with_irc | ||
| python {{ integration_path }}/irc-mirror.py \ |
There was a problem hiding this comment.
Is integration_path the right path to find this file after doing a pip install?




Screenshots
IRC doc link


Self-review checklist
(variable names, code reuse, readability, etc.).
Communicate decisions, questions, and potential concerns.
Individual commits are ready for review (see commit discipline).
Completed manual review and testing of the following: