help: Update text and style of Organization settings articles.

This commit is contained in:
Rishi Gupta 2019-04-02 16:12:26 -07:00
parent 3871a44422
commit 1b215410a7
13 changed files with 88 additions and 12 deletions

View File

@ -7,6 +7,13 @@ party issue trackers, like GitHub, Salesforce, Zendesk, and others.
For instance, you can add a filter that automatically turns `#2468` For instance, you can add a filter that automatically turns `#2468`
into a link to `https://github.com/zulip/zulip/issues/2468`. into a link to `https://github.com/zulip/zulip/issues/2468`.
If the pattern appears in a message topic, Zulip adds a little button to the
right of the topic that links to the appropriate URL.
### Add a custom linkification filter
{start_tabs}
{settings_tab|filter-settings} {settings_tab|filter-settings}
1. Under **Add a new linkifier**, enter a **Pattern** and 1. Under **Add a new linkifier**, enter a **Pattern** and
@ -14,12 +21,7 @@ into a link to `https://github.com/zulip/zulip/issues/2468`.
1. Click **Add linkifier**. 1. Click **Add linkifier**.
!!! tip "" {end_tabs}
If the pattern appears in a message topic, Zulip can't linkify the topic
itself, since clicking on a topic narrows to that topic. So Zulip
instead provides a little button to the right of the topic that links to
the appropriate URL.
## Understanding linkification patterns ## Understanding linkification patterns
@ -39,7 +41,7 @@ String of hexadecimal digits between 7 and 40 characters long.
* Original text: `abdc123` * Original text: `abdc123`
* Automatically links to: `https://github.com/zulip/zulip/commit/abcd123` * Automatically links to: `https://github.com/zulip/zulip/commit/abcd123`
Generic GitHub `org/repo#ID format: Generic GitHub `org/repo#ID` format:
* Pattern: `(?P<org>[a-zA-Z0-9_-]+)/(?P<repo>[a-zA-Z0-9_-]+)#(?P<id>[0-9]+)` * Pattern: `(?P<org>[a-zA-Z0-9_-]+)/(?P<repo>[a-zA-Z0-9_-]+)#(?P<id>[0-9]+)`
* URL format string: `https://github.com/%(org)s/%(repo)s/issues/%(id)s` * URL format string: `https://github.com/%(org)s/%(repo)s/issues/%(id)s`

View File

