From 136234a7f80fd6dd1ee4d28be9afb1ae142c04db Mon Sep 17 00:00:00 2001 From: Lauryn Menard Date: Tue, 23 Nov 2021 16:40:37 +0100 Subject: [PATCH] documentation: Fix ordered list text wrapping in some /help articles. Minor change to some of the `/help` md files to correct the text wrapping of ordered lists in the content of the article. --- templates/zerver/help/animated-gifs-from-giphy.md | 6 ++++++ templates/zerver/help/desktop-app-install-guide.md | 7 +++++++ .../zerver/help/include/how-to-start-a-new-topic.md | 5 ++++- templates/zerver/help/include/left-sidebar-topics.md | 1 + templates/zerver/help/include/reading-pms.md | 5 +++++ templates/zerver/help/include/reading-topics.md | 10 ++++++++++ .../help/include/starting-a-new-private-thread.md | 1 + templates/zerver/help/saml-authentication.md | 4 ++++ templates/zerver/help/scim.md | 10 ++++++++++ 9 files changed, 48 insertions(+), 1 deletion(-) diff --git a/templates/zerver/help/animated-gifs-from-giphy.md b/templates/zerver/help/animated-gifs-from-giphy.md index 8f1d4edc3f..d81792b991 100644 --- a/templates/zerver/help/animated-gifs-from-giphy.md +++ b/templates/zerver/help/animated-gifs-from-giphy.md @@ -13,13 +13,19 @@ messages. Be thoughtful when using this feature! Animated GIFs can be fun, but they can also distract from the content of a conversation. +{start_tabs} 1. First, [open the compose box](/help/open-the-compose-box). + 1. **Click the GIPHY logo** at the bottom of the compose box. This opens the GIPHY search tool. + 1. Use the search tool to find a GIF you'd like to use. + 1. **Click on an image** to insert a link to the GIF in the compose box. + 1. Send the message. Zulip will display the GIF like any other linked image. +{end_tabs} You can [preview the message](/help/preview-your-message-before-sending) before sending to diff --git a/templates/zerver/help/desktop-app-install-guide.md b/templates/zerver/help/desktop-app-install-guide.md index d614b00a2b..63a24914bc 100644 --- a/templates/zerver/help/desktop-app-install-guide.md +++ b/templates/zerver/help/desktop-app-install-guide.md @@ -17,6 +17,7 @@ look at the newest features, consider the [beta releases](#install-a-beta-releas 1. Download [Zulip for macOS](https://zulip.com/apps/mac). + 1. Open the file, and drag the app into the `Applications` folder. The app will update automatically to future versions. @@ -24,6 +25,7 @@ The app will update automatically to future versions. #### Homebrew 1. Run `brew cask install zulip` in Terminal. + 1. Run Zulip from `Applications`. The app will update automatically to future versions. `brew upgrade` will @@ -34,6 +36,7 @@ also work, if you prefer. #### Web installer (recommended) 1. Download and run [Zulip for Windows](https://zulip.com/apps/windows). + 1. Run Zulip from the Start menu. The app will update automatically to future versions. @@ -42,8 +45,10 @@ The app will update automatically to future versions. 1. Download [zulip-x.x.x-x64.nsis.7z][latest] for 64-bit desktops (common), or [zulip-x.x.x-ia32.nsis.7z][latest] for 32-bit (rare). + 2. Copy the installer file to the machine you want to install the app on, and run it there. + 3. Run Zulip from the Start menu. The app will NOT update automatically. You can repeat these steps to upgrade @@ -74,9 +79,11 @@ regular software update on your system, e.g. with #### AppImage (recommended for all other distros) 1. Download [Zulip for Linux](https://zulip.com/apps/linux). + 2. Make the file executable, with `chmod a+x Zulip-x.x.x-x86_64.AppImage` from a terminal (replace `x.x.x` with the actual name of the downloaded file). + 3. Run the file from your app launcher, or from a terminal. No installer is necessary; this file is the Zulip app. The app will update diff --git a/templates/zerver/help/include/how-to-start-a-new-topic.md b/templates/zerver/help/include/how-to-start-a-new-topic.md index 586094906f..a5561d1885 100644 --- a/templates/zerver/help/include/how-to-start-a-new-topic.md +++ b/templates/zerver/help/include/how-to-start-a-new-topic.md @@ -1,15 +1,18 @@ {start_tabs} {tab|stream} 1. Click the **New topic** button at the bottom of the Zulip window, or type `c`. + 2. Enter a topic name. Auto-complete will provide suggestions for previously used topics. {!compose-and-send-message.md!} {tab|not-stream} -1. Click the “New topic” button at the bottom of the Zulip window, or type `c`. +1. Click the **New topic** button at the bottom of the Zulip window, or type `c`. + 2. Enter a stream name. Auto-complete will provide suggestions for streams you can send to. + 2. Enter a topic name. Auto-complete will provide suggestions for previously used topics. diff --git a/templates/zerver/help/include/left-sidebar-topics.md b/templates/zerver/help/include/left-sidebar-topics.md index 16aaae38f6..4b88d089c6 100644 --- a/templates/zerver/help/include/left-sidebar-topics.md +++ b/templates/zerver/help/include/left-sidebar-topics.md @@ -4,6 +4,7 @@ unread message counts for each stream. {start_tabs} 1. Click on the name of a stream in the left sidebar. You will see a list of the most recent unread topics in that stream. + 2. The initially shown list of topics usually has what you need, but you can click on "more topics" underneath to see additional topics. {end_tabs} diff --git a/templates/zerver/help/include/reading-pms.md b/templates/zerver/help/include/reading-pms.md index af060bf8bd..1f8a906ad2 100644 --- a/templates/zerver/help/include/reading-pms.md +++ b/templates/zerver/help/include/reading-pms.md @@ -1,12 +1,17 @@ {start_tabs} 1. Click on **Private messages** in the left sidebar. + 2. Click on a conversation in the left sidebar under **Private messages**. + 3. Read the conversation, scrolling down with the mouse or by pressing `Fn` + `↓`. + 4. If the conversation is not of interest, you can [mark all messages as read](/help/marking-messages-as-read) or do so by jumping to the end using the `End` key. + 5. Click on the next conversation in the left sidebar, or use the `p` key to go to the next unread conversation. + 6. To go to older unread conversations, use the `p` key or scroll down in the **Private messages** section of the left sidebar to view. {end_tabs} diff --git a/templates/zerver/help/include/reading-topics.md b/templates/zerver/help/include/reading-topics.md index 94a0c9fd60..216c98b2d6 100644 --- a/templates/zerver/help/include/reading-topics.md +++ b/templates/zerver/help/include/reading-topics.md @@ -1,22 +1,32 @@ {start_tabs} {tab|via-recent-topics} 1. Open **Recent topics** from the left sidebar or by pressing the `Esc` key. + 2. Click on the name of a topic in the **Topic** column. + 3. Read the topic, scrolling down with the mouse or by pressing `Fn` + `↓`. + 4. If the topic is not of interest, you can [mark all messages as read](/help/marking-messages-as-read) or do so by jumping to the end using the `End` key. + 5. You can then click on another topic in the left sidebar, use the `n` key to go to the next unread topic, or go back to the **Recent topics** view. + {tab|via-left-sidebar} 1. Click on the name of a stream in the left sidebar. You will see a list of the most recent unread topics in that stream. + 2. Click on a topic in the left sidebar. + 3. Read the topic, scrolling down with the mouse or by pressing `Fn` + `↓`. + 4. If the topic is not of interest, you can [mark all messages as read](/help/marking-messages-as-read) or do so by jumping to the end using the `End` key. + 5. Click on the next topic in the left sidebar, or use the `n` key to go to the next unread topic. + 6. To go to older unread topics, use the `n` key or click "more topics" to view. {end_tabs} diff --git a/templates/zerver/help/include/starting-a-new-private-thread.md b/templates/zerver/help/include/starting-a-new-private-thread.md index f015d2ce03..5db94f9307 100644 --- a/templates/zerver/help/include/starting-a-new-private-thread.md +++ b/templates/zerver/help/include/starting-a-new-private-thread.md @@ -1,6 +1,7 @@ {start_tabs} 1. Click the **New private message** button at the bottom of the Zulip window, or type `x`. + 2. Type the names of one or more recipients. Auto-complete will provide suggestions for users you can message. diff --git a/templates/zerver/help/saml-authentication.md b/templates/zerver/help/saml-authentication.md index b89d371d58..7581cb4979 100644 --- a/templates/zerver/help/saml-authentication.md +++ b/templates/zerver/help/saml-authentication.md @@ -118,16 +118,20 @@ how to configure these SAML providers to work with Zulip. ## Configure SAML with Keycloak 1. Make sure you have created your organization. + 1. Make sure your Keycloak server is up and running. We assume the URL is `https://keycloak.example.com` and your Keycloak realm is `yourrealm`. + 1. In Keycloak, register a new Client for your Zulip organization: * Client-ID: `https://zulipchat.com` * Client Protocol: `saml` * Client SAML Endpoint: leave this field empty + 1. In the `Settings` tab for your new Keycloak client, set the following properties: - Valid Redirect URIs: `https://auth.zulipchat.com/*` - Base URL: `https://auth.zulipchat.com/complete/saml/` - Client Signature Required: `Disable` + 1. In the `Mappers` tab for your new Keycloak client: * Create a Mapper for first name: * Property: `firstName` diff --git a/templates/zerver/help/scim.md b/templates/zerver/help/scim.md index 0ce9a9adbe..8ea1a5ed9c 100644 --- a/templates/zerver/help/scim.md +++ b/templates/zerver/help/scim.md @@ -19,25 +19,35 @@ side of SCIM for their deployment. 1. Before you begin, contact [email support](mailto:support@zulip.com) to receive the bearer token that Okta will use to authenticate to make its SCIM requests. + 1. In your Okta Dashboard, go to `Applications` and choose `Browse App Catalog`. + 1. Search for `SCIM` and select `SCIM 2.0 Test App (Header Auth)`. + 1. Click `Add` and choose your `Application label`. For example, you can name it `Zulip SCIM`. + 1. Continue to `Sign-On Options`. Leave the `SAML` options, as this type of Okta application doesn't actually support `SAML` authentication, and you'll need to set up a separate Okta app to activate `SAML` for your Zulip organization. + 1. In `Credentials Details`, set `Application username format` to `Email` and `Update application username on` to `Create and update`. + 1. The Okta app has been added. Navigate to the `Provisioning` tab. + 1. Click `Configure API Integration` and check the `Enable API integration` box. Okta will ask you for the `Base URL` and `API token`. The `Base URL` should be `yourorganization.zulipchat.com/scim/v2` and for `API token` you'll set the value given to you by support. When you proceed to the next step, Okta will verify that these details are correct by making a SCIM request to the Zulip server. + 1. In the `To App` section of the `Provisioning` tab (which should be opened by default when you continue from the previous step), edit the `Provisioning to App` settings to enable `Create Users`, `Update User Attributes` and `Deactivate Users`. + 1. In `Attribute Mappings`, remove all attributes except `userName`, `givenName` and `familyName`. + 1. Now the integration should be ready and you can `Assign` users to the app to configure their Zulip accounts to be managed by SCIM. When you assign a user, Okta will check if the account exists