mirror of
https://github.com/zulip/zulip.git
synced 2025-10-23 04:52:12 +00:00
docs: Add comma to all uses of "e.g." in contributor docs.
This commit is contained in:
committed by
Tim Abbott
parent
2bb037f2a0
commit
62d452f983
@@ -171,7 +171,7 @@ actual flows for LDAP configuration.
|
||||
- To disable fakeldap, set `FAKE_LDAP_MODE` back to `None`.
|
||||
|
||||
- In all fakeldap configurations, users' fake LDAP passwords are equal
|
||||
to their usernames (e.g. for `ldapuser1@zulip.com`, the password is
|
||||
to their usernames (e.g., for `ldapuser1@zulip.com`, the password is
|
||||
`ldapuser1`).
|
||||
|
||||
- `FAKE_LDAP_NUM_USERS` in `zproject/dev_settings.py` can be used to
|
||||
|
@@ -151,7 +151,7 @@ guide][rtd-git-guide]. In brief, the steps are as follows.
|
||||
On your **local computer**:
|
||||
|
||||
1. Open _Terminal_ (macOS/Linux) or _Git for BASH_.
|
||||
2. Change directory to where you cloned Zulip (e.g. `cd zulip`).
|
||||
2. Change directory to where you cloned Zulip (e.g., `cd zulip`).
|
||||
3. Use `git add` and `git commit` to stage and commit your changes (if you
|
||||
haven't already).
|
||||
4. Push your commits to GitHub with `git push origin branchname`.
|
||||
@@ -282,7 +282,7 @@ Next, read the following to learn more about developing for Zulip:
|
||||
|
||||
## Using an nginx reverse proxy
|
||||
|
||||
For some applications (e.g. developing an OAuth2 integration for
|
||||
For some applications (e.g., developing an OAuth2 integration for
|
||||
Facebook), you may need your Zulip development to have a valid SSL
|
||||
certificate. While `run-dev` doesn't support that, you can do this
|
||||
with an `nginx` reverse proxy sitting in front of `run-dev`.
|
||||
|
@@ -132,7 +132,7 @@ installation method described here. We require version 0.67.6+ of WSL 2.
|
||||
$ sudo apt install rabbitmq-server memcached redis-server postgresql
|
||||
```
|
||||
|
||||
1. Open `/etc/rabbitmq/rabbitmq-env.conf` using e.g.:
|
||||
1. Open `/etc/rabbitmq/rabbitmq-env.conf` using e.g.,:
|
||||
|
||||
```console
|
||||
$ sudo nano /etc/rabbitmq/rabbitmq-env.conf
|
||||
@@ -955,7 +955,7 @@ The `vagrant up` command basically does the following:
|
||||
|
||||
To debug such errors, you can log in to the Vagrant guest machine by
|
||||
running `vagrant ssh`, which should present you with a standard shell
|
||||
prompt. You can debug interactively by using e.g.
|
||||
prompt. You can debug interactively by using e.g.,
|
||||
`cd zulip && ./tools/provision`, and then running the individual
|
||||
subcommands that failed. Once you've resolved the problem, you can
|
||||
rerun `tools/provision` to proceed; the provisioning system is
|
||||
@@ -1094,7 +1094,7 @@ NO_PROXY localhost,127.0.0.1,.example.com,.zulipdev.com
|
||||
```
|
||||
|
||||
For proxies that require authentication, the config will be a bit more
|
||||
complex, e.g.:
|
||||
complex, e.g.,:
|
||||
|
||||
```text
|
||||
HTTP_PROXY http://userName:userPassword@192.168.1.1:8080
|
||||
@@ -1119,7 +1119,7 @@ then do a `vagrant reload`.
|
||||
### Using a different port for Vagrant
|
||||
|
||||
You can also change the port on the host machine that Vagrant uses by
|
||||
adding to your `~/.zulip-vagrant-config` file. E.g. if you set:
|
||||
adding to your `~/.zulip-vagrant-config` file. E.g., if you set:
|
||||
|
||||
```text
|
||||
HOST_PORT 9971
|
||||
|
@@ -1,12 +1,12 @@
|
||||
If you ever want to recreate your development environment again from
|
||||
scratch (e.g. to test a change you've made to the provisioning
|
||||
scratch (e.g., to test a change you've made to the provisioning
|
||||
process, or because you think something is broken), you can do so
|
||||
using `vagrant destroy` and then `vagrant up`. This will usually be
|
||||
much faster than the original `vagrant up` since the base image is
|
||||
already cached on your machine (it takes about 5 minutes to run with a
|
||||
fast Internet connection).
|
||||
|
||||
Any additional programs (e.g. Zsh, emacs, etc.) or configuration that
|
||||
Any additional programs (e.g., Zsh, emacs, etc.) or configuration that
|
||||
you may have installed in the development environment will be lost
|
||||
when you recreate it. To address this, you can create a script called
|
||||
`tools/custom_provision` in your Zulip Git checkout; and place any
|
||||
|
@@ -62,7 +62,7 @@ branch, or a significant time has passed since you last used it.
|
||||
### Test an install
|
||||
|
||||
The `test-install` tooling takes a distribution release name
|
||||
(e.g. "jammy"), the path to an unpacked release directory
|
||||
(e.g., "jammy"), the path to an unpacked release directory
|
||||
or tarball, and then any of the normal options you want to pass down
|
||||
into the installer.
|
||||
|
||||
|
@@ -13,7 +13,7 @@ the development environment][authentication-dev-server].
|
||||
## Common
|
||||
|
||||
- Zulip's `main` branch moves quickly, and you should rebase
|
||||
constantly with e.g.
|
||||
constantly with e.g.,
|
||||
`git fetch upstream; git rebase upstream/main` to avoid developing
|
||||
on an old version of the Zulip codebase (leading to unnecessary
|
||||
merge conflicts).
|
||||
|
Reference in New Issue
Block a user