From 42f46a78e9c8f68de7feeb8989bace6800d0edcc Mon Sep 17 00:00:00 2001 From: rht Date: Thu, 20 Jan 2022 08:02:17 -0500 Subject: [PATCH] docs: Fix grammar problems found by LanguageTool. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit With tweaks to security-model.md by tabbott to expand the SSO acronym. Ignored, but still needs discussion on whether we should exclude this rule: ``` The word ‘install’ is not a noun. ✗ ...ble to connect to the client during the install process: So you'll need to shut down a... ^^^^^^^ ✓ ...ble to connect to the client during the installation process: So you'll need to shut down a... A_INSTALL: a/the + install The word ‘install’ is not a noun. ✗ ...detected at install time will cause the install to abort. If you already have PostgreSQ... ^^^^^^^ ✓ ...detected at install time will cause the installation to abort. If you already have PostgreSQ... A_INSTALL: a/the + install ``` --- docs/production/email-gateway.md | 2 +- docs/production/install-existing-server.md | 4 ++-- docs/production/security-model.md | 22 +++++++++++----------- docs/production/settings.md | 2 +- docs/production/video-calls.md | 2 +- 5 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/production/email-gateway.md b/docs/production/email-gateway.md index aa197e8c4c..95ab110c5d 100644 --- a/docs/production/email-gateway.md +++ b/docs/production/email-gateway.md @@ -125,7 +125,7 @@ Congratulations! The integration should be fully operational. su zulip -c '/home/zulip/deployments/current/manage.py email_mirror' ``` -1. Once everything is working, Install the cron job which will poll +1. Once everything is working, install the cron job which will poll the inbox every minute for new messages using the tool you tested in the last step: ```bash diff --git a/docs/production/install-existing-server.md b/docs/production/install-existing-server.md index 31c5311b03..e46e43e311 100644 --- a/docs/production/install-existing-server.md +++ b/docs/production/install-existing-server.md @@ -2,9 +2,9 @@ :orphan: ``` -# Production installation on existing server +# Production installation on an existing server -Here are some tips for installing the latest release Zulip on a +Here are some tips for installing the latest release of Zulip on a production server running Debian or Ubuntu. The Zulip installation scripts assume that it has carte blanche to overwrite your configuration files in /etc, so we recommend against installing it on diff --git a/docs/production/security-model.md b/docs/production/security-model.md index 68770b4e5f..2fa9ced175 100644 --- a/docs/production/security-model.md +++ b/docs/production/security-model.md @@ -35,11 +35,11 @@ announcement). - Zulip requires CSRF tokens in all interactions with the web API to prevent CSRF attacks. -- The preferred way to log in to Zulip is using an SSO solution like - Google auth, LDAP, or similar, but Zulip also supports password - authentication. See - [the authentication methods documentation](../production/authentication-methods.md) - for details on Zulip's available authentication methods. +- The preferred way to log in to Zulip is using a single sign-on (SSO) + solution like Google authentication, LDAP, or similar, but Zulip + also supports password authentication. See [the authentication + methods documentation](../production/authentication-methods.md) for + details on Zulip's available authentication methods. ### Passwords @@ -168,11 +168,11 @@ strength allowed is controlled by two settings in - To properly remove a user's access to a Zulip team, it does not suffice to change their password or deactivate their account in a - SSO system, since neither of those prevents authenticating with the - user's API key or those of bots the user has created. Instead, you - should - [deactivate the user's account](https://zulip.com/help/deactivate-or-reactivate-a-user) - via Zulip's "Organization settings" interface. + single sign-on (SSO) system, since neither of those prevents + authenticating with the user's API key or those of bots the user has + created. Instead, you should [deactivate the user's + account](https://zulip.com/help/deactivate-or-reactivate-a-user) via + Zulip's "Organization settings" interface. - The Zulip mobile apps authenticate to the server by sending the user's password and retrieving the user's API key; the apps then use @@ -260,7 +260,7 @@ strength allowed is controlled by two settings in - Notably, these first 3 features give end users (limited) control to cause the Zulip server to make HTTP requests on their behalf. Because of this, - Zulip routes all outgoing outgoing HTTP requests [through + Zulip routes all outgoing HTTP requests [through Smokescreen][smokescreen-setup] to ensure that Zulip cannot be used to execute [SSRF attacks][ssrf] against other systems on an internal corporate network. The default Smokescreen configuration diff --git a/docs/production/settings.md b/docs/production/settings.md index 07e74e4e17..2b9320a53d 100644 --- a/docs/production/settings.md +++ b/docs/production/settings.md @@ -23,7 +23,7 @@ su zulip -c '/home/zulip/deployments/current/scripts/restart-server' Zulip has dozens of settings documented in the comments in `/etc/zulip/settings.py`; you can review [the latest version of the settings.py template][settings-py-template], and if you've upgraded -from an old versions of Zulip, we recommend [carefully updating your +from an old version of Zulip, we recommend [carefully updating your `/etc/zulip/settings.py`][update-settings-docs] to fold in the inline comment documentation for new configuration settings after upgrading to each new major release. diff --git a/docs/production/video-calls.md b/docs/production/video-calls.md index a0776b1cb3..e07ce6d94a 100644 --- a/docs/production/video-calls.md +++ b/docs/production/video-calls.md @@ -20,7 +20,7 @@ installation, you'll need to register a custom Zoom app as follows: - Disable the option to publish the app on the Marketplace. - Click **Create**. -1. Inside of the Zoom app management page: +1. Inside the Zoom app management page: - On the **App Credentials** tab, set both the **Redirect URL for OAuth** and the **Whitelist URL** to