Skip to content

Commit 136234a

Browse files
laurynmmtimabbott
authored andcommitted
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.
1 parent b3c58f4 commit 136234a

9 files changed

+48
-1
lines changed

templates/zerver/help/animated-gifs-from-giphy.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,19 @@ messages.
1313
Be thoughtful when using this feature! Animated GIFs can be fun, but
1414
they can also distract from the content of a conversation.
1515

16+
{start_tabs}
1617
1. First, [open the compose box](/help/open-the-compose-box).
18+
1719
1. **Click the GIPHY logo** at the bottom of the compose box. This
1820
opens the GIPHY search tool.
21+
1922
1. Use the search tool to find a GIF you'd like to use.
23+
2024
1. **Click on an image** to insert a link to the GIF in the compose box.
25+
2126
1. Send the message. Zulip will display the GIF like any other linked
2227
image.
28+
{end_tabs}
2329

2430
You can [preview the
2531
message](/help/preview-your-message-before-sending) before sending to

templates/zerver/help/desktop-app-install-guide.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,15 @@ look at the newest features, consider the [beta releases](#install-a-beta-releas
1717
<!-- TODO why zip? -->
1818

1919
1. Download [Zulip for macOS](https://zulip.com/apps/mac).
20+
2021
1. Open the file, and drag the app into the `Applications` folder.
2122

2223
The app will update automatically to future versions.
2324

2425
#### Homebrew
2526

2627
1. Run `brew cask install zulip` in Terminal.
28+
2729
1. Run Zulip from `Applications`. <!-- TODO fact check -->
2830

2931
The app will update automatically to future versions. `brew upgrade` will
@@ -34,6 +36,7 @@ also work, if you prefer.
3436
#### Web installer (recommended)
3537

3638
1. Download and run [Zulip for Windows](https://zulip.com/apps/windows).
39+
3740
1. Run Zulip from the Start menu.
3841

3942
The app will update automatically to future versions.
@@ -42,8 +45,10 @@ The app will update automatically to future versions.
4245

4346
1. Download [zulip-x.x.x-x64.nsis.7z][latest] for 64-bit desktops
4447
(common), or [zulip-x.x.x-ia32.nsis.7z][latest] for 32-bit (rare).
48+
4549
2. Copy the installer file to the machine you want to install the app
4650
on, and run it there.
51+
4752
3. Run Zulip from the Start menu.
4853

4954
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
7479
#### AppImage (recommended for all other distros)
7580

7681
1. Download [Zulip for Linux](https://zulip.com/apps/linux).
82+
7783
2. Make the file executable, with
7884
`chmod a+x Zulip-x.x.x-x86_64.AppImage` from a terminal (replace
7985
`x.x.x` with the actual name of the downloaded file).
86+
8087
3. Run the file from your app launcher, or from a terminal.
8188

8289
No installer is necessary; this file is the Zulip app. The app will update

templates/zerver/help/include/how-to-start-a-new-topic.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,18 @@
11
{start_tabs}
22
{tab|stream}
33
1. Click the **New topic** button at the bottom of the Zulip window, or type `c`.
4+
45
2. Enter a topic name. Auto-complete will provide suggestions for previously
56
used topics.
67

78
{!compose-and-send-message.md!}
89

910
{tab|not-stream}
10-
1. Click the “New topic” button at the bottom of the Zulip window, or type `c`.
11+
1. Click the **New topic** button at the bottom of the Zulip window, or type `c`.
12+
1113
2. Enter a stream name. Auto-complete will provide suggestions for streams you
1214
can send to.
15+
1316
2. Enter a topic name. Auto-complete will provide suggestions for previously
1417
used topics.
1518

templates/zerver/help/include/left-sidebar-topics.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ unread message counts for each stream.
44
{start_tabs}
55
1. Click on the name of a stream in the left sidebar. You will see a list of the
66
most recent unread topics in that stream.
7+
78
2. The initially shown list of topics usually has what you need, but you can
89
click on "more topics" underneath to see additional topics.
910
{end_tabs}
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,17 @@
11
{start_tabs}
22
1. Click on **Private messages** in the left sidebar.
3+
34
2. Click on a conversation in the left sidebar under **Private messages**.
5+
46
3. Read the conversation, scrolling down with the mouse or by pressing `Fn` + ``.
7+
58
4. If the conversation is not of interest, you can
69
[mark all messages as read](/help/marking-messages-as-read) or do so by jumping
710
to the end using the `End` key.
11+
812
5. Click on the next conversation in the left sidebar, or use the `p` key to go to the
913
next unread conversation.
14+
1015
6. To go to older unread conversations, use the `p` key or scroll down in the
1116
**Private messages** section of the left sidebar to view.
1217
{end_tabs}
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,32 @@
11
{start_tabs}
22
{tab|via-recent-topics}
33
1. Open **Recent topics** from the left sidebar or by pressing the `Esc` key.
4+
45
2. Click on the name of a topic in the **Topic** column.
6+
57
3. Read the topic, scrolling down with the mouse or by pressing `Fn` + ``.
8+
69
4. If the topic is not of interest, you can
710
[mark all messages as read](/help/marking-messages-as-read) or do so by jumping
811
to the end using the `End` key.
12+
913
5. You can then click on another topic in the left sidebar, use the `n` key to go to the
1014
next unread topic, or go back to the **Recent topics** view.
15+
1116
{tab|via-left-sidebar}
1217
1. Click on the name of a stream in the left sidebar. You will see a list of the
1318
most recent unread topics in that stream.
19+
1420
2. Click on a topic in the left sidebar.
21+
1522
3. Read the topic, scrolling down with the mouse or by pressing `Fn` + ``.
23+
1624
4. If the topic is not of interest, you can
1725
[mark all messages as read](/help/marking-messages-as-read) or do so by jumping
1826
to the end using the `End` key.
27+
1928
5. Click on the next topic in the left sidebar, or use the `n` key to go to the
2029
next unread topic.
30+
2131
6. To go to older unread topics, use the `n` key or click "more topics" to view.
2232
{end_tabs}

templates/zerver/help/include/starting-a-new-private-thread.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
{start_tabs}
22
1. Click the **New private message** button at the bottom of the Zulip window,
33
or type `x`.
4+
45
2. Type the names of one or more recipients. Auto-complete will provide
56
suggestions for users you can message.
67

templates/zerver/help/saml-authentication.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,16 +118,20 @@ how to configure these SAML providers to work with Zulip.
118118
## Configure SAML with Keycloak
119119

120120
1. Make sure you have created your organization.
121+
121122
1. Make sure your Keycloak server is up and running. We assume the URL
122123
is `https://keycloak.example.com` and your Keycloak realm is `yourrealm`.
124+
123125
1. In Keycloak, register a new Client for your Zulip organization:
124126
* Client-ID: `https://zulipchat.com`
125127
* Client Protocol: `saml`
126128
* Client SAML Endpoint: leave this field empty
129+
127130
1. In the `Settings` tab for your new Keycloak client, set the following properties:
128131
- Valid Redirect URIs: `https://auth.zulipchat.com/*`
129132
- Base URL: `https://auth.zulipchat.com/complete/saml/`
130133
- Client Signature Required: `Disable`
134+
131135
1. In the `Mappers` tab for your new Keycloak client:
132136
* Create a Mapper for first name:
133137
* Property: `firstName`

templates/zerver/help/scim.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,25 +19,35 @@ side of SCIM for their deployment.
1919

2020
1. Before you begin, contact [email support](mailto:[email protected]) to receive
2121
the bearer token that Okta will use to authenticate to make its SCIM requests.
22+
2223
1. In your Okta Dashboard, go to `Applications` and choose `Browse App Catalog`.
24+
2325
1. Search for `SCIM` and select `SCIM 2.0 Test App (Header Auth)`.
26+
2427
1. Click `Add` and choose your `Application label`. For example, you can name it `Zulip SCIM`.
28+
2529
1. Continue to `Sign-On Options`. Leave the `SAML` options, as this type of Okta application
2630
doesn't actually support `SAML` authentication, and you'll need to set up a separate Okta app
2731
to activate `SAML` for your Zulip organization.
32+
2833
1. In `Credentials Details`, set `Application username format` to `Email` and
2934
`Update application username on` to `Create and update`.
35+
3036
1. The Okta app has been added. Navigate to the `Provisioning` tab.
37+
3138
1. Click `Configure API Integration` and check the `Enable API integration` box.
3239
Okta will ask you for the `Base URL` and `API token`. The `Base URL` should be
3340
`yourorganization.zulipchat.com/scim/v2` and for `API token` you'll set the value
3441
given to you by support. When you proceed to the next step, Okta will verify that
3542
these details are correct by making a SCIM request to the Zulip server.
43+
3644
1. In the `To App` section of the `Provisioning` tab (which should be opened by default
3745
when you continue from the previous step), edit the `Provisioning to App` settings
3846
to enable `Create Users`, `Update User Attributes` and `Deactivate Users`.
47+
3948
1. In `Attribute Mappings`, remove all attributes except `userName`, `givenName`
4049
and `familyName`.
50+
4151
1. Now the integration should be ready and you can `Assign` users to
4252
the app to configure their Zulip accounts to be managed by
4353
SCIM. When you assign a user, Okta will check if the account exists

0 commit comments

Comments
 (0)