mirror of https://github.com/zulip/zulip.git
docs: Add alt text to images
Add alt text to images in docs roughly stating the contents of the image.
This commit is contained in:
parent
140d24ca7f
commit
a8511bc710
|
@ -439,7 +439,7 @@ Or, use curl:
|
|||
|
||||
{!congrats.md!}
|
||||
|
||||
![](/static/images/integrations/helloworld/001.png)
|
||||
![Hello World integration](/static/images/integrations/helloworld/001.png)
|
||||
|
||||
```
|
||||
|
||||
|
|
|
@ -12,7 +12,7 @@ message is about.
|
|||
Messages with the same stream and topic are shown together as a
|
||||
conversational thread. Here is what it looks like in Zulip.
|
||||
|
||||
![](/static/images/help/streams-and-topics.png)
|
||||
![Streams and topics](/static/images/help/streams-and-topics.png)
|
||||
|
||||
Streams and topics are one of the most rewarding parts of using Zulip.
|
||||
|
||||
|
|
|
@ -28,7 +28,7 @@ to allow you to easily format your messages.
|
|||
***~~All three at once~~***
|
||||
```
|
||||
|
||||
![](/static/images/help/markdown-emphasis.png)
|
||||
![Markdown emphasis](/static/images/help/markdown-emphasis.png)
|
||||
|
||||
|
||||
## Lists
|
||||
|
@ -46,7 +46,7 @@ bullet
|
|||
+ pluses are ok too
|
||||
```
|
||||
|
||||
![](/static/images/help/markdown-bullets.png)
|
||||
![Markdown bullets](/static/images/help/markdown-bullets.png)
|
||||
|
||||
Numbered lists
|
||||
|
||||
|
@ -56,7 +56,7 @@ Numbered lists
|
|||
1. one more
|
||||
```
|
||||
|
||||
![](/static/images/help/markdown-numbered-lists.png)
|
||||
![Markdown numbered lists](/static/images/help/markdown-numbered-lists.png)
|
||||
|
||||
|
||||
## Links
|
||||
|
@ -73,7 +73,7 @@ Topic: #**stream name>topic name**
|
|||
Custom linkifier: #1234 (links to ticket 1234 in your ticketing system)
|
||||
```
|
||||
|
||||
![](/static/images/help/markdown-links.png)
|
||||
![Markdown links](/static/images/help/markdown-links.png)
|
||||
|
||||
## Images
|
||||
|
||||
|
@ -84,7 +84,7 @@ about dropping, pasting, and attaching images.
|
|||
[A whale of a good time](https://your.zulip.domain/user_uploads/1/46/IPvysqXEtiTG1ZdNBrwAZODi/whale-time.png)
|
||||
```
|
||||
|
||||
![](/static/images/help/markdown-image.png)
|
||||
![Markdown image](/static/images/help/markdown-image.png)
|
||||
|
||||
## Code
|
||||
|
||||
|
@ -105,7 +105,7 @@ def fib(n):
|
|||
```
|
||||
~~~
|
||||
|
||||
![](/static/images/help/markdown-code.png)
|
||||
![Markdown code](/static/images/help/markdown-code.png)
|
||||
|
||||
You can also use `~~~` to start codeblocks, or just indent the code 4 or more spaces.
|
||||
|
||||
|
@ -128,7 +128,7 @@ Displayed:
|
|||
```
|
||||
~~~
|
||||
|
||||
![](/static/images/help/markdown-latex.png)
|
||||
![Markdown LaTeX](/static/images/help/markdown-latex.png)
|
||||
|
||||
Zulip's LaTeX rendering is powered by [KaTeX](https://katex.org).
|
||||
Their [support table](https://katex.org/docs/support_table.html) is a
|
||||
|
@ -150,7 +150,7 @@ quote in two paragraphs
|
|||
```
|
||||
~~~
|
||||
|
||||
![](/static/images/help/markdown-quotes.png)
|
||||
![Markdown quotes](/static/images/help/markdown-quotes.png)
|
||||
|
||||
## Spoilers
|
||||
|
||||
|
@ -168,11 +168,11 @@ Spoiler content. These lines won't be visible until the user expands the spoiler
|
|||
|
||||
The spoiler will initially display in a collapsed form:
|
||||
|
||||
![](/static/images/help/spoiler-collapsed.png)
|
||||
![Spoiler collapsed](/static/images/help/spoiler-collapsed.png)
|
||||
|
||||
Clicking the arrow will expand the spoiler content:
|
||||
|
||||
![](/static/images/help/spoiler-expanded.png)
|
||||
![Spoiler expanded](/static/images/help/spoiler-expanded.png)
|
||||
|
||||
## Emoji and emoticons
|
||||
|
||||
|
@ -184,7 +184,7 @@ You can also [add custom emoji](/help/add-custom-emoji).
|
|||
:octopus: :heart: :zulip: :)
|
||||
```
|
||||
|
||||
![](/static/images/help/markdown-emoji.png)
|
||||
![Markdown emoji](/static/images/help/markdown-emoji.png)
|
||||
|
||||
## Mentions
|
||||
|
||||
|
@ -197,7 +197,7 @@ User group: @*support team* (one asterisk)
|
|||
Silent mention: @_**Polonius** (@_ instead of @)
|
||||
```
|
||||
|
||||
![](/static/images/help/markdown-mentions.png)
|
||||
![Markdown mentions](/static/images/help/markdown-mentions.png)
|
||||
|
||||
## Status Messages
|
||||
|
||||
|
@ -205,7 +205,7 @@ Silent mention: @_**Polonius** (@_ instead of @)
|
|||
/me is away
|
||||
```
|
||||
|
||||
![](/static/images/help/markdown-status.png)
|
||||
![Markdown status](/static/images/help/markdown-status.png)
|
||||
|
||||
## Mention a time
|
||||
|
||||
|
@ -245,7 +245,7 @@ The header separators (`---`) must be at least three dashes long.
|
|||
| C | **bold** *italic* ~~strikethrough~~ :smile: ||
|
||||
```
|
||||
|
||||
![](/static/images/help/markdown-table.png)
|
||||
![Markdown table](/static/images/help/markdown-table.png)
|
||||
|
||||
## Paragraphs and lines
|
||||
|
||||
|
@ -263,7 +263,7 @@ Over the line
|
|||
Under the line
|
||||
```
|
||||
|
||||
![](/static/images/help/markdown-paragraph.png)
|
||||
![Markdown paragraph](/static/images/help/markdown-paragraph.png)
|
||||
|
||||
## In-app help
|
||||
|
||||
|
|
|
@ -45,7 +45,7 @@ Zulip with various common SAML Identity Providers.
|
|||
1. Go to the "Parameters" section. Ignore the pre-configured parameters that are already there
|
||||
and add custom ones to match the following screenshot:
|
||||
|
||||
![](/static/images/help/onelogin_parameters.png)
|
||||
![Onelogin parameters](/static/images/help/onelogin_parameters.png)
|
||||
|
||||
Make sure to set the "Include in SAML assertion" flag on them.
|
||||
|
||||
|
|
|
@ -13,30 +13,30 @@ Start by setting up a [Zapier](https://zapier.com/) account.
|
|||
Next, create a ZAP, picking Asana as the app you'd like
|
||||
to receive notifications from as the **Trigger (Step 1)**:
|
||||
|
||||
![](/static/images/integrations/asana/001.png)
|
||||
![Trigger](/static/images/integrations/asana/001.png)
|
||||
|
||||
Next, select the Asana event that you'd like to receive notifications
|
||||
for (**Choose Trigger**), such as when you add a new **Task** in
|
||||
an Asana project:
|
||||
|
||||
![](/static/images/integrations/asana/002.png)
|
||||
![Trigger selection](/static/images/integrations/asana/002.png)
|
||||
|
||||
Next, click on **Connect a New Account** and follow the steps
|
||||
to connect your Asana account to the Zap:
|
||||
|
||||
![](/static/images/integrations/asana/003.png)
|
||||
![Account selection](/static/images/integrations/asana/003.png)
|
||||
|
||||
Select the Asana project you'd like to receive notifications for:
|
||||
|
||||
![](/static/images/integrations/asana/004.png)
|
||||
![Project selection](/static/images/integrations/asana/004.png)
|
||||
|
||||
In **Action (Step 2)**, select **Webhooks by Zapier** as the app:
|
||||
|
||||
![](/static/images/integrations/asana/005.png)
|
||||
![App selection](/static/images/integrations/asana/005.png)
|
||||
|
||||
and `POST` as the action:
|
||||
|
||||
![](/static/images/integrations/asana/006.png)
|
||||
![Action selection](/static/images/integrations/asana/006.png)
|
||||
|
||||
Configure **Set up Webhooks by Zapier POST** as follows:
|
||||
|
||||
|
@ -53,11 +53,11 @@ in a number of ways as per your requirements.
|
|||
|
||||
Here's an example configuration:
|
||||
|
||||
![](/static/images/integrations/asana/007.png)
|
||||
![Example configuration](/static/images/integrations/asana/007.png)
|
||||
|
||||
{!congrats.md!}
|
||||
|
||||
![](/static/images/integrations/asana/008.png)
|
||||
![Asana bot message](/static/images/integrations/asana/008.png)
|
||||
|
||||
You can repeat the above process and create Zaps for different projects
|
||||
and/or different kinds of Asana events that you'd like to be notified
|
||||
|
|
|
@ -38,4 +38,4 @@ creating that file.
|
|||
|
||||
{!congrats.md!}
|
||||
|
||||
![](/static/images/integrations/capistrano/001.png)
|
||||
![Capistrano bot message](/static/images/integrations/capistrano/001.png)
|
||||
|
|
|
@ -37,4 +37,4 @@ Get Codebase notifications in Zulip!
|
|||
|
||||
{!congrats.md!}
|
||||
|
||||
![](/static/images/integrations/codebase/001.png)
|
||||
![Codebase bot message](/static/images/integrations/codebase/001.png)
|
||||
|
|
|
@ -3,7 +3,7 @@ On your {{ settings_html|safe }},
|
|||
{{ integration_display_name }}. Make sure that you select
|
||||
**Incoming webhook** as the **Bot type**:
|
||||
|
||||
![](/static/images/integrations/bot_types.png)
|
||||
![Bot types](/static/images/integrations/bot_types.png)
|
||||
|
||||
The API keys for "Incoming webhook" bots are limited to only
|
||||
sending messages via webhooks. Thus, this bot type lessens
|
||||
|
@ -18,4 +18,4 @@ and complete them.
|
|||
|
||||
{!congrats.md!}
|
||||
|
||||
![](/static/images/integrations/discourse/001.png)
|
||||
![Discourse chat integration](/static/images/integrations/discourse/001.png)
|
||||
|
|
|
@ -41,7 +41,7 @@ Run your favorite chatbot in Zulip!
|
|||
|
||||
{!congrats.md!}
|
||||
|
||||
![](/static/images/integrations/errbot/000.png)
|
||||
![Errbot message](/static/images/integrations/errbot/000.png)
|
||||
|
||||
### Tips
|
||||
|
||||
|
|
|
@ -28,4 +28,4 @@ Get Zulip notifications for your Git repositories!
|
|||
|
||||
{!congrats.md!}
|
||||
|
||||
![](/static/images/integrations/git/001.png)
|
||||
![Git bot message](/static/images/integrations/git/001.png)
|
||||
|
|
|
@ -24,7 +24,7 @@ Click on the tab that’s labeled **Your bots** and click on
|
|||
download the `zuliprc` file. Save this file as `.zuliprc` to your `~/`
|
||||
directory.
|
||||
|
||||
![](/static/images/integrations/google/calendar/001.png)
|
||||
![Download zuliprc file](/static/images/integrations/google/calendar/001.png)
|
||||
|
||||
Run the `get-google-credentials` with this command:
|
||||
|
||||
|
@ -54,7 +54,7 @@ script:
|
|||
Address** section. Copy the **Calendar ID** from the right side of the
|
||||
page and use that as the value for this flag.
|
||||
|
||||
![](/static/images/integrations/google/calendar/002.png)
|
||||
![Specify a calendar](/static/images/integrations/google/calendar/002.png)
|
||||
|
||||
* `--interval`: This flag specifies the interval of time - in
|
||||
minutes - between receiving the reminder, and the actual event. For
|
||||
|
@ -67,4 +67,4 @@ running.
|
|||
|
||||
{!congrats.md!}
|
||||
|
||||
![](/static/images/integrations/google/calendar/003.png)
|
||||
![Calendar demo](/static/images/integrations/google/calendar/003.png)
|
||||
|
|
|
@ -34,7 +34,7 @@ To test your Hubot installation, send it an @-notification with a
|
|||
basic command, for example `@Hubot pug me`, which should produce a
|
||||
result like this:
|
||||
|
||||
![](/static/images/integrations/hubot/001.png)
|
||||
![Hubot message](/static/images/integrations/hubot/001.png)
|
||||
|
||||
[Source code for the hubot-zulip adapter is available on GitHub][1]
|
||||
[1]: https://github.com/zulip/hubot-zulip
|
||||
|
|
|
@ -57,8 +57,8 @@ Example command:
|
|||
|
||||
Your Zulip messages may look like:
|
||||
|
||||
![](/static/images/integrations/irc/001.png)
|
||||
![IRC message on Zulip](/static/images/integrations/irc/001.png)
|
||||
|
||||
Your IRC messages may look like:
|
||||
|
||||
![](/static/images/integrations/irc/002.png)
|
||||
![Zulip message on IRC](/static/images/integrations/irc/002.png)
|
||||
|
|
|
@ -9,7 +9,7 @@ Install the "Zulip" plugin by going to
|
|||
typing in **Zulip**, and clicking **Install without
|
||||
restart**.
|
||||
|
||||
![](/static/images/integrations/jenkins/001.png)
|
||||
![Plugin installation](/static/images/integrations/jenkins/001.png)
|
||||
|
||||
### Configure the plugin
|
||||
|
||||
|
@ -24,7 +24,7 @@ recovers from a failed state).
|
|||
(If you don't see this option, you may first need to restart
|
||||
Jenkins.)
|
||||
|
||||
![](/static/images/integrations/jenkins/002.png)
|
||||
![Plugin configuration](/static/images/integrations/jenkins/002.png)
|
||||
|
||||
### Configure a post-build action for your project
|
||||
|
||||
|
@ -39,13 +39,13 @@ If you don't specify a custom topic, the project name will be used as the
|
|||
topic instead.
|
||||
Then click **Save**.
|
||||
|
||||
![](/static/images/integrations/jenkins/003.png)
|
||||
![Post-build action configuration](/static/images/integrations/jenkins/003.png)
|
||||
|
||||
When your builds fail or succeed, you'll see a message as shown below.
|
||||
|
||||
{!congrats.md!}
|
||||
|
||||
![](/static/images/integrations/jenkins/004.png)
|
||||
![Jenkins bot message](/static/images/integrations/jenkins/004.png)
|
||||
|
||||
### Advanced use cases
|
||||
|
||||
|
|
|
@ -68,4 +68,4 @@ String issueBaseUrl = "https://jira.COMPANY.com/browse/"
|
|||
|
||||
{!congrats.md!}
|
||||
|
||||
![](/static/images/integrations/jira/001.png)
|
||||
![JIRA bot message](/static/images/integrations/jira/001.png)
|
||||
|
|
|
@ -85,4 +85,4 @@ Zulip notification.
|
|||
|
||||
{!congrats.md!}
|
||||
|
||||
![](/static/images/integrations/hg/001.png)
|
||||
![Mercurial bot message](/static/images/integrations/hg/001.png)
|
||||
|
|
|
@ -42,7 +42,7 @@ with a topic indicating the service with an issue.
|
|||
|
||||
{!congrats.md!}
|
||||
|
||||
![](/static/images/integrations/nagios/001.png)
|
||||
![Nagios bot message](/static/images/integrations/nagios/001.png)
|
||||
|
||||
**Testing**
|
||||
|
||||
|
|
|
@ -14,7 +14,7 @@ application’s dashboard, and click **Want to log in to your
|
|||
application?**. There you’ll find the app’s SSH user, address, and
|
||||
further information on SSH, in case you need it.
|
||||
|
||||
![](/static/images/integrations/openshift/002.png)
|
||||
![Connecting to application](/static/images/integrations/openshift/002.png)
|
||||
|
||||
{!change-zulip-config-file.md!}
|
||||
|
||||
|
@ -36,7 +36,7 @@ notification.
|
|||
|
||||
{!congrats.md!}
|
||||
|
||||
![](/static/images/integrations/openshift/001.png)
|
||||
![OpenShift integration message](/static/images/integrations/openshift/001.png)
|
||||
|
||||
**Testing**
|
||||
|
||||
|
|
|
@ -46,4 +46,4 @@ destination stream exists and silently drop messages if it does not.
|
|||
|
||||
{!congrats.md!}
|
||||
|
||||
![](/static/images/integrations/perforce/001.png)
|
||||
![Perforce notification bot message](/static/images/integrations/perforce/001.png)
|
||||
|
|
|
@ -53,7 +53,7 @@ project's **Settings** page, and select the **Zulip** tab.
|
|||
|
||||
{!congrats.md!}
|
||||
|
||||
![](/static/images/integrations/redmine/001.png)
|
||||
![Redmine bot message](/static/images/integrations/redmine/001.png)
|
||||
|
||||
[1]: https://www.redmine.org/projects/redmine/wiki/Plugins
|
||||
[2]: https://github.com/zulip/zulip-redmine-plugin
|
||||
|
|
|
@ -22,4 +22,4 @@ the bot.
|
|||
|
||||
{!congrats.md!}
|
||||
|
||||
![](/static/images/integrations/rss/001.png)
|
||||
![RSS bot message](/static/images/integrations/rss/001.png)
|
||||
|
|
|
@ -26,4 +26,4 @@ these post-commit Zulips is subscribed to that stream!
|
|||
|
||||
{!congrats.md!}
|
||||
|
||||
![](/static/images/integrations/svn/001.png)
|
||||
![SVN commit bot message](/static/images/integrations/svn/001.png)
|
||||
|
|
|
@ -34,7 +34,7 @@ configured above) with a topic that matches the ticket name.
|
|||
|
||||
{!congrats.md!}
|
||||
|
||||
![](/static/images/integrations/trac/001.png)
|
||||
![Trac bot message](/static/images/integrations/trac/001.png)
|
||||
|
||||
**Additional trac configuration**
|
||||
|
||||
|
|
|
@ -14,6 +14,6 @@ and follow the instructions in `README.md`.
|
|||
|
||||
{!congrats.md!}
|
||||
|
||||
![](/static/images/integrations/trello/002.png)
|
||||
![Trello bot message](/static/images/integrations/trello/002.png)
|
||||
|
||||
##### Thanks to Nathan from FoundationDB for submitting this integration!
|
||||
|
|
|
@ -9,7 +9,7 @@ Next, on your {{ settings_html|safe }},
|
|||
{{ integration_display_name }}. Make sure that you select
|
||||
**Incoming webhook** as the **Bot type**:
|
||||
|
||||
![](/static/images/integrations/bot_types.png)
|
||||
![Bot types](/static/images/integrations/bot_types.png)
|
||||
|
||||
The API keys for "Incoming webhook" bots are limited to only
|
||||
sending messages via webhooks. Thus, this bot type lessens
|
||||
|
@ -77,7 +77,7 @@ the topic.
|
|||
|
||||
{!congrats.md!}
|
||||
|
||||
![](/static/images/integrations/twitter/001.png)
|
||||
![Twitter bot message](/static/images/integrations/twitter/001.png)
|
||||
|
||||
Note that the Twitter search bot integration **just sends links to
|
||||
tweets**; the pretty inline previews of tweets are generated by the
|
||||
|
|
Loading…
Reference in New Issue