paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-03 05:23:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

run-dev: Drop .py from script name.

Browse Source 
Signed-off-by: Anders Kaseorg <anders@zulip.com>
This commit is contained in:
Anders Kaseorg
2023-03-03 17:17:54 -08:00
parent 5a79ca251b
commit 43b4f10578
27 changed files with 47 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/development/remote.md
View File

@@ -62,7 +62,7 @@ The main difference from the standard instructions is that for a
remote development environment, and you're not using our Digital Ocean
Droplet infrastructure (which handles `EXTERNAL_HOST` for you), you'll
need to run `export EXTERNAL_HOST=<REMOTE_IP>:9991` in a shell before
running `run-dev.py` (and see also the `--interface=''` option
running `run-dev` (and see also the `--interface=''` option
documented below).
If your server has a static IP address, we recommend putting this
@@ -77,7 +77,7 @@ development server with the following command in the directory where
you cloned Zulip:
```bash
./tools/run-dev.py --interface=''
./tools/run-dev --interface=''
```
This will start up the Zulip server on port 9991. You can then
@@ -284,8 +284,8 @@ Next, read the following to learn more about developing for Zulip:
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.py` doesn't support that, you can do this
with an `nginx` reverse proxy sitting in front of `run-dev.py`.
certificate. While `run-dev` doesn't support that, you can do this
with an `nginx` reverse proxy sitting in front of `run-dev`.
The following instructions assume you have a Zulip Droplet working and
that the user is `zulipdev`; edit accordingly if the situation is
@@ -320,5 +320,5 @@ different.
1. Start the Zulip development environment with the following command:
```bash
env EXTERNAL_HOST="hostname.example.com" ./tools/run-dev.py --interface=''
env EXTERNAL_HOST="hostname.example.com" ./tools/run-dev --interface=''
```

2
docs/development/request-remote.md
View File

@@ -61,7 +61,7 @@ Once your remote dev instance is ready:
(Terminal for macOS and Linux, Bash for Git on Windows).
- There is no password; your account is configured to use your SSH keys.
- Once you log in, you should see `(zulip-py3-venv) ~$`.
- To start the dev server, `cd zulip` and then run `./tools/run-dev.py`.
- To start the dev server, `cd zulip` and then run `./tools/run-dev`.
- While the dev server is running, you can see the Zulip server in your browser
at http://zulip.username.zulipdev.org:9991.
- The development server actually runs on all subdomains of

6
docs/development/setup-advanced.md
View File

@@ -44,7 +44,7 @@ git remote add -f upstream https://github.com/zulip/zulip.git
# From a clone of zulip.git
./tools/provision
source /srv/zulip-py3-venv/bin/activate
./tools/run-dev.py # starts the development server
./tools/run-dev # starts the development server
```
Once you've done the above setup, you can pick up the [documentation
@@ -223,7 +223,7 @@ expected.
1. You should now be able to start the Zulip development server.
```console
(zulip-py3-venv) vagrant@ubuntu-18:/srv/zulip$ ./tools/run-dev.py
(zulip-py3-venv) vagrant@ubuntu-18:/srv/zulip$ ./tools/run-dev
```
The output will look like:
@@ -255,7 +255,7 @@ expected.
programs after the provisioning is completed. If it still isn't
enough, try restarting your system and running the command again.
2. Be patient the first time you run `./tools/run-dev.py`.
2. Be patient the first time you run `./tools/run-dev`.
As with other installation methods, please visit [#provision
help][provision-help] in the [Zulip development community

18
docs/development/setup-recommended.md
View File

@@ -232,7 +232,7 @@ installation method described here.
# Enter the Zulip Python environment
source /srv/zulip-py3-venv/bin/activate
# Start the development server
./tools/run-dev.py
./tools/run-dev
```
:::{note}
@@ -240,7 +240,7 @@ installation method described here.
the services using `./tools/wsl/start_services`.
:::
1. If you are facing problems or you see error messages after running `./tools/run-dev.py`,
1. If you are facing problems or you see error messages after running `./tools/run-dev`,
you can try running `./tools/provision` again.
1. The [Visual Studio Code Remote -
@@ -373,7 +373,7 @@ Next, start the Zulip server:
```console
(zulip-py3-venv) vagrant@vagrant:/srv/zulip
$ ./tools/run-dev.py
$ ./tools/run-dev
```
You will see several lines of output starting with something like:
@@ -448,13 +448,13 @@ run `tools/lint` often to make sure you're following our coding style
(or use `tools/setup-git-repo` to run it on just the changed files
automatically whenever you commit).
#### Understanding run-dev.py debugging output
#### Understanding run-dev debugging output
It's good to have the terminal running `./tools/run-dev.py` up as you work since error
It's good to have the terminal running `./tools/run-dev` up as you work since error
messages including tracebacks along with every backend request will be printed
there.
See [Logging](../subsystems/logging.md) for further details on the run-dev.py console
See [Logging](../subsystems/logging.md) for further details on the run-dev console
output.
#### Committing and pushing changes with Git
@@ -511,10 +511,10 @@ To shut down but preserve the development environment so you can use
it again later use `vagrant halt` or `vagrant suspend`.
You can do this from the same Terminal/Git BASH window that is running
run-dev.py by pressing ^C to halt the server and then typing `exit`. Or you
run-dev by pressing ^C to halt the server and then typing `exit`. Or you
can halt vagrant from another Terminal/Git BASH window.
From the window where run-dev.py is running:
From the window where run-dev is running:
```console
2016-05-04 18:33:13,330 INFO 127.0.0.1 GET 200 92ms /register/ (unauth@zulip via ?)
@@ -559,7 +559,7 @@ $ vagrant up
$ vagrant ssh
(zulip-py3-venv) vagrant@vagrant:/srv/zulip
$ ./tools/run-dev.py
$ ./tools/run-dev
```
### Next steps

6
docs/development/using.md
View File

@@ -42,7 +42,7 @@ the development environment][authentication-dev-server].
- The main Django/Tornado server processes are run on top of
Django's [manage.py runserver][django-runserver], which will
automatically restart them when you save changes to Python code
they use. You can watch this happen in the `run-dev.py` console
they use. You can watch this happen in the `run-dev` console
to make sure the backend has reloaded.
- The Python queue workers will also automatically restart when you
save changes, as long as they haven't crashed (which can happen if
@@ -51,7 +51,7 @@ the development environment][authentication-dev-server].
to use the [Django migrations
process](../subsystems/schema-migrations.md); see also the [new
feature tutorial][new-feature-tutorial] for an example.
- While testing server changes, it's helpful to watch the `run-dev.py`
- While testing server changes, it's helpful to watch the `run-dev`
console output, which will show tracebacks for any 500 errors your
Zulip development server encounters (which are probably caused by
bugs in your code).
@@ -63,7 +63,7 @@ the development environment][authentication-dev-server].
## Web
- Once the development server (`run-dev.py`) is running, you can visit
- Once the development server (`run-dev`) is running, you can visit
<http://localhost:9991/> in your browser.
- By default, the development server homepage just shows a list of the
users that exist on the server and you can log in as any of them by