integration-docs: Update the RSS integration doc. #872

Niloth-p · 2025-06-05T18:40:25Z

Screenshots

RSS doc link

Self-review checklist

Self-reviewed the changes for clarity and maintainability
(variable names, code reuse, readability, etc.).

Communicate decisions, questions, and potential concerns.

Explains differences from previous plans (e.g., issue description).
Highlights technical choices and bugs encountered.
Calls out remaining decisions and concerns.
Automated tests verify logic where appropriate.

Individual commits are ready for review (see commit discipline).

Each commit is a coherent idea.
Commit message(s) explain reasoning and motivation for changes.

Completed manual review and testing of the following:

Visual appearance of the changes.
Responsiveness and internationalization.
Strings and tooltips.
End-to-end functionality of buttons, interactions and flows.
Corner cases, error conditions, and easily imagined bugs.

laurynmm

@Niloth-p - Thanks again for this integration doc update! Let me know if you have any questions about my review comments! Some here are reflections on other pending integration doc changes that are similar.

zulip/integrations/rss/doc.md

laurynmm · 2025-06-23T12:01:46Z

zulip/integrations/rss/doc.md

+  location is `~/.cache/zulip-rss`.
+
+- `--stream`: The name of the Zulip channel you want to receive
+  notifications in. By default, messages are sent to the `rss` channel.


We should be consistent in using quotes or backticks for channel names across all integration docs. Here we use backticks, but in the SVN or IRC updates we used quotes.

zulip/integrations/rss/doc.md

Niloth-p · 2025-06-23T18:43:58Z

Thank you for the review! Updated as recommended.
I've switched to using backticks instead of double quotes for channel and topic names, and added the prefix # in front of channel names (because that's the convention in the Help docs - example).

Screenshots

alya · 2025-07-01T20:23:08Z

zulip/integrations/rss/doc.md


 !!! tip ""

-    Note that [the Zapier integration][1] is usually a simpler way to
+    [The Zapier integration][1] is usually a simpler way to


Is this only if you're OK with all the messages going to the same topic? If so, it should be something like:

Suggested change

[The Zapier integration][1] is usually a simpler way to

For sending messages to a single topic, [the Zapier integration][1] is a simpler way to

Not particularly, Zapier can send DMs or construct the topic name from the payload too.

I think the direct integration may be preferred by folks who want to customize the integration, or use the --unwrap or --math options or wish to send DMs without sharing their credentials with Zapier.

alya · 2025-07-01T20:23:29Z

zulip/integrations/rss/doc.md