@ -6,7 +6,9 @@ are available to all users.
Organization administrators can also Organization administrators can also
[change who can add custom emoji](/help/only-allow-admins-to-add-emoji). [change who can add custom emoji](/help/only-allow-admins-to-add-emoji).
## Add a custom emoji ## Add custom emoji
{start_tabs}
{settings_tab|emoji-settings} {settings_tab|emoji-settings}
@ -18,10 +20,18 @@ Organization administrators can also
1. Click **Add emoji**. 1. Click **Add emoji**.
{end_tabs}
**Emoji names** can only contain `a-z`, `0-9`, dashes (`-`), and spaces. **Emoji names** can only contain `a-z`, `0-9`, dashes (`-`), and spaces.
Upper and lower case letters are treated the same, and underscores (`_`) Upper and lower case letters are treated the same, and underscores (`_`)
are treated the same as spaces. are treated the same as spaces.
### Bulk add emoji
We expose a [REST API endpoint](/api/upload-custom-emoji) for bulk uploading
emoji. Using REST API endpoints requires some technical expertise; email
support@zulipchat.com if you get stuck.
## Replace a default emoji ## Replace a default emoji
You can replace a default emoji by adding a custom emoji of the same You can replace a default emoji by adding a custom emoji of the same
@ -30,13 +40,17 @@ to replace it. You can find the primary name of an emoji by hovering over it
in the [emoji picker](/help/emoji-and-emoticons#select-from-the-emoji-picker), in the [emoji picker](/help/emoji-and-emoticons#select-from-the-emoji-picker),
while the search box is empty (you may have to scroll down a bit to find it). while the search box is empty (you may have to scroll down a bit to find it).
## Delete a custom emoji ## Delete custom emoji
{start_tabs}
{settings_tab|emoji-settings} {settings_tab|emoji-settings}
1. Click the trash icon (<i class="fa fa-trash-o"></i>) next to the 1. Click the trash icon (<i class="fa fa-trash-o"></i>) next to the
emoji that you would like to delete. emoji that you would like to delete.
{end_tabs}
Deleting an emoji will not affect any existing messages or emoji Deleting an emoji will not affect any existing messages or emoji
reactions. Anyone can delete custom emoji they added, and organization reactions. Anyone can delete custom emoji they added, and organization
administrators can delete anyone's custom emoji. administrators can delete anyone's custom emoji.

View File

@ -9,6 +9,8 @@ profiles until they fill them out.
## Add a custom profile field ## Add a custom profile field
{start_tabs}
{settings_tab|profile-field-settings} {settings_tab|profile-field-settings}
1. Under **Add a new profile field**, enter a **Label**, **Hint**, and **Type**. 1. Under **Add a new profile field**, enter a **Label**, **Hint**, and **Type**.
@ -17,6 +19,8 @@ profiles until they fill them out.
1. Click and drag the vertical dots on the left to order the fields. 1. Click and drag the vertical dots on the left to order the fields.
{end_tabs}
## Profile field types ## Profile field types
There are several different types of fields available. There are several different types of fields available.

View File

@ -6,6 +6,10 @@ By default, when a user links to an image or a website, a preview of the
image or website content is shown. You can choose to disable previews of image or website content is shown. You can choose to disable previews of
images and/or website links. images and/or website links.
### Block image and website previews
{start_tabs}
{settings_tab|organization-settings} {settings_tab|organization-settings}
1. Under **Message feed**, toggle **Show previews of uploaded and linked images**. 1. Under **Message feed**, toggle **Show previews of uploaded and linked images**.
@ -13,3 +17,5 @@ images and/or website links.
1. Under **Message feed**, toggle **Show previews of linked websites**. 1. Under **Message feed**, toggle **Show previews of linked websites**.
{!save-changes.md!} {!save-changes.md!}
{end_tabs}

View File

@ -11,12 +11,18 @@ users may still be able to edit the topic of messages with **(no topic)**; see
the full article on [message and topic editing](/help/configure-message-editing-and-deletion) the full article on [message and topic editing](/help/configure-message-editing-and-deletion)
for details. for details.
### Change who can edit topics
{start_tabs}
{settings_tab|organization-settings} {settings_tab|organization-settings}
2. Under **Message editing**, uncheck **Users can edit the topic of any message**. 2. Under **Message editing**, uncheck **Users can edit the topic of any message**.
{!save-changes.md!} {!save-changes.md!}
{end_tabs}
## Related articles ## Related articles
* [Message and topic editing](/help/configure-message-editing-and-deletion) * [Message and topic editing](/help/configure-message-editing-and-deletion)

View File

@ -15,12 +15,18 @@ blocker.
first. Server configuration is needed for several of the authentication first. Server configuration is needed for several of the authentication
methods listed above. methods listed above.
### Configure authentication methods
{start_tabs}
{settings_tab|auth-methods} {settings_tab|auth-methods}
2. Toggle the checkboxes next to the available login options. 2. Toggle the checkboxes next to the available login options.
{!save-changes.md!} {!save-changes.md!}
{end_tabs}
## Related articles ## Related articles
* [Configuring authentication methods](https://zulip.readthedocs.io/en/latest/production/authentication-methods.html) * [Configuring authentication methods](https://zulip.readthedocs.io/en/latest/production/authentication-methods.html)

View File

@ -46,6 +46,10 @@ settings.
You can access the message editing and deletion settings as follows. You can access the message editing and deletion settings as follows.
### Configure message editing and deletion
{start_tabs}
{settings_tab|organization-settings} {settings_tab|organization-settings}
4. Under **Message editing**, configure **Allow message editing**, 4. Under **Message editing**, configure **Allow message editing**,
@ -53,6 +57,8 @@ You can access the message editing and deletion settings as follows.
{!save-changes.md!} {!save-changes.md!}
{end_tabs}
## Related articles ## Related articles
* [Disable message edit history](/help/disable-message-edit-history) * [Disable message edit history](/help/disable-message-edit-history)

View File

@ -16,8 +16,14 @@ For large Zulips where anyone can join, we recommend restricting stream
creation to those with accounts at least a few days old (we suggest starting creation to those with accounts at least a few days old (we suggest starting
with `N = 3`), to make it easier to cope with spammers and confused users. with `N = 3`), to make it easier to cope with spammers and confused users.
### Manage who can create streams
{start_tabs}
{settings_tab|organization-permissions} {settings_tab|organization-permissions}
2. Under **Other permissions**, configure **Who can create streams**. 2. Under **Other permissions**, configure **Who can create streams**.
{!save-changes.md!} {!save-changes.md!}
{end_tabs}

View File

@ -9,12 +9,18 @@ To remove the edit history of a single message, it is usually best to
[delete the message](edit-or-delete-a-message) entirely. However, you can [delete the message](edit-or-delete-a-message) entirely. However, you can
also disable viewing of message edit history more generally. also disable viewing of message edit history more generally.
### Disable message edit history
{start_tabs}
{settings_tab|organization-settings} {settings_tab|organization-settings}
2. Under **Message editing**, uncheck **Enable message edit history**. 2. Under **Message editing**, uncheck **Enable message edit history**.
{!save-changes.md!} {!save-changes.md!}
{end_tabs}
## Related articles ## Related articles
* [Restrict message editing](/help/configure-message-editing-and-deletion) * [Restrict message editing](/help/configure-message-editing-and-deletion)

View File

@ -27,7 +27,7 @@ Moderation is a big part of making an open community work.
* [Rename topics](/help/rename-a-topic). * [Rename topics](/help/rename-a-topic).
* [Change users' names](/help/change-a-users-name) (e.g. to "Spammer") * [Change users' names](/help/change-a-users-name) (e.g. to "Spammer")
* [Deactivate bots](/help/deactivate-or-reactivate-a-bot) or * [Deactivate bots](/help/deactivate-or-reactivate-a-bot) or
[delete custom emoji](/help/add-custom-emoji#delete-a-custom-emoji). [delete custom emoji](/help/add-custom-emoji#delete-custom-emoji).
* Instruct users to [collapse](/help/collapse-a-message) messages that they don't * Instruct users to [collapse](/help/collapse-a-message) messages that they don't
want to see. want to see.

View File

@ -1,4 +1,4 @@
# Only allow admins to add emoji # Change who can add custom emoji
{!admin-only.md!} {!admin-only.md!}
@ -6,8 +6,14 @@ By default, anyone other than guests can [add custom emoji](/help/add-custom-emo
organization. However, you can change your organization's settings to only organization. However, you can change your organization's settings to only
allow administrators to add new emoji. allow administrators to add new emoji.
### Change who can add custom emoji
{start_tabs}
{settings_tab|organization-permissions} {settings_tab|organization-permissions}
2. Under **Other permissions**, configure **Who can add custom emoji**. 2. Under **Other permissions**, configure **Who can add custom emoji**.
{!save-changes.md!} {!save-changes.md!}
{end_tabs}

View File

@ -12,8 +12,14 @@ even if [community topic editing](/help/community-topic-edits) is otherwise off.
You can instead choose to require a topic for new stream messages. You can instead choose to require a topic for new stream messages.
### Require topics in stream messages
{start_tabs}
{settings_tab|organization-settings} {settings_tab|organization-settings}
2. Under **Message feed**, select **Require topics in messages to streams**. 2. Under **Message feed**, select **Require topics in messages to streams**.
{!save-changes.md!} {!save-changes.md!}
{end_tabs}

View File

@ -11,22 +11,30 @@ administrators can always [change anyone's name](/help/change-a-users-name).
This setting is especially useful if user names are managed via an external This setting is especially useful if user names are managed via an external
source, and synced into Zulip via the [Zulip API](/api) or another method. source, and synced into Zulip via the [Zulip API](/api) or another method.
{start_tabs}
{settings_tab|organization-permissions} {settings_tab|organization-permissions}
2. Under the **User identity**, select **Prevent users from changing their name**. 2. Under the **User identity**, select **Prevent users from changing their name**.
{!save-changes.md!} {!save-changes.md!}
{end_tabs}
## Prevent all email changes ## Prevent all email changes
By default, any user can By default, any user can
[change their email address](/help/change-your-email-address). However, you [change their email address](/help/change-your-email-address). However, you
can instead prevent all email changes. This is especially useful for can instead prevent all email changes. This is especially useful for
organizations that are self-hosting and using LDAP or another a Single organizations that are using LDAP or another a Single
Sign-On solution to manage user emails. Sign-On solution to manage user emails.
{start_tabs}
{settings_tab|organization-permissions} {settings_tab|organization-permissions}
2. Under **User identity**, select **Prevent users from changing their email address**. 2. Under **User identity**, select **Prevent users from changing their email address**.
{!save-changes.md!} {!save-changes.md!}
{end_tabs}