From 3f350391ce84877701998e60bcfb4bece8234b1f Mon Sep 17 00:00:00 2001 From: sinwar Date: Mon, 9 Jan 2017 10:16:03 +0530 Subject: [PATCH] docs: Ban the term realm from user documentation. Fixes #3031. --- templates/zerver/help/about-streams-and-topics.md | 8 ++++---- .../zerver/help/advanced-search-for-messages.md | 4 ++-- .../allow-anyone-to-join-without-an-invitation.md | 6 +++--- .../zerver/help/deactivate-or-reactivate-a-bot.md | 6 +++--- .../zerver/help/deactivate-or-reactivate-a-user.md | 6 +++--- templates/zerver/help/deactivate-your-account.md | 4 ++-- templates/zerver/help/index.md | 2 +- templates/zerver/help/keyboard-shortcuts.md | 8 ++++---- templates/zerver/help/the-announce-stream.md | 2 +- templates/zerver/help/zulip-glossary.md | 14 +++++++------- tools/lint-all | 2 ++ 11 files changed, 32 insertions(+), 30 deletions(-) diff --git a/templates/zerver/help/about-streams-and-topics.md b/templates/zerver/help/about-streams-and-topics.md index e35310f6c1..da2276a8bf 100644 --- a/templates/zerver/help/about-streams-and-topics.md +++ b/templates/zerver/help/about-streams-and-topics.md @@ -11,14 +11,14 @@ Streams are either: * **Public** - Public streams are for open discussions. All users can subscribe to public streams and discuss topics there. Any Zulip user can join any public -stream in the realm, and they can view the complete message history of any +stream in the organization, and they can view the complete message history of any public stream without joining the stream. * **Private** - Private streams are for confidential discussions and are only visible to users who've been invited to subscribe to them. Users who are not members of a private stream cannot subscribe to the stream, and they also cannot read or send messages to the stream. -Users are subscribed to specific streams in the realm by default, such as the +Users are subscribed to specific streams in the organization by default, such as the [#announce](the-announce-stream) stream. Users can easily [view messages](/help/view-messages-from-a-stream) from a specific stream; in addition, they can [browse](/help/browse-and-join-streams#browse-streams) their @@ -36,11 +36,11 @@ Users can also customize their stream settings; they can notifications or muting for streams in order to create a better Zulip environment. -If enabled by the realm administrators, users can +If enabled by the organization administrators, users can [create](/help/create-a-stream) streams and [invite](/help/add-or-invite-someone-to-a-stream) other users to a stream. -Only realm administrators can make edits to a stream, such as +Only organization administrators can make edits to a stream, such as [renaming](/help/rename-a-stream), [deleting](/help/delete-a-stream), changing the description of a stream, [removing users](/help/remove-someone-from-a-stream) from a stream, or changing the accessibility of a stream. diff --git a/templates/zerver/help/advanced-search-for-messages.md b/templates/zerver/help/advanced-search-for-messages.md index 7f544ef308..03312b91df 100644 --- a/templates/zerver/help/advanced-search-for-messages.md +++ b/templates/zerver/help/advanced-search-for-messages.md @@ -18,7 +18,7 @@ It is important to note that spaces in `operand` must be replaced with query by separating each operator with spaces in your search bar. Most importantly, you can search an individual stream for results from before you joined, but search results will only include messages from -after you first joined Zulip if you search the entire realm. +after you first joined Zulip if you search the entire organization. ## Search operators @@ -76,7 +76,7 @@ Listed below are some Zulip keyboard shortcuts that will aid you in conducting a * **Initiate a search** `/` - This shortcut moves the user's cursor to the message search bar at the top of the window to allow them to begin searching for messages belonging to a specific topic, stream, - view, etc. in the realm. + view, etc. in the organization. * **Clear a search** `Esc` - This shortcut clears the search bar of any search criteria that was previously entered. This action can also be achieved by clicking the **x** diff --git a/templates/zerver/help/allow-anyone-to-join-without-an-invitation.md b/templates/zerver/help/allow-anyone-to-join-without-an-invitation.md index dea53c0fad..9f3b46e116 100644 --- a/templates/zerver/help/allow-anyone-to-join-without-an-invitation.md +++ b/templates/zerver/help/allow-anyone-to-join-without-an-invitation.md @@ -3,9 +3,9 @@ By default, new users can join a Zulip organization with or without an email invitation. -However, if you are a realm administrator that wants to limit the membership of -your organization, you can choose to limit new members to those with email -invitations. +However, if you are an organization administrator that wants to limit +the membership of your organization, you can choose to limit new +members to those with email invitations. ## Limiting new membership to users invited by organization members diff --git a/templates/zerver/help/deactivate-or-reactivate-a-bot.md b/templates/zerver/help/deactivate-or-reactivate-a-bot.md index 4a72468640..31a40d4e70 100644 --- a/templates/zerver/help/deactivate-or-reactivate-a-bot.md +++ b/templates/zerver/help/deactivate-or-reactivate-a-bot.md @@ -1,7 +1,7 @@ # Deactivate or reactivate a bot -Zulip realm administrators have the ability to deactivate or reactivate any bots -in their realm. +Zulip organization administrators have the ability to deactivate or reactivate any bots +in their organization. ## Deactivate a bot @@ -23,7 +23,7 @@ stricken through, confirming the success of the bot's deactivation. ## Reactivate a bot -Zulip realm administrators can choose to reactivate a deactivated bot by +Zulip organization administrators can choose to reactivate a deactivated bot by following the following steps. {!go-to-the.md!} [Bots](/#administration/bot-list-admin) diff --git a/templates/zerver/help/deactivate-or-reactivate-a-user.md b/templates/zerver/help/deactivate-or-reactivate-a-user.md index c7b1497a53..0b00a9c30e 100644 --- a/templates/zerver/help/deactivate-or-reactivate-a-user.md +++ b/templates/zerver/help/deactivate-or-reactivate-a-user.md @@ -1,7 +1,7 @@ # Deactivate or reactivate a user -Zulip realm administrators have the ability to deactivate or reactivate any -user's account in their realm. +Zulip organization administrators have the ability to deactivate or reactivate any +user's account in their organization. ## Deactivate a user @@ -36,7 +36,7 @@ disappear, confirming the success of the account's deactivation. ## Reactivate a user -Zulip realm administrators can choose to reactivate a user's deactivated account +Zulip organization administrators can choose to reactivate a user's deactivated account by following the following steps. {!go-to-the.md!} [Deactivated Users](/#administration/deactivated-users-admin) diff --git a/templates/zerver/help/deactivate-your-account.md b/templates/zerver/help/deactivate-your-account.md index df5a61a55a..9499f15a54 100644 --- a/templates/zerver/help/deactivate-your-account.md +++ b/templates/zerver/help/deactivate-your-account.md @@ -26,13 +26,13 @@ deactivate your Zulip account. Please note that you cannot register a Zulip account using the email address of a deactivated account. -In addition, if you're the only administrator in the realm, you cannot +In addition, if you're the only administrator in the organization, you cannot deactivate your account; you need to make another user an administrator first before you can deactivate your account. ## Reactivating an account -If you regret deactivating your account, you can ask a Zulip realm +If you regret deactivating your account, you can ask a Zulip organization administrator to [reactivate](/help/deactivate-or-reactivate-a-user#reactivate-a-user) your account. diff --git a/templates/zerver/help/index.md b/templates/zerver/help/index.md index 3132f7ee13..a71b5a49e2 100644 --- a/templates/zerver/help/index.md +++ b/templates/zerver/help/index.md @@ -12,7 +12,7 @@ cross-platform version and a version for Platform 9. See [the documentation on apps](/apps) for more information. One Zulip account, associated with a particular group or organization, is known -as a **realm**. +as a **organization**. --- diff --git a/templates/zerver/help/keyboard-shortcuts.md b/templates/zerver/help/keyboard-shortcuts.md index cc6e3ab92c..8ec25539ea 100644 --- a/templates/zerver/help/keyboard-shortcuts.md +++ b/templates/zerver/help/keyboard-shortcuts.md @@ -14,13 +14,13 @@ Zulip keyboard shortcuts are divided into four categories: * **Initiate a search** `/` - This shortcut moves the user's cursor to the message search bar at the top of the window to allow them to begin searching for messages belonging to a specific topic, stream, - view, etc. in the realm. + view, etc. in the organization. * **Search people** `q` - This shortcut moves the user's cursor to the user search bar in the right sidebar to to allow them to begin - searching for a particular user in the realm. + searching for a particular user in the organization. * **Search streams** `w` - This shortcut moves the user's cursor to the stream search bar in the left sidebar to to allow them to begin - searching for a particular stream in the realm. + searching for a particular stream in the organization. * **Previous message** `k` `Up arrow` - This shortcut allows the user to scroll up to the previous message in their view. * **Next message** `j` `Down arrow` - This shortcut allows the user to @@ -65,7 +65,7 @@ Zulip keyboard shortcuts are divided into four categories: to navigate to the previous stream narrow, and `D` allows the user to navigate to the next stream narrow. * **Return to home view** `Esc` - This shortcut makes the user return - to the Home view, showing all messages in the realm. + to the Home view, showing all messages in the organization. ## Menus diff --git a/templates/zerver/help/the-announce-stream.md b/templates/zerver/help/the-announce-stream.md index c14b79609c..223ba87df5 100644 --- a/templates/zerver/help/the-announce-stream.md +++ b/templates/zerver/help/the-announce-stream.md @@ -1,7 +1,7 @@ # The #announce stream The #announce stream is just like other streams in most ways, but it's -conventionally used for realm-wide announcements. +conventionally used for organization-wide announcements. ![Example message](/static/images/help/announce-message.png) diff --git a/templates/zerver/help/zulip-glossary.md b/templates/zerver/help/zulip-glossary.md index 4ec878e95b..4250f59e70 100644 --- a/templates/zerver/help/zulip-glossary.md +++ b/templates/zerver/help/zulip-glossary.md @@ -5,15 +5,15 @@ common terms that you should know. ### administrator **Administrators** have special privileges that allow them to control the -settings and customizations of the realms that they own, including the ability +settings and customizations of the organizations that they own, including the ability to deactivate and reactivate other human and bot users, delete streams, add/remove administrator privileges, as well as change configuration for the -overall realm (e.g. whether an invitation is required to join the realm). +overall organization (e.g. whether an invitation is required to join the organization). ### bot Zulip **bots** are often used for integrations to send automated messages to -users and can do everything a normal user in the realm can do with a few +users and can do everything a normal user in the organization can do with a few exceptions (e.g. a bot cannot login to the web application or create other bots). @@ -123,7 +123,7 @@ messages. ### notification **Notifications** are messages that appear notifying Zulip users about -important events in the realm, such as being mentioned in another +important events in the organization, such as being mentioned in another user's message or the creation of a stream. Notifications can be sent as emails or browser/desktop notifications, often accompanied by an alert sound. @@ -152,11 +152,11 @@ visible to users who've been invited to subscribe to them. **Public streams** are for open discussions. All users can subscribe to public streams and discuss there. -### realm +### organization -A **realm** is a Zulip organization hosted on a domain. Each realm is a private +A **organization** is a Zulip organization hosted on a domain. Each organization is a private chamber with its own users, streams, customizations, etc. Administrators manage -the realm, controlling the specific settings of the realms that they own. +the organization, controlling the specific settings of the organizations that they own. ### recipient bar diff --git a/tools/lint-all b/tools/lint-all index a772890c9f..d38690ff4b 100755 --- a/tools/lint-all +++ b/tools/lint-all @@ -407,6 +407,8 @@ def build_custom_checkers(by_lang): help_markdown_rules = markdown_rules + [ {'pattern': '[a-z][.][A-Z]', 'description': "Likely missing space after end of sentence"}, + {'pattern': '[rR]ealm', + 'description': "Realms are referred to as Organizations in user-facing docs."}, ] txt_rules = whitespace_rules