+    `--feed-file` [option](#configuration-options) to the integration
+    script.
+
+1.  You can run the bot to send summaries of RSS entries from your favorite


Suggested change

1. You can run the bot to send summaries of RSS entries from your favorite

1. Run the bot to send summaries of RSS entries from your favorite

alya · 2025-07-01T20:24:16Z

zulip/integrations/rss/doc.md

+
+    `{{ integration_path }}/rss-bot`
+
+1.  Optionally, pass command-line arguments to re-configure the integration.


Suggested change

1. Optionally, pass command-line arguments to re-configure the integration.

1. Pass command-line arguments to re-configure the integration. See [the configuration options](#configuration-options below.

The reason for having the "Optionally" word, and mention the "list of options" is that there are some integrations that require all of their supported command-line arguments. We're trying to say that these command-line arguments are not necessary, but if the user wants to configure it further, they can. And the full list of options is available below, but the user can choose to use some of those options without using the rest.

I've retained the "Optionally" word, but rephrased the link sentence as suggested.

alya · 2025-07-01T20:24:27Z

zulip/integrations/rss/doc.md

+    See [the configuration options](#configuration-options) for the list of
+    options.


Suggested change

See [the configuration options](#configuration-options) for the list of

options.

alya · 2025-07-01T20:25:05Z

zulip/integrations/rss/doc.md

+1.  Configure a crontab entry to keep the integration running.
+
+    This sample crontab entry processes feeds stored in the default
+    location and posts to the `rss` topic in the `#news` channel every 5


Suggested change

location and posts to the `rss` topic in the `#news` channel every 5

location and posts to the `rss` topic in the **#news** channel every 5

alya · 2025-07-01T20:25:38Z

zulip/integrations/rss/doc.md

+  location is `~/.cache/zulip-rss`.
+
+- `--stream`: The name of the Zulip channel you want to receive
+  notifications in. By default, messages are sent to the `#rss` channel.


Suggested change

notifications in. By default, messages are sent to the `#rss` channel.

notifications in. By default, messages are sent to the **#rss** channel.

Niloth-p

Thank you for the review!

Screenshots

Niloth-p · 2025-07-02T12:33:39Z

zulip/integrations/rss/doc.md


 !!! tip ""

-    Note that [the Zapier integration][1] is usually a simpler way to
+    [The Zapier integration][1] is usually a simpler way to


Not particularly, Zapier can send DMs or construct the topic name from the payload too.

I think the direct integration may be preferred by folks who want to customize the integration, or use the --unwrap or --math options or wish to send DMs without sharing their credentials with Zapier.

Niloth-p · 2025-07-02T12:36:20Z

zulip/integrations/rss/doc.md

+
+    `{{ integration_path }}/rss-bot`
+
+1.  Optionally, pass command-line arguments to re-configure the integration.


The reason for having the "Optionally" word, and mention the "list of options" is that there are some integrations that require all of their supported command-line arguments. We're trying to say that these command-line arguments are not necessary, but if the user wants to configure it further, they can. And the full list of options is available below, but the user can choose to use some of those options without using the rest.

I've retained the "Optionally" word, but rephrased the link sentence as suggested.

alya · 2025-07-02T21:29:52Z

OK, I'm happy for other reviewers (@timabbott ?) to take the next look.

zulipbot added the size: L label Jun 5, 2025

laurynmm reviewed Jun 23, 2025

View reviewed changes

Niloth-p force-pushed the docs/rss branch from 48a8456 to b83e05b Compare June 23, 2025 18:41

alya reviewed Jul 1, 2025

View reviewed changes

integration-docs: Update the RSS integration doc.

ca9c11a

Niloth-p force-pushed the docs/rss branch from b83e05b to ca9c11a Compare July 2, 2025 14:03

Niloth-p commented Jul 2, 2025

View reviewed changes

	[The Zapier integration][1] is usually a simpler way to
	For sending messages to a single topic, [the Zapier integration][1] is a simpler way to

	1. You can run the bot to send summaries of RSS entries from your favorite
	1. Run the bot to send summaries of RSS entries from your favorite


		`{{ integration_path }}/rss-bot`

		1. Optionally, pass command-line arguments to re-configure the integration.

	1. Optionally, pass command-line arguments to re-configure the integration.
	1. Pass command-line arguments to re-configure the integration. See [the configuration options](#configuration-options below.

		See [the configuration options](#configuration-options) for the list of
		options.

	location and posts to the `rss` topic in the `#news` channel every 5
	location and posts to the `rss` topic in the #news channel every 5

	notifications in. By default, messages are sent to the `#rss` channel.
	notifications in. By default, messages are sent to the #rss channel.

Uh oh!

integration-docs: Update the RSS integration doc. #872

Are you sure you want to change the base?

integration-docs: Update the RSS integration doc. #872

Uh oh!

Conversation

Niloth-p commented Jun 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Screenshots

Uh oh!

laurynmm left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Niloth-p commented Jun 23, 2025

Screenshots

Uh oh!

alya Jul 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Niloth-p left a comment

Choose a reason for hiding this comment

Screenshots

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alya commented Jul 2, 2025

Uh oh!

Uh oh!

Niloth-p commented Jun 5, 2025 •

edited

Loading

alya Jul 1, 2025 •

edited

Loading