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

docs: Migrate from recommonmark to MyST-Parser.

Browse Source 
Recommonmark is no longer maintained, and MyST-Parser is much more
complete.

https://myst-parser.readthedocs.io/

Signed-off-by: Anders Kaseorg <anders@zulip.com>
This commit is contained in:
Anders Kaseorg
2021-08-09 22:55:12 -07:00
committed by Tim Abbott
parent 8f2827a65d
commit 672358c5da
24 changed files with 178 additions and 165 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,4 +1,4 @@
```eval_rst
```{eval-rst}
:orphan:
```

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

@@ -26,12 +26,11 @@ If you are using a [remote server](../development/remote.md), see
the
[section on creating appropriate user accounts](../development/remote.html#setting-up-user-accounts).
```eval_rst
.. warning::
There is no supported uninstallation process with this
method. If you want that, use the Vagrant environment, where you can
just do ``vagrant destroy`` to clean up the development environment.
```
:::{warning}
There is no supported uninstallation process with this
method. If you want that, use the Vagrant environment, where you can
just do `vagrant destroy` to clean up the development environment.
:::
Start by [cloning your fork of the Zulip repository][zulip-rtd-git-cloning]
and [connecting the Zulip upstream repository][zulip-rtd-git-connect]:
@@ -120,11 +119,10 @@ installation method described here.
./tools/run-dev.py
```
```eval_rst
.. note::
If you shut down WSL, after starting it again, you will have to manually start
the services using ``./tools/wsl/start_services``.
```
:::{note}
If you shut down WSL, after starting it again, you will have to manually start
the services using `./tools/wsl/start_services`.
:::
1. If you are facing problems or you see error messages after running `./tools/run-dev.py`,
you can try running `./tools/provision` again.
@@ -217,12 +215,11 @@ expected.
Make sure you note down this down. This is where your zulip development web
server can be accessed.
```eval_rst
.. important::
The output of the above command changes every time you restart the Vagrant
development machine. Thus, it will have to be run every time you bring one up.
This quirk is one reason this method is marked experimental.
```
:::{important}
The output of the above command changes every time you restart the Vagrant
development machine. Thus, it will have to be run every time you bring one up.
This quirk is one reason this method is marked experimental.
:::
1. You should now be able to start the Zulip development server.

7
docs/development/setup-vagrant.md
View File

@@ -162,10 +162,9 @@ Debian](https://docs.docker.com/install/linux/docker-ce/debian/).
#### Windows 10
```eval_rst
.. note::
We recommend using `WSL 2 for Windows development <../development/setup-advanced.html#installing-directly-on-windows-10-with-wsl-2>`_.
```
:::{note}
We recommend using [WSL 2 for Windows development](../development/setup-advanced.html#installing-directly-on-windows-10-with-wsl-2).
:::
1. Install [Git for Windows][git-bash], which installs *Git BASH*.
2. Install [VirtualBox][vbox-dl] (latest).