From a8511bc7105aef5d27c281e6d805d1f17a0d1551 Mon Sep 17 00:00:00 2001 From: gr455 Date: Wed, 5 Aug 2020 15:20:17 +0530 Subject: [PATCH] docs: Add alt text to images Add alt text to images in docs roughly stating the contents of the image. --- .../api/incoming-webhooks-walkthrough.md | 2 +- .../zerver/help/about-streams-and-topics.md | 2 +- .../format-your-message-using-markdown.md | 30 +++++++++---------- templates/zerver/help/saml-authentication.md | 2 +- templates/zerver/integrations/asana.md | 16 +++++----- templates/zerver/integrations/capistrano.md | 2 +- templates/zerver/integrations/codebase.md | 2 +- templates/zerver/integrations/discourse.md | 4 +-- templates/zerver/integrations/errbot.md | 2 +- templates/zerver/integrations/git.md | 2 +- .../zerver/integrations/google-calendar.md | 6 ++-- templates/zerver/integrations/hubot.md | 2 +- templates/zerver/integrations/irc.md | 4 +-- templates/zerver/integrations/jenkins.md | 8 ++--- templates/zerver/integrations/jira-plugin.md | 2 +- templates/zerver/integrations/mercurial.md | 2 +- templates/zerver/integrations/nagios.md | 2 +- templates/zerver/integrations/openshift.md | 4 +-- templates/zerver/integrations/perforce.md | 2 +- templates/zerver/integrations/redmine.md | 2 +- templates/zerver/integrations/rss.md | 2 +- templates/zerver/integrations/svn.md | 2 +- templates/zerver/integrations/trac.md | 2 +- .../zerver/integrations/trello-plugin.md | 2 +- templates/zerver/integrations/twitter.md | 4 +-- 25 files changed, 55 insertions(+), 55 deletions(-) diff --git a/templates/zerver/api/incoming-webhooks-walkthrough.md b/templates/zerver/api/incoming-webhooks-walkthrough.md index 061269ad6d..ea98844bff 100644 --- a/templates/zerver/api/incoming-webhooks-walkthrough.md +++ b/templates/zerver/api/incoming-webhooks-walkthrough.md @@ -439,7 +439,7 @@ Or, use curl: {!congrats.md!} -![](/static/images/integrations/helloworld/001.png) +![Hello World integration](/static/images/integrations/helloworld/001.png) ``` diff --git a/templates/zerver/help/about-streams-and-topics.md b/templates/zerver/help/about-streams-and-topics.md index 16ba1f0ff0..e48ad741f9 100644 --- a/templates/zerver/help/about-streams-and-topics.md +++ b/templates/zerver/help/about-streams-and-topics.md @@ -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. diff --git a/templates/zerver/help/format-your-message-using-markdown.md b/templates/zerver/help/format-your-message-using-markdown.md index 27a7227ed2..d892f7fda6 100644 --- a/templates/zerver/help/format-your-message-using-markdown.md +++ b/templates/zerver/help/format-your-message-using-markdown.md @@ -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 diff --git a/templates/zerver/help/saml-authentication.md b/templates/zerver/help/saml-authentication.md index 9a52b04fbd..e1bd303a56 100644 --- a/templates/zerver/help/saml-authentication.md +++ b/templates/zerver/help/saml-authentication.md @@ -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. diff --git a/templates/zerver/integrations/asana.md b/templates/zerver/integrations/asana.md index 569c7ddf64..b4eb761647 100644 --- a/templates/zerver/integrations/asana.md +++ b/templates/zerver/integrations/asana.md @@ -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 diff --git a/templates/zerver/integrations/capistrano.md b/templates/zerver/integrations/capistrano.md index d5e467074f..51e7fad592 100644 --- a/templates/zerver/integrations/capistrano.md +++ b/templates/zerver/integrations/capistrano.md @@ -38,4 +38,4 @@ creating that file. {!congrats.md!} -![](/static/images/integrations/capistrano/001.png) +![Capistrano bot message](/static/images/integrations/capistrano/001.png) diff --git a/templates/zerver/integrations/codebase.md b/templates/zerver/integrations/codebase.md index 9f7bf00072..4f64e592a6 100644 --- a/templates/zerver/integrations/codebase.md +++ b/templates/zerver/integrations/codebase.md @@ -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) diff --git a/templates/zerver/integrations/discourse.md b/templates/zerver/integrations/discourse.md index 5b202bfad1..1123baae8f 100644 --- a/templates/zerver/integrations/discourse.md +++ b/templates/zerver/integrations/discourse.md @@ -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) diff --git a/templates/zerver/integrations/errbot.md b/templates/zerver/integrations/errbot.md index 01f2a49b51..63fd75eaec 100644 --- a/templates/zerver/integrations/errbot.md +++ b/templates/zerver/integrations/errbot.md @@ -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 diff --git a/templates/zerver/integrations/git.md b/templates/zerver/integrations/git.md index b27f310713..6072fb1678 100644 --- a/templates/zerver/integrations/git.md +++ b/templates/zerver/integrations/git.md @@ -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) diff --git a/templates/zerver/integrations/google-calendar.md b/templates/zerver/integrations/google-calendar.md index 4f0507ea1b..0b356f7ca7 100644 --- a/templates/zerver/integrations/google-calendar.md +++ b/templates/zerver/integrations/google-calendar.md @@ -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) diff --git a/templates/zerver/integrations/hubot.md b/templates/zerver/integrations/hubot.md index 8f02d935f5..00de09bf72 100644 --- a/templates/zerver/integrations/hubot.md +++ b/templates/zerver/integrations/hubot.md @@ -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 diff --git a/templates/zerver/integrations/irc.md b/templates/zerver/integrations/irc.md index e88230e798..10f29f46e0 100644 --- a/templates/zerver/integrations/irc.md +++ b/templates/zerver/integrations/irc.md @@ -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) diff --git a/templates/zerver/integrations/jenkins.md b/templates/zerver/integrations/jenkins.md index 0a2b96e314..aea8023df2 100644 --- a/templates/zerver/integrations/jenkins.md +++ b/templates/zerver/integrations/jenkins.md @@ -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 diff --git a/templates/zerver/integrations/jira-plugin.md b/templates/zerver/integrations/jira-plugin.md index 2d34e31443..784a647d9c 100644 --- a/templates/zerver/integrations/jira-plugin.md +++ b/templates/zerver/integrations/jira-plugin.md @@ -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) diff --git a/templates/zerver/integrations/mercurial.md b/templates/zerver/integrations/mercurial.md index 4dfe996fd3..e5214626e0 100644 --- a/templates/zerver/integrations/mercurial.md +++ b/templates/zerver/integrations/mercurial.md @@ -85,4 +85,4 @@ Zulip notification. {!congrats.md!} -![](/static/images/integrations/hg/001.png) +![Mercurial bot message](/static/images/integrations/hg/001.png) diff --git a/templates/zerver/integrations/nagios.md b/templates/zerver/integrations/nagios.md index b872492643..cff6b043e2 100644 --- a/templates/zerver/integrations/nagios.md +++ b/templates/zerver/integrations/nagios.md @@ -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** diff --git a/templates/zerver/integrations/openshift.md b/templates/zerver/integrations/openshift.md index 5fc67660e3..ee7cb2ae80 100644 --- a/templates/zerver/integrations/openshift.md +++ b/templates/zerver/integrations/openshift.md @@ -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** diff --git a/templates/zerver/integrations/perforce.md b/templates/zerver/integrations/perforce.md index 816efd6502..da83918045 100644 --- a/templates/zerver/integrations/perforce.md +++ b/templates/zerver/integrations/perforce.md @@ -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) diff --git a/templates/zerver/integrations/redmine.md b/templates/zerver/integrations/redmine.md index 0211373b83..11b3acf270 100644 --- a/templates/zerver/integrations/redmine.md +++ b/templates/zerver/integrations/redmine.md @@ -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 diff --git a/templates/zerver/integrations/rss.md b/templates/zerver/integrations/rss.md index 758af0f777..2a373c4f3e 100644 --- a/templates/zerver/integrations/rss.md +++ b/templates/zerver/integrations/rss.md @@ -22,4 +22,4 @@ the bot. {!congrats.md!} -![](/static/images/integrations/rss/001.png) +![RSS bot message](/static/images/integrations/rss/001.png) diff --git a/templates/zerver/integrations/svn.md b/templates/zerver/integrations/svn.md index 0769d33505..8f8d91fed0 100644 --- a/templates/zerver/integrations/svn.md +++ b/templates/zerver/integrations/svn.md @@ -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) diff --git a/templates/zerver/integrations/trac.md b/templates/zerver/integrations/trac.md index 80847692e4..ea12d5c2ba 100644 --- a/templates/zerver/integrations/trac.md +++ b/templates/zerver/integrations/trac.md @@ -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** diff --git a/templates/zerver/integrations/trello-plugin.md b/templates/zerver/integrations/trello-plugin.md index 05313bd497..6dd3bf4af3 100644 --- a/templates/zerver/integrations/trello-plugin.md +++ b/templates/zerver/integrations/trello-plugin.md @@ -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! diff --git a/templates/zerver/integrations/twitter.md b/templates/zerver/integrations/twitter.md index 1aa70015d5..87c9347437 100644 --- a/templates/zerver/integrations/twitter.md +++ b/templates/zerver/integrations/twitter.md @@ -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