From 5acd059c3891ddfb5f1f7397e3c190122759112a Mon Sep 17 00:00:00 2001 From: Lauryn Menard Date: Thu, 2 May 2024 17:46:14 +0200 Subject: [PATCH] help-relative-links: Update relative help links for channel rename. --- help/add-or-remove-users-from-a-channel.md | 4 ++-- help/archive-a-channel.md | 2 +- help/browse-and-subscribe-to-channels.md | 2 +- help/change-the-channel-description.md | 2 +- help/change-the-color-of-a-channel.md | 2 +- help/change-the-privacy-of-a-channel.md | 2 +- help/channel-posting-policy.md | 2 +- help/configure-who-can-invite-to-channels.md | 2 +- ...ng-your-organization-started-with-zulip.md | 2 +- help/include/create-a-channel-instructions.md | 2 +- help/manage-user-channel-subscriptions.md | 4 ++-- help/message-a-channel-by-email.md | 2 +- help/message-retention-policy.md | 2 +- help/mute-a-channel.md | 2 +- help/pin-a-channel.md | 2 +- help/rename-a-channel.md | 2 +- help/setting-up-zulip-for-a-class.md | 2 +- help/unsubscribe-from-a-channel.md | 2 +- help/view-channel-subscribers.md | 2 +- zerver/lib/markdown/help_relative_links.py | 22 +++++++++---------- zerver/tests/test_docs.py | 4 ++-- 21 files changed, 34 insertions(+), 34 deletions(-) diff --git a/help/add-or-remove-users-from-a-channel.md b/help/add-or-remove-users-from-a-channel.md index 3c61457642..dd4d08fe5d 100644 --- a/help/add-or-remove-users-from-a-channel.md +++ b/help/add-or-remove-users-from-a-channel.md @@ -19,7 +19,7 @@ channel][add-users] or [remove other users from a channel][remove-users]. {tab|desktop-web} -{relative|stream|all} +{relative|channel|all} 1. Select a channel. @@ -117,7 +117,7 @@ subscribe the user. {tab|desktop-web} -{relative|stream|all} +{relative|channel|all} 1. Select a channel. diff --git a/help/archive-a-channel.md b/help/archive-a-channel.md index 71e64b276b..f6231d08bb 100644 --- a/help/archive-a-channel.md +++ b/help/archive-a-channel.md @@ -19,7 +19,7 @@ than archiving them. {tab|desktop-web} -{relative|stream|all} +{relative|channel|all} 1. Select a channel. diff --git a/help/browse-and-subscribe-to-channels.md b/help/browse-and-subscribe-to-channels.md index b9345c771f..836c7e7693 100644 --- a/help/browse-and-subscribe-to-channels.md +++ b/help/browse-and-subscribe-to-channels.md @@ -4,7 +4,7 @@ {tab|desktop-web} -{relative|stream|all} +{relative|channel|all} 1. Scroll through the list of channels. You can use the **search box** near the top of the menu to filter the list by channel name or description. diff --git a/help/change-the-channel-description.md b/help/change-the-channel-description.md index 98b6bfc6c7..39da208508 100644 --- a/help/change-the-channel-description.md +++ b/help/change-the-channel-description.md @@ -15,7 +15,7 @@ disabled. Use Markdown formatting to include a link to a website, Zulip {tab|desktop-web} -{relative|stream|all} +{relative|channel|all} 1. Select a channel. diff --git a/help/change-the-color-of-a-channel.md b/help/change-the-color-of-a-channel.md index e18004fa06..37e9cbbc15 100644 --- a/help/change-the-color-of-a-channel.md +++ b/help/change-the-color-of-a-channel.md @@ -23,7 +23,7 @@ channel. Changing a channel's color does not change it for anyone else. {start_tabs} -{relative|gear|stream-settings} +{relative|gear|channel-settings} 1. Select a channel. diff --git a/help/change-the-privacy-of-a-channel.md b/help/change-the-privacy-of-a-channel.md index cad51aacc6..5301422ac0 100644 --- a/help/change-the-privacy-of-a-channel.md +++ b/help/change-the-privacy-of-a-channel.md @@ -15,7 +15,7 @@ public. {tab|desktop-web} -{relative|stream|all} +{relative|channel|all} 1. Select a channel. diff --git a/help/channel-posting-policy.md b/help/channel-posting-policy.md index 23ddca23c3..bdb4332d54 100644 --- a/help/channel-posting-policy.md +++ b/help/channel-posting-policy.md @@ -9,7 +9,7 @@ certain users can send messages. {start_tabs} -{relative|stream|all} +{relative|channel|all} 1. Select a channel. diff --git a/help/configure-who-can-invite-to-channels.md b/help/configure-who-can-invite-to-channels.md index cc4cf53f95..9b2052ae0f 100644 --- a/help/configure-who-can-invite-to-channels.md +++ b/help/configure-who-can-invite-to-channels.md @@ -24,7 +24,7 @@ subscribed to the channel to configure these settings. {start_tabs} -{relative|stream|all} +{relative|channel|all} 1. Select a channel. diff --git a/help/getting-your-organization-started-with-zulip.md b/help/getting-your-organization-started-with-zulip.md index 8ea937c4eb..b21b36dc3b 100644 --- a/help/getting-your-organization-started-with-zulip.md +++ b/help/getting-your-organization-started-with-zulip.md @@ -57,7 +57,7 @@ us know! {start_tabs} -{relative|stream|all} +{relative|channel|all} 1. Click **Create stream** on the right. diff --git a/help/include/create-a-channel-instructions.md b/help/include/create-a-channel-instructions.md index dd764cd18f..c94b4be812 100644 --- a/help/include/create-a-channel-instructions.md +++ b/help/include/create-a-channel-instructions.md @@ -2,7 +2,7 @@ {tab|desktop-web} -{relative|gear|stream-settings} +{relative|gear|channel-settings} 1. Click **Create channel** on the right, or click the **plus** () icon in the upper right. diff --git a/help/manage-user-channel-subscriptions.md b/help/manage-user-channel-subscriptions.md index e8b543cf67..9cadb2df88 100644 --- a/help/manage-user-channel-subscriptions.md +++ b/help/manage-user-channel-subscriptions.md @@ -25,7 +25,7 @@ other users to a channel][configure-invites]. {tab|via-stream-settings} -{relative|stream|all} +{relative|channel|all} 1. Select a channel. @@ -61,7 +61,7 @@ channel](/help/unsubscribe-from-a-channel). {tab|via-stream-settings} -{relative|stream|all} +{relative|channel|all} 1. Select a channel. diff --git a/help/message-a-channel-by-email.md b/help/message-a-channel-by-email.md index fea72a2287..37f940c002 100644 --- a/help/message-a-channel-by-email.md +++ b/help/message-a-channel-by-email.md @@ -24,7 +24,7 @@ API](/api/send-message). {start_tabs} -{relative|gear|stream-settings} +{relative|gear|channel-settings} 1. Select a channel. diff --git a/help/message-retention-policy.md b/help/message-retention-policy.md index 991eb1d1e7..087f7baa5c 100644 --- a/help/message-retention-policy.md +++ b/help/message-retention-policy.md @@ -40,7 +40,7 @@ Standard hosting. {start_tabs} -{relative|stream|all} +{relative|channel|all} 1. Select a channel. diff --git a/help/mute-a-channel.md b/help/mute-a-channel.md index 8050ffbebf..f2e3ebffe7 100644 --- a/help/mute-a-channel.md +++ b/help/mute-a-channel.md @@ -49,7 +49,7 @@ {tab|desktop-web} -{relative|gear|stream-settings} +{relative|gear|channel-settings} 1. Select a channel. diff --git a/help/pin-a-channel.md b/help/pin-a-channel.md index cbf088c76f..a17da17406 100644 --- a/help/pin-a-channel.md +++ b/help/pin-a-channel.md @@ -50,7 +50,7 @@ which is especially handy if you are subscribed to a large number of channels. {tab|desktop-web} -{relative|gear|stream-settings} +{relative|gear|channel-settings} 1. Select a channel. diff --git a/help/rename-a-channel.md b/help/rename-a-channel.md index 30f7104128..a9caf8c74a 100644 --- a/help/rename-a-channel.md +++ b/help/rename-a-channel.md @@ -6,7 +6,7 @@ {tab|desktop-web} -{relative|stream|all} +{relative|channel|all} 1. Select a channel. diff --git a/help/setting-up-zulip-for-a-class.md b/help/setting-up-zulip-for-a-class.md index cb6b93d1c1..50379f47b7 100644 --- a/help/setting-up-zulip-for-a-class.md +++ b/help/setting-up-zulip-for-a-class.md @@ -213,7 +213,7 @@ how to assign roles and permissions for a class. {start_tabs} -{relative|stream|all} +{relative|channel|all} 1. Click **Create stream** on the right. diff --git a/help/unsubscribe-from-a-channel.md b/help/unsubscribe-from-a-channel.md index 7028070a1b..530101866d 100644 --- a/help/unsubscribe-from-a-channel.md +++ b/help/unsubscribe-from-a-channel.md @@ -28,7 +28,7 @@ You can always unsubscribe from any channel in Zulip. {tab|desktop-web} -{relative|gear|stream-settings} +{relative|gear|channel-settings} 1. Click the **checkmark** (checkmark) diff --git a/help/view-channel-subscribers.md b/help/view-channel-subscribers.md index 314c12579c..5bf8f6f2d5 100644 --- a/help/view-channel-subscribers.md +++ b/help/view-channel-subscribers.md @@ -12,7 +12,7 @@ unsubscribe other users to channels. {tab|via-stream-settings} -{relative|stream|all} +{relative|channel|all} 1. Select a channel. diff --git a/zerver/lib/markdown/help_relative_links.py b/zerver/lib/markdown/help_relative_links.py index 711c4dee39..32d5ab5ccb 100644 --- a/zerver/lib/markdown/help_relative_links.py +++ b/zerver/lib/markdown/help_relative_links.py @@ -19,8 +19,8 @@ gear_info = { # key is from REGEXP: `{relative|gear|key}` # name is what the item is called in the gear menu: `Select **name**.` # link is used for relative links: `Select [name](link).` - "stream-settings": [ - ' Stream settings', + "channel-settings": [ + ' Channel settings', "/#channels/subscribed", ], "settings": [ @@ -97,26 +97,26 @@ def help_handle_match(key: str) -> str: return help_instructions.format(item=item) -stream_info = { - "all": ["All streams", "/#channels/all"], +channel_info = { + "all": ["All channels", "/#channels/all"], } -stream_all_instructions = """ +channel_all_instructions = """ 1. Click on the **gear** () icon in the upper right corner of the web or desktop app. -1. Select **Stream settings**. +1. Select **Channel settings**. 1. Click {item} in the upper left. """ -def stream_handle_match(key: str) -> str: +def channel_handle_match(key: str) -> str: if relative_help_links: - item = f"[{stream_info[key][0]}]({stream_info[key][1]})" + item = f"[{channel_info[key][0]}]({channel_info[key][1]})" else: - item = f"**{stream_info[key][0]}**" - return stream_all_instructions.format(item=item) + item = f"**{channel_info[key][0]}**" + return channel_all_instructions.format(item=item) group_info = { @@ -197,7 +197,7 @@ def message_handle_match(key: str) -> str: LINK_TYPE_HANDLERS = { "gear": gear_handle_match, - "stream": stream_handle_match, + "channel": channel_handle_match, "message": message_handle_match, "help": help_handle_match, "group": group_handle_match, diff --git a/zerver/tests/test_docs.py b/zerver/tests/test_docs.py index f7346a993e..15cb2e96d8 100644 --- a/zerver/tests/test_docs.py +++ b/zerver/tests/test_docs.py @@ -426,7 +426,7 @@ class HelpTest(ZulipTestCase): def test_help_relative_links_for_stream(self) -> None: result = self.client_get("/help/message-a-channel-by-email") self.assertIn( - ' Stream settings', + ' Channel settings', str(result.content), ) self.assertEqual(result.status_code, 200) @@ -435,7 +435,7 @@ class HelpTest(ZulipTestCase): result = self.client_get("/help/message-a-channel-by-email", subdomain="") self.assertEqual(result.status_code, 200) self.assertIn( - ' Stream settings', + ' Channel settings', str(result.content), ) self.assertNotIn("/#channels", str(result.content))