From 1c83ebfc71929423907131ce9c42a2b37d4093f0 Mon Sep 17 00:00:00 2001 From: Anders Kaseorg Date: Fri, 20 Aug 2021 12:43:11 -0700 Subject: [PATCH] docs: Adjust list item indentation for Prettier compatibility. Signed-off-by: Anders Kaseorg (cherry picked from commit 0a3e022376a9153cb8c2133a63eb1b96e07f9675) --- docs/contributing/zulipbot-usage.md | 40 +++++++++++----------- docs/production/export-and-import.md | 50 ++++++++++++++-------------- 2 files changed, 45 insertions(+), 45 deletions(-) diff --git a/docs/contributing/zulipbot-usage.md b/docs/contributing/zulipbot-usage.md index f8bedefdee..520d93e9e4 100644 --- a/docs/contributing/zulipbot-usage.md +++ b/docs/contributing/zulipbot-usage.md @@ -17,28 +17,28 @@ model GitHub supports). to claim; **@zulipbot** will assign you to the issue and label the issue as **in progress**. - * If you're a new contributor, **@zulipbot** will give you read-only + * If you're a new contributor, **@zulipbot** will give you read-only collaborator access to the repository and leave a welcome message on the issue you claimed. - * You can also claim an issue that you've opened by including + * You can also claim an issue that you've opened by including `@zulipbot claim` in the body of your issue. - * If you accidentally claim an issue you didn't want to claim, comment + * If you accidentally claim an issue you didn't want to claim, comment `@zulipbot abandon` to abandon an issue. * **Label your issues** — Add appropriate labels to issues that you opened by including `@zulipbot add` in an issue comment or the body of your issue followed by the desired labels enclosed within double quotes (`""`). - * For example, to add the **bug** and **help wanted** labels to your + * For example, to add the **bug** and **help wanted** labels to your issue, comment or include `@zulipbot add "bug" "help wanted"` in the issue body. - * You'll receive an error message if you try to add any labels to your issue + * You'll receive an error message if you try to add any labels to your issue that don't exist in your repository. - * If you accidentally added the wrong labels, you can remove them by commenting + * If you accidentally added the wrong labels, you can remove them by commenting `@zulipbot remove` followed by the desired labels enclosed with double quotes (`""`). @@ -46,12 +46,12 @@ followed by the desired labels enclosed within double quotes (`""`). feature](https://help.github.com/en/articles/using-search-to-filter-issues-and-pull-requests) to find unclaimed issues by adding one of the following filters to your search: - * `-label: "in progress"` (excludes issues labeled with the **in progress** label) + * `-label: "in progress"` (excludes issues labeled with the **in progress** label) - * `no:assignee` (shows issues without assignees) + * `no:assignee` (shows issues without assignees) - Issues labeled with the **in progress** label and/or assigned to other users have - already been claimed. + Issues labeled with the **in progress** label and/or assigned to other users have + already been claimed. * **Collaborate in area label teams** — Receive notifications on issues and pull requests within your fields of expertise on the @@ -68,22 +68,22 @@ to the [Server message view](https://github.com/orgs/zulip/teams/server-message-view) team. Feel free to join as many area label teams as as you'd like! - After your request to join an area label team is approved, you'll receive - notifications for any issues labeled with the team's corresponding area - label as well as any pull requests that reference issues labeled with your - team's area label. + After your request to join an area label team is approved, you'll receive + notifications for any issues labeled with the team's corresponding area + label as well as any pull requests that reference issues labeled with your + team's area label. * **Track inactive claimed issues** — If a claimed issue has not been updated for a week, **@zulipbot** will post a comment on the inactive issue to ask the assignee(s) if they are still working on the issue. - If you see this comment on an issue you claimed, you should post a comment - on the issue to notify **@zulipbot** that you're still working on it. + If you see this comment on an issue you claimed, you should post a comment + on the issue to notify **@zulipbot** that you're still working on it. - If **@zulipbot** does not receive a response from the assignee within 3 days - of an inactive issue prompt, **@zulipbot** will automatically remove the - issue's current assignee(s) and the "in progress" label to allow others to - work on an inactive issue. + If **@zulipbot** does not receive a response from the assignee within 3 days + of an inactive issue prompt, **@zulipbot** will automatically remove the + issue's current assignee(s) and the "in progress" label to allow others to + work on an inactive issue. ### Contributing diff --git a/docs/production/export-and-import.md b/docs/production/export-and-import.md index 4c31e6bc29..9e38911bf3 100644 --- a/docs/production/export-and-import.md +++ b/docs/production/export-and-import.md @@ -167,17 +167,17 @@ daily incremental backups using storing the backups, edit `/etc/zulip/zulip-secrets.conf` on the PostgreSQL server to add: - ```ini - s3_backups_key = # aws public key - s3_backups_secret_key = # aws secret key - s3_backups_bucket = # name of S3 backup - ``` + ```ini + s3_backups_key = # aws public key + s3_backups_secret_key = # aws secret key + s3_backups_bucket = # name of S3 backup + ``` - After adding the secrets, run - `/home/zulip/deployments/current/scripts/zulip-puppet-apply`. You - can (and should) monitor that backups are running regularly via - the Nagios plugin installed into - `/usr/lib/nagios/plugins/zulip_postgresql_backups/check_postgresql_backup`. + After adding the secrets, run + `/home/zulip/deployments/current/scripts/zulip-puppet-apply`. You + can (and should) monitor that backups are running regularly via + the Nagios plugin installed into + `/usr/lib/nagios/plugins/zulip_postgresql_backups/check_postgresql_backup`. * Any user-uploaded files. If you're using S3 as storage for file uploads, this is backed up in S3. But if you have instead set @@ -300,25 +300,25 @@ archive of all the organization's uploaded files. 1. [Install a new Zulip server](../production/install.md), **skipping Step 3** (you'll create your Zulip organization via the data import tool instead). - * Ensure that the Zulip server you're importing into is running the same - version of Zulip as the server you're exporting from. + * Ensure that the Zulip server you're importing into is running the same + version of Zulip as the server you're exporting from. - * For exports from Zulip Cloud (zulip.com), you need to [upgrade to - master][upgrade-zulip-from-git], since we run run master on - Zulip Cloud: + * For exports from Zulip Cloud (zulip.com), you need to [upgrade to + master][upgrade-zulip-from-git], since we run run master on + Zulip Cloud: - ```bash - /home/zulip/deployments/current/scripts/upgrade-zulip-from-git master - ``` + ```bash + /home/zulip/deployments/current/scripts/upgrade-zulip-from-git master + ``` - It is not sufficient to be on the latest stable release, as - zulip.com runs pre-release versions of Zulip that are often - several months of development ahead of the latest release. + It is not sufficient to be on the latest stable release, as + zulip.com runs pre-release versions of Zulip that are often + several months of development ahead of the latest release. - * Note that if your server has limited free RAM, you'll want to - shut down the Zulip server with `./scripts/stop-server` while - you run the import, since our minimal system requirements do not - budget extra RAM for running the data import tool. + * Note that if your server has limited free RAM, you'll want to + shut down the Zulip server with `./scripts/stop-server` while + you run the import, since our minimal system requirements do not + budget extra RAM for running the data import tool. 2. If your new Zulip server is meant to fully replace a previous Zulip server, you may want to copy some settings from `/etc/zulip` to your