mirror of https://github.com/zulip/zulip.git
docs: Correct “setup” as a verb to “set up”.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
This commit is contained in:
parent
fb2e56e3c9
commit
64b2212c23
|
@ -74,7 +74,7 @@ to read these documents to learn how to use it:
|
|||
* [Using the Development Environment][using-dev-env]
|
||||
* [Testing][testing] (and [Configuring CI][ci])
|
||||
|
||||
And if you've setup the Zulip development environment on a remote
|
||||
And if you've set up the Zulip development environment on a remote
|
||||
machine, take a look at our tips for
|
||||
[developing remotely][dev-remote].
|
||||
|
||||
|
|
|
@ -31,7 +31,7 @@ networks.
|
|||
|
||||
## Setting up user accounts
|
||||
|
||||
You will need a non-root user account with sudo privileges to setup
|
||||
You will need a non-root user account with sudo privileges to set up
|
||||
the Zulip development environment. If you have one already, continue
|
||||
to the next section.
|
||||
|
||||
|
@ -91,7 +91,7 @@ To properly secure your remote development environment, you can
|
|||
[port forward](https://help.ubuntu.com/community/SSH/OpenSSH/PortForwarding)
|
||||
using ssh instead of running the development environment on an exposed
|
||||
interface. For example, if you're running Zulip on a remote server
|
||||
such as a DigitalOcean Droplet or an AWS EC2 instance, you can setup
|
||||
such as a DigitalOcean Droplet or an AWS EC2 instance, you can set up
|
||||
port-forwarding to access Zulip by running the following command in
|
||||
your terminal:
|
||||
|
||||
|
@ -187,7 +187,7 @@ develop remotely from the comfort of your local machine.
|
|||
Similar packages/extensions exist for other popular code editors as
|
||||
well; contributions of precise documentation for them are welcome!
|
||||
|
||||
To setup [rmate](https://github.com/textmate/rmate) for VS Code:
|
||||
To set up [rmate](https://github.com/textmate/rmate) for VS Code:
|
||||
1. Install the extension
|
||||
[Remote VSCode](https://marketplace.visualstudio.com/items?itemName=rafaelmaiolla.remote-vscode).
|
||||
2. On your remote machine, run:
|
||||
|
@ -235,7 +235,7 @@ If you are relatively new to working on the command line, or just want to get
|
|||
started working quickly, we recommend web-based IDE
|
||||
[Codeanywhere][codeanywhere].
|
||||
|
||||
To setup Codeanywhere for Zulip:
|
||||
To set up Codeanywhere for Zulip:
|
||||
|
||||
1. Create a [Codeanywhere][codeanywhere] account and log in.
|
||||
2. Create a new **SFTP-SSH** project. Use *Public key* for authentication.
|
||||
|
|
|
@ -149,7 +149,7 @@ eventually eliminate this documentation section altogether).
|
|||
|
||||
You can use
|
||||
[our provisioning tool](#installing-directly-on-ubuntu-debian-centos-or-fedora)
|
||||
to setup the Zulip development environment on current versions of
|
||||
to set up the Zulip development environment on current versions of
|
||||
these platforms reliably and easily, so we no long maintain manual
|
||||
installation instructions for these platforms.
|
||||
|
||||
|
@ -285,7 +285,7 @@ AWS Cloud9 is a cloud-based integrated development environment (IDE)
|
|||
that lets you write, run, and debug your code with just a browser. It
|
||||
includes a code editor, debugger, and terminal.
|
||||
|
||||
This section documents how to setup the Zulip development environment
|
||||
This section documents how to set up the Zulip development environment
|
||||
in a cloud9 workspace. If you don't have an existing cloud9 account,
|
||||
you can sign up [here](https://aws.amazon.com/cloud9/).
|
||||
|
||||
|
|
|
@ -7,7 +7,7 @@ integrations).
|
|||
|
||||
Usually, this involves a few steps:
|
||||
|
||||
* Add text explaining all of the steps required to setup the
|
||||
* Add text explaining all of the steps required to set up the
|
||||
integration, including what URLs to use, etc. See
|
||||
[Writing guidelines](#writing-guidelines) for detailed writing guidelines.
|
||||
|
||||
|
|
|
@ -41,7 +41,7 @@ are usually linked from `static/images/help/`.
|
|||
This means that you can contribute to the Zulip user documentation by just
|
||||
adding to or editing the collection of Markdown files under
|
||||
`templates/zerver/help`. If you have the Zulip development environment
|
||||
setup, you simply need to reload your browser on
|
||||
set up, you simply need to reload your browser on
|
||||
`http://localhost:9991/help/foo` to see the latest version of `foo.md`
|
||||
rendered.
|
||||
|
||||
|
|
|
@ -124,7 +124,7 @@ you create a pull request. While you wait for CircleCI jobs
|
|||
to run, you can start working on your next task. When the tests finish,
|
||||
you can create a pull request that you already know passes the tests.
|
||||
|
||||
### Setup CircleCI
|
||||
### Set up CircleCI
|
||||
|
||||
First, sign in to [CircleCI][circle-ci] with your GitHub account and authorize
|
||||
CircleCI to access your GitHub account and repositories. Once you've logged
|
||||
|
|
|
@ -863,7 +863,7 @@ Zulip installations; it has minimal changes for existing servers.
|
|||
- Fixed several subtle unread count corner case bugs.
|
||||
- Fixed several installer issues to make it easier to Dockerize Zulip.
|
||||
- Fixed several subtle issues with both the LDAP/Active Directory
|
||||
integration and its documentation, making it much easier to setup.
|
||||
integration and its documentation, making it much easier to set up.
|
||||
- Fixed several minor bugs and otherwise optimized search typeahead.
|
||||
- Fixed a bad nginx configuration interaction with servers that have
|
||||
misconfigured IPv6.
|
||||
|
|
|
@ -121,7 +121,7 @@ Django context (i.e. with database access).
|
|||
the development environment setup process.
|
||||
|
||||
* `tools/ci/` Subdirectory of `tools/` for things only used to
|
||||
setup and run our tests in CI. Actual test suites should
|
||||
set up and run our tests in CI. Actual test suites should
|
||||
go in `tools/`.
|
||||
|
||||
---------------------------------------------------------
|
||||
|
|
|
@ -285,7 +285,7 @@ CSS](https://github.com/zulip/zulip/).
|
|||
access](https://github.com/zulip/zulip/issues/13172). Expert: Tim
|
||||
Abbott.
|
||||
|
||||
- Make Zulip integrations easier for nontechnical users to setup.
|
||||
- Make Zulip integrations easier for nontechnical users to set up.
|
||||
This includes adding a backend permissions system for managing bot
|
||||
permissions (and implementing the enforcement logic), adding an
|
||||
OAuth system for presenting those controls to users, as well as
|
||||
|
|
|
@ -91,7 +91,7 @@ order to avoid it throwing an error when Zulip attempts to configure
|
|||
the database's dictionary files for full-text search; the details are
|
||||
below.
|
||||
|
||||
#### Step 1: Setup Zulip
|
||||
#### Step 1: Set up Zulip
|
||||
|
||||
Follow the [standard instructions](../production/install.md), with one
|
||||
change. When running the installer, pass the `--no-init-db`
|
||||
|
@ -224,7 +224,7 @@ instead of HTTPS.
|
|||
|
||||
### nginx configuration
|
||||
|
||||
For `nginx` configuration, there's two things you need to setup:
|
||||
For `nginx` configuration, there's two things you need to set up:
|
||||
* The root `nginx.conf` file. We recommend using
|
||||
`/etc/nginx/nginx.conf` from your Zulip server for our recommended
|
||||
settings. E.g. if you don't set `client_max_body_size`, it won't be
|
||||
|
|
|
@ -47,7 +47,7 @@ service (or back):
|
|||
inexpensively preserve public stream conversations when
|
||||
decommissioning a Zulip organization.
|
||||
|
||||
* It's possible to setup [postgres streaming
|
||||
* It's possible to set up [postgres streaming
|
||||
replication](#postgres-streaming-replication) and the [S3 file
|
||||
upload
|
||||
backend](../production/upload-backends.html#s3-backend-configuration)
|
||||
|
@ -185,7 +185,7 @@ will be stored in that directory and you'll want to back it up.
|
|||
|
||||
* Your Zulip configuration including secrets from `/etc/zulip/`.
|
||||
E.g. if you lose the value of `secret_key`, all users will need to
|
||||
login again when you setup a replacement server since you won't be
|
||||
login again when you set up a replacement server since you won't be
|
||||
able to verify their cookies. If you lose `avatar_salt`, any
|
||||
user-uploaded avatars will need to be re-uploaded (since avatar
|
||||
filenames are computed using a hash of `avatar_salt` and user's
|
||||
|
|
|
@ -42,7 +42,7 @@ follows:
|
|||
you'll each need to log out and log back in again in order to start
|
||||
getting push notifications.
|
||||
|
||||
Congratulations! You've successfully setup the service.
|
||||
Congratulations! You've successfully set up the service.
|
||||
|
||||
If you'd like to verify that everything is working, you can do the
|
||||
following. Please follow the instructions carefully:
|
||||
|
@ -171,7 +171,7 @@ the cost of needing to compile and distribute modified versions of the
|
|||
Zulip mobile apps.
|
||||
|
||||
We don't recommend this path -- patching and shipping a production
|
||||
mobile app can take dozens of hours to setup even for an experienced
|
||||
mobile app can take dozens of hours to set up even for an experienced
|
||||
developer, and even more time to maintain. And it doesn't provide
|
||||
material privacy benefits -- your organization's push notification
|
||||
data would still go through Apple/Google's servers, just not Kandra
|
||||
|
|
|
@ -15,7 +15,7 @@ in a future release.
|
|||
|
||||
#### Remote Postgres database
|
||||
|
||||
This is a bit annoying to setup, but you can configure Zulip to use a
|
||||
This is a bit annoying to set up, but you can configure Zulip to use a
|
||||
dedicated postgres server by setting the `REMOTE_POSTGRES_HOST`
|
||||
variable in /etc/zulip/settings.py, and configuring Postgres
|
||||
certificate authentication (see
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# Customize Zulip
|
||||
|
||||
Once you've got Zulip setup, you'll likely want to configure it the
|
||||
Once you've got Zulip set up, you'll likely want to configure it the
|
||||
way you like.
|
||||
|
||||
## Making changes
|
||||
|
|
|
@ -111,7 +111,7 @@ The upgrade scripts are idempotent, so there's no harm in trying again
|
|||
after resolving an issue. The most common causes of errors are:
|
||||
|
||||
* Networking issues (e.g. your Zulip server doesn't have reliable
|
||||
Internet access or needs a proxy setup). Fix the networking issue
|
||||
Internet access or needs a proxy set up). Fix the networking issue
|
||||
and try again.
|
||||
* Especially when using `upgrade-zulip-from-git`, systems with the
|
||||
minimal RAM for running Zulip can run into out-of-memory issues
|
||||
|
|
|
@ -148,7 +148,7 @@ As you scale your server, you might want to migrate the uploads from
|
|||
your local backend to Amazon S3. Follow these instructions, step by
|
||||
step, to do the migration.
|
||||
|
||||
1. First, [setup the S3 backend](#s3-backend-configuration) in the settings
|
||||
1. First, [set up the S3 backend](#s3-backend-configuration) in the settings
|
||||
(all the auth stuff), but leave `LOCAL_UPLOADS_DIR` set -- the
|
||||
migration tool will need that value to know where to find your uploads.
|
||||
2. Run `./manage.py transfer_uploads_to_s3`. This will upload all the
|
||||
|
|
|
@ -27,7 +27,7 @@ For example, our [infrastructure for testing
|
|||
authentication](../development/authentication.md) allows using a mock
|
||||
LDAP database in both automated tests and the development environment,
|
||||
making it much easier now to refactor and improve this important part of
|
||||
the product than it was when you needed to setup an LDAP server and
|
||||
the product than it was when you needed to set up an LDAP server and
|
||||
populate it with some test data in order to test LDAP authentication.
|
||||
|
||||
While not every part of Zulip has a great test suite, many components
|
||||
|
|
|
@ -52,7 +52,7 @@ want to know; you'll likely also want to read the section on writing
|
|||
tests (below) if you get stuck, since the advice on how to write
|
||||
correct Casper selectors will likely be relevant.
|
||||
|
||||
This is a pain to setup with Vagrant because port `7777` and `9981`
|
||||
This is a pain to set up with Vagrant because port `7777` and `9981`
|
||||
aren't forwarded to the host by default, but can be pretty useful in
|
||||
rare difficult cases.
|
||||
|
||||
|
|
|
@ -64,9 +64,9 @@ working on or debugging the Zulip node tests.
|
|||
|
||||
Conceptually, the `zjquery` library provides minimal versions of most
|
||||
`jQuery` DOM manipulation functions, and has a convenient system for
|
||||
letting you setup return values for more complex functions. For
|
||||
letting you set up return values for more complex functions. For
|
||||
example, if the code you'd like to test calls `$obj.find()`, you can
|
||||
use `$obj.set_find_results(selector, $value)` to setup `zjquery` so
|
||||
use `$obj.set_find_results(selector, $value)` to set up `zjquery` so
|
||||
that calls to `$obj.find(selector)` will return `$value`. See the unit
|
||||
test file for details.
|
||||
|
||||
|
@ -175,7 +175,7 @@ notes for other editors are welcome!
|
|||
|
||||
These instructions assume you're using the Vagrant development environment.
|
||||
|
||||
1. Setup [Vagrant in WebStorm][vagrant-webstorm].
|
||||
1. Set up [Vagrant in WebStorm][vagrant-webstorm].
|
||||
|
||||
2. In WebStorm, navigate to `Preferences -> Tools -> Vagrant` and
|
||||
configure the following:
|
||||
|
@ -206,7 +206,7 @@ These instructions assume you're using the Vagrant development environment.
|
|||
1. Under `JavaScript file`, enter `frontend_tests/zjsunit/index.js`
|
||||
-- this is the root script for Zulip's node unit tests.
|
||||
|
||||
Congratulations! You've now setup the integration.
|
||||
Congratulations! You've now set up the integration.
|
||||
|
||||
## Running tests with the debugger
|
||||
|
||||
|
|
Loading…
Reference in New Issue