docs: Fix a bunch of documentation build warnings.

This helps clean unnecessary warnings out of Zulip's Travis CI output.
This commit is contained in:
rht
2017-05-13 18:18:57 +07:00
committed by Tim Abbott
parent cf15a7b561
commit 34ffda9a1e
3 changed files with 47 additions and 48 deletions

View File

@@ -384,7 +384,7 @@ navigating to <http://localhost:9991/> in the browser on your main machine.
You should see something like this: You should see something like this:
![Image of Zulip development environment](https://raw.githubusercontent.com/zulip/zulip/master/docs/images/zulip-dev.png) ![Image of Zulip development environment](images/zulip-dev.png)
The Zulip server will continue to run and send output to the terminal window. The Zulip server will continue to run and send output to the terminal window.
When you navigate to Zulip in your browser, check your terminal and you When you navigate to Zulip in your browser, check your terminal and you

View File

@@ -51,13 +51,12 @@ you cloned Zulip:
./tools/run-dev.py --interface='' ./tools/run-dev.py --interface=''
``` ```
This will start up the Zulip server on port 9991. You can then navigate to This will start up the Zulip server on port 9991. You can then
http://<REMOTE_IP>:9991 and you should see something like [(this screenshot of navigate to `http://<REMOTE_IP>:9991` and you should see something like
the Zulip development this screenshot of the Zulip development environment:
environment)](https://raw.githubusercontent.com/zulip/zulip/master/docs/images/zulip-dev.png).
![Image of Zulip development ![Image of Zulip development
environment](https://raw.githubusercontent.com/zulip/zulip/master/docs/images/zulip-dev.png) environment](images/zulip-dev.png)
You can [port You can [port
forward](https://help.ubuntu.com/community/SSH/OpenSSH/PortForwarding) using forward](https://help.ubuntu.com/community/SSH/OpenSSH/PortForwarding) using

View File

@@ -237,16 +237,16 @@ Usually preceded by the [**Go to the** macro](#go-to-the-go-to-the-md-macro)
and a link to a particular section on the **Organization settings** page. and a link to a particular section on the **Organization settings** page.
* **Contents:** * **Contents:**
```.md ```md
tab of the [Organization settings](/help/edit-administrator-settings) page. tab of the [Organization settings](/help/edit-administrator-settings) page.
``` ```
* **Example usage and rendering:** * **Example usage and rendering:**
```.md ```md
{!go-to-the.md!} [Organization settings](/#organization/organization-settings) {!go-to-the.md!} [Organization settings](/#organization/organization-settings)
{!admin.md!} {!admin.md!}
``` ```
```.md ```md
1. Go to the [Organization settings](/#organization/organization-settings) tab of the 1. Go to the [Organization settings](/#organization/organization-settings) tab of the
[Organization](/help/edit-administrator-settings) page. [Organization](/help/edit-administrator-settings) page.
``` ```
@@ -258,19 +258,19 @@ only available to organization administrators. It should be placed
immediately after the title. immediately after the title.
* **Contents:** * **Contents:**
```.md ```md
!!! warn "" !!! warn ""
**Note:** This feature can only be controlled by organization administrators. **Note:** This feature can only be controlled by organization administrators.
``` ```
* **Example usage and rendering:** * **Example usage and rendering:**
```.md ```md
{!admin-only.md!} {!admin-only.md!}
{!follow-steps.md!} change who can join your stream by changing the stream's {!follow-steps.md!} change who can join your stream by changing the stream's
accessibility. accessibility.
``` ```
```.md ```md
!!! warn "" !!! warn ""
**Note:** This feature can only be controlled by organization administrators. **Note:** This feature can only be controlled by organization administrators.
@@ -286,20 +286,20 @@ immediately after the title.
[**Filter streams** macro](#filter-streams-filter-streams-md-macro). [**Filter streams** macro](#filter-streams-filter-streams-md-macro).
* **Contents:** * **Contents:**
```.md ```md
If you wish to see streams that you aren't subscribed to, click on the If you wish to see streams that you aren't subscribed to, click on the
**All streams** tab; the tab will turn gray upon doing so. **All streams** tab; the tab will turn gray upon doing so.
``` ```
* **Example usage and rendering:** * **Example usage and rendering:**
```.md ```md
{!subscriptions.md!} {!subscriptions.md!}
{!filter-streams.md!} {!filter-streams.md!}
!!! tip "" !!! tip ""
{!all-streams.md!} {!all-streams.md!}
``` ```
```.md ```md
1. [Find the relevant stream](/help/browse-and-join-streams#browse-streams) on the 1. [Find the relevant stream](/help/browse-and-join-streams#browse-streams) on the
[Streams](/#streams) page. You can search for specific streams by entering the [Streams](/#streams) page. You can search for specific streams by entering the
name of the stream in the **Filter streams** input. name of the stream in the **Filter streams** input.
@@ -316,16 +316,16 @@ an command, such as the [**Message actions**
macro](#message-actions-message-actions-md-macro). macro](#message-actions-message-actions-md-macro).
* **Contents:** * **Contents:**
```.md ```md
down chevron (<i class="fa fa-chevron-down"></i>) icon to reveal an actions dropdown. down chevron (<i class="fa fa-chevron-down"></i>) icon to reveal an actions dropdown.
``` ```
* **Example usage and rendering:** * **Example usage and rendering:**
```.md ```md
{!message-actions.md!} {!message-actions.md!}
{!down-chevron.md!} {!down-chevron.md!}
``` ```
```.md ```md
1. Hover over a message to replace the message's timestamp with its message 1. Hover over a message to replace the message's timestamp with its message
actions, represented by three icons. From the icons that appear, select the actions, represented by three icons. From the icons that appear, select the
down chevron (<i class="fa fa-chevron-down"></i>) icon to reveal an actions dropdown. down chevron (<i class="fa fa-chevron-down"></i>) icon to reveal an actions dropdown.
@@ -338,16 +338,16 @@ or the [**Organization settings** macro](#organization-settings-admin-md-macro).
following content into a step. following content into a step.
* **Contents:** * **Contents:**
```.md ```md
1. Go to the 1. Go to the
``` ```
* **Example usage and rendering:** * **Example usage and rendering:**
```.md ```md
{!go-to-the.md!} [Notifications](/#settings/notifications) {!go-to-the.md!} [Notifications](/#settings/notifications)
{!settings.md!} {!settings.md!}
``` ```
```.md ```md
1. Go to the [Notifications](/#settings/notifications) tab on the 1. Go to the [Notifications](/#settings/notifications) tab on the
[Settings](/help/edit-settings) page. [Settings](/help/edit-settings) page.
``` ```
@@ -359,17 +359,17 @@ following content into a step.
the [**Streams** macro](#streams-subscriptions-md-macro). the [**Streams** macro](#streams-subscriptions-md-macro).
* **Contents:** * **Contents:**
```.md ```md
You can search for specific streams by entering the name of the stream in You can search for specific streams by entering the name of the stream in
the **Filter streams** input. the **Filter streams** input.
``` ```
* **Example usage and rendering:** * **Example usage and rendering:**
```.md ```md
{!subscriptions.md!} {!subscriptions.md!}
{!filter-streams.md!} {!filter-streams.md!}
``` ```
```.md ```md
1. [Find the relevant stream](/help/browse-and-join-streams#browse-streams) on the 1. [Find the relevant stream](/help/browse-and-join-streams#browse-streams) on the
[Streams](/#streams) page. You can search for specific streams by entering the [Streams](/#streams) page. You can search for specific streams by entering the
name of the stream in the **Filter streams** input. name of the stream in the **Filter streams** input.
@@ -380,15 +380,15 @@ following content into a step.
* **About:** Prepends phrases with instructions to follow the following steps. * **About:** Prepends phrases with instructions to follow the following steps.
* **Contents:** * **Contents:**
```.md ```md
Follow the following steps to Follow the following steps to
``` ```
* **Example usage and rendering:** * **Example usage and rendering:**
```.md ```md
{!follow-steps.md!} change your mobile notification settings. {!follow-steps.md!} change your mobile notification settings.
``` ```
```.md ```md
Follow the following steps to change your mobile notification Follow the following steps to change your mobile notification
settings. settings.
``` ```
@@ -399,17 +399,17 @@ following content into a step.
to click a specific icon, such as the [**Down chevron** macro](#down-chevron-down-chevron-md-macro). to click a specific icon, such as the [**Down chevron** macro](#down-chevron-down-chevron-md-macro).
* **Contents:** * **Contents:**
```.md ```md
1. Hover over a message to replace the message's timestamp with its message 1. Hover over a message to replace the message's timestamp with its message
actions, represented by three icons. From the icons that appear, select the actions, represented by three icons. From the icons that appear, select the
``` ```
* **Example usage and rendering:** * **Example usage and rendering:**
```.md ```md
{!message-actions.md!} {!message-actions.md!}
{!down-chevron.md!} {!down-chevron.md!}
``` ```
```.md ```md
1. Hover over a message to replace the message's timestamp with its message 1. Hover over a message to replace the message's timestamp with its message
actions, represented by three icons. From the icons that appear, select the actions, represented by three icons. From the icons that appear, select the
down chevron (<i class="fa fa-chevron-down"></i>) icon to reveal an actions dropdown. down chevron (<i class="fa fa-chevron-down"></i>) icon to reveal an actions dropdown.
@@ -422,16 +422,16 @@ by pressing the **Save changes** button. Usually followed by a phrase
describing the settings they modified. describing the settings they modified.
* **Contents:** * **Contents:**
```.md ```md
1. Click on the **Save changes** button to save any changes you made to 1. Click on the **Save changes** button to save any changes you made to
your your
``` ```
* **Example usage and rendering:** * **Example usage and rendering:**
```.md ```md
{!save-changes.md!} notification settings. {!save-changes.md!} notification settings.
``` ```
```.md ```md
1. Click on the **Save changes** button to save any changes you made to 1. Click on the **Save changes** button to save any changes you made to
your notification settings. your notification settings.
``` ```
@@ -443,16 +443,16 @@ the [**Go to the** macro](#go-to-the-go-to-the-md-macro) and a link to a
particular section on the **Settings** page. particular section on the **Settings** page.
* **Contents:** * **Contents:**
```.md ```md
tab on the [Settings](/help/edit-settings) page. tab on the [Settings](/help/edit-settings) page.
``` ```
* **Example usage and rendering:** * **Example usage and rendering:**
```.md ```md
{!go-to-the.md!} [Notifications](/#settings/notifications) {!go-to-the.md!} [Notifications](/#settings/notifications)
{!settings.md!} {!settings.md!}
``` ```
```.md ```md
1. Go to the [Notifications](/#settings/notifications) tab on the 1. Go to the [Notifications](/#settings/notifications) tab on the
[Settings](/help/edit-settings) page. [Settings](/help/edit-settings) page.
``` ```
@@ -463,20 +463,20 @@ particular section on the **Settings** page.
instruction and the [**Down chevron** macro](#down-chevron-down-chevron-md-macro). instruction and the [**Down chevron** macro](#down-chevron-down-chevron-md-macro).
* **Contents:** * **Contents:**
```.md ```md
1. On the left sidebar in the **Streams** section, hover over a stream to reveal 1. On the left sidebar in the **Streams** section, hover over a stream to reveal
a down chevron (<i class="fa fa-chevron-down"></i>) icon to the right of a down chevron (<i class="fa fa-chevron-down"></i>) icon to the right of
the stream name. the stream name.
``` ```
* **Example usage and rendering:** * **Example usage and rendering:**
```.md ```md
{!stream-actions.md!} {!stream-actions.md!}
1. Click on the {!down-chevron.md!} 1. Click on the {!down-chevron.md!}
``` ```
```.md ```md
1. On the left sidebar in the **Streams** section, hover over a stream to reveal 1. On the left sidebar in the **Streams** section, hover over a stream to reveal
a down chevron (<i class="fa fa-chevron-down"></i>) icon to the right of a down chevron (<i class="fa fa-chevron-down"></i>) icon to the right of
the stream name. the stream name.
@@ -492,16 +492,16 @@ instruction and the [**Down chevron** macro](#down-chevron-down-chevron-md-macro
by an instruction. by an instruction.
* **Contents:** * **Contents:**
```.md ```md
the right side of the [Streams](/#streams) page, labeled the right side of the [Streams](/#streams) page, labeled
**Stream settings**, will now display the selected stream's settings. **Stream settings**, will now display the selected stream's settings.
``` ```
* **Example usage and rendering:** * **Example usage and rendering:**
```.md ```md
1. Click on the stream you want to edit; {!stream-settings.md!} 1. Click on the stream you want to edit; {!stream-settings.md!}
``` ```
```.md ```md
1. Click on the stream you want to edit; the right side of the 1. Click on the stream you want to edit; the right side of the
[Streams](/#streams) page, labeled **Stream settings**, will [Streams](/#streams) page, labeled **Stream settings**, will
now display the selected stream's settings. now display the selected stream's settings.
@@ -514,18 +514,18 @@ instruction and the [**Down chevron** macro](#down-chevron-down-chevron-md-macro
**Streams Settings** section. **Streams Settings** section.
* **Contents:** * **Contents:**
```.md ```md
1. After making sure that your cursor is hovering over the **Streams Settings** 1. After making sure that your cursor is hovering over the **Streams Settings**
section, scroll down to the section, scroll down to the
``` ```
* **Example usage and rendering:** * **Example usage and rendering:**
```.md ```md
{!stream-settings-scroll.md!} **Stream membership** section. This section {!stream-settings-scroll.md!} **Stream membership** section. This section
shows the usernames and emails of all users that are currently subscribed to the shows the usernames and emails of all users that are currently subscribed to the
selected stream. selected stream.
``` ```
```.md ```md
1. After making sure that your cursor is hovering over the **Streams Settings** 1. After making sure that your cursor is hovering over the **Streams Settings**
section, scroll down to the **Stream membership** section. This section section, scroll down to the **Stream membership** section. This section
shows the usernames and emails of all users that are currently subscribed to the shows the usernames and emails of all users that are currently subscribed to the
@@ -538,17 +538,17 @@ instruction and the [**Down chevron** macro](#down-chevron-down-chevron-md-macro
Often followed by the [**Filter streams** macro](#filter-streams-filter-streams-md-macro). Often followed by the [**Filter streams** macro](#filter-streams-filter-streams-md-macro).
* **Contents:** * **Contents:**
```.md ```md
1. [Find the relevant stream](/help/browse-and-join-streams#browse-streams) on 1. [Find the relevant stream](/help/browse-and-join-streams#browse-streams) on
the [Streams](/#streams) page. the [Streams](/#streams) page.
``` ```
* **Example usage and rendering:** * **Example usage and rendering:**
```.md ```md
{!subscriptions.md!} {!subscriptions.md!}
{!filter-streams.md!} {!filter-streams.md!}
``` ```
```.md ```md
1. [Find the relevant stream](/help/browse-and-join-streams#browse-streams) on the 1. [Find the relevant stream](/help/browse-and-join-streams#browse-streams) on the
[Streams](/#streams) page. You can search for specific streams by entering the [Streams](/#streams) page. You can search for specific streams by entering the
name of the stream in the **Filter streams** input. name of the stream in the **Filter streams** input.