mirror of https://github.com/zulip/zulip.git
docs: Rename setup-vagrant.md -> setup-recommended.md.
Renames the filename so that it accurately reflects its contents given the changes to the "Recommended setup" page in the previous commit, and updates all links accordingly.
This commit is contained in:
parent
cdc9a64c21
commit
02eec29433
|
@ -6,7 +6,7 @@ maxdepth: 3
|
||||||
---
|
---
|
||||||
|
|
||||||
Development environment installation <overview>
|
Development environment installation <overview>
|
||||||
Recommended setup <setup-vagrant>
|
Recommended setup <setup-recommended>
|
||||||
Advanced setup <setup-advanced>
|
Advanced setup <setup-advanced>
|
||||||
Using the development environment <using>
|
Using the development environment <using>
|
||||||
Developing remotely <remote>
|
Developing remotely <remote>
|
||||||
|
|
|
@ -77,11 +77,11 @@ machine, take a look at our tips for
|
||||||
|
|
||||||
[dev-remote]: remote.md
|
[dev-remote]: remote.md
|
||||||
[install-direct]: setup-advanced.md#installing-directly-on-ubuntu-debian-centos-or-fedora
|
[install-direct]: setup-advanced.md#installing-directly-on-ubuntu-debian-centos-or-fedora
|
||||||
[install-vagrant]: setup-vagrant.md
|
[install-vagrant]: setup-recommended.md
|
||||||
[self-install-remote]: #installing-remotely
|
[self-install-remote]: #installing-remotely
|
||||||
[self-slow-internet]: #slow-internet-connections
|
[self-slow-internet]: #slow-internet-connections
|
||||||
[configure-proxy]: setup-vagrant.md#specifying-a-proxy
|
[configure-proxy]: setup-recommended.md#specifying-a-proxy
|
||||||
[using-dev-env]: using.md
|
[using-dev-env]: using.md
|
||||||
[testing]: ../testing/testing.md
|
[testing]: ../testing/testing.md
|
||||||
[ci]: ../git/cloning.md#step-3-configure-continuous-integration-for-your-fork
|
[ci]: ../git/cloning.md#step-3-configure-continuous-integration-for-your-fork
|
||||||
[install-via-wsl]: setup-vagrant.md#windows-10
|
[install-via-wsl]: setup-recommended.md#windows-10
|
||||||
|
|
|
@ -271,7 +271,7 @@ Next, read the following to learn more about developing for Zulip:
|
||||||
- [Testing][rtd-testing]
|
- [Testing][rtd-testing]
|
||||||
|
|
||||||
[install-direct]: setup-advanced.md#installing-directly-on-ubuntu-debian-centos-or-fedora
|
[install-direct]: setup-advanced.md#installing-directly-on-ubuntu-debian-centos-or-fedora
|
||||||
[install-vagrant]: setup-vagrant.md
|
[install-vagrant]: setup-recommended.md
|
||||||
[rtd-git-guide]: ../git/index.md
|
[rtd-git-guide]: ../git/index.md
|
||||||
[rtd-using-dev-env]: using.md
|
[rtd-using-dev-env]: using.md
|
||||||
[rtd-testing]: ../testing/testing.md
|
[rtd-testing]: ../testing/testing.md
|
||||||
|
|
|
@ -50,13 +50,13 @@ source /srv/zulip-py3-venv/bin/activate
|
||||||
|
|
||||||
Once you've done the above setup, you can pick up the [documentation
|
Once you've done the above setup, you can pick up the [documentation
|
||||||
on using the Zulip development
|
on using the Zulip development
|
||||||
environment](setup-vagrant.md#step-4-developing),
|
environment](setup-recommended.md#step-4-developing),
|
||||||
ignoring the parts about `vagrant` (since you're not using it).
|
ignoring the parts about `vagrant` (since you're not using it).
|
||||||
|
|
||||||
## Installing using Vagrant with VirtualBox on Windows 10
|
## Installing using Vagrant with VirtualBox on Windows 10
|
||||||
|
|
||||||
:::{note}
|
:::{note}
|
||||||
We recommend using [WSL 2 for Windows development](setup-vagrant.md#windows-10)
|
We recommend using [WSL 2 for Windows development](setup-recommended.md#windows-10)
|
||||||
because it is easier to set up and provides a substantially better experience.
|
because it is easier to set up and provides a substantially better experience.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
|
@ -101,7 +101,7 @@ $ git config core.symlinks
|
||||||
true
|
true
|
||||||
```
|
```
|
||||||
|
|
||||||
If you see `true`, you are ready for [Step 2: Get Zulip code](setup-vagrant.md#step-2-get-zulip-code).
|
If you see `true`, you are ready for [Step 2: Get Zulip code](setup-recommended.md#step-2-get-zulip-code).
|
||||||
|
|
||||||
Otherwise, if the above command prints `false` or nothing at all, then symlinks
|
Otherwise, if the above command prints `false` or nothing at all, then symlinks
|
||||||
have not been enabled.
|
have not been enabled.
|
||||||
|
@ -124,7 +124,7 @@ $ echo $CYGWIN
|
||||||
winsymlinks:native
|
winsymlinks:native
|
||||||
```
|
```
|
||||||
|
|
||||||
Now you are ready for [Step 2: Get Zulip code](setup-vagrant.md#step-2-get-zulip-code).
|
Now you are ready for [Step 2: Get Zulip code](setup-recommended.md#step-2-get-zulip-code).
|
||||||
|
|
||||||
(Note: The **GitHub Desktop client** for Windows has a bug where it
|
(Note: The **GitHub Desktop client** for Windows has a bug where it
|
||||||
will automatically set `git config core.symlink false` on a repository
|
will automatically set `git config core.symlink false` on a repository
|
||||||
|
|
|
@ -100,7 +100,7 @@ source projects in general, we recommend following our [detailed guide for
|
||||||
first-time contributors][zulip-rtd-dev-first-time].
|
first-time contributors][zulip-rtd-dev-first-time].
|
||||||
|
|
||||||
If you are in the middle of installing the recommended setup on Windows 10,
|
If you are in the middle of installing the recommended setup on Windows 10,
|
||||||
you are ready to [continue with step 8](../development/setup-vagrant.md#windows-10).
|
you are ready to [continue with step 8](../development/setup-recommended.md#windows-10).
|
||||||
|
|
||||||
## Step 3: Configure continuous integration for your fork
|
## Step 3: Configure continuous integration for your fork
|
||||||
|
|
||||||
|
@ -138,6 +138,6 @@ You can check the `Actions` tab of your repository to see the builds.
|
||||||
[github-zulip]: https://github.com/zulip/
|
[github-zulip]: https://github.com/zulip/
|
||||||
[github-zulip-zulip]: https://github.com/zulip/zulip/
|
[github-zulip-zulip]: https://github.com/zulip/zulip/
|
||||||
[github-actions]: https://docs.github.com/en/actions
|
[github-actions]: https://docs.github.com/en/actions
|
||||||
[zulip-rtd-dev-first-time]: ../development/setup-vagrant.md
|
[zulip-rtd-dev-first-time]: ../development/setup-recommended.md
|
||||||
[zulip-rtd-dev-overview]: ../development/overview.md
|
[zulip-rtd-dev-overview]: ../development/overview.md
|
||||||
[zulip-rtd-tools-setup]: zulip-tools.md#set-up-git-repo-script
|
[zulip-rtd-tools-setup]: zulip-tools.md#set-up-git-repo-script
|
||||||
|
|
|
@ -31,7 +31,7 @@ We also highly recommend the following:
|
||||||
[Bash][gitbook-other-envs-bash] and [Zsh][gitbook-other-envs-zsh].
|
[Bash][gitbook-other-envs-bash] and [Zsh][gitbook-other-envs-zsh].
|
||||||
|
|
||||||
If you are installing the Zulip development environment, now you are ready to
|
If you are installing the Zulip development environment, now you are ready to
|
||||||
continue with [Step 1: Install prerequisites](../development/setup-vagrant.md#step-1-install-prerequisites).
|
continue with [Step 1: Install prerequisites](../development/setup-recommended.md#step-1-install-prerequisites).
|
||||||
|
|
||||||
## Get a graphical client
|
## Get a graphical client
|
||||||
|
|
||||||
|
|
|
@ -69,7 +69,7 @@ except OSError:
|
||||||
)
|
)
|
||||||
print("See this page for more information:")
|
print("See this page for more information:")
|
||||||
print(
|
print(
|
||||||
" https://zulip.readthedocs.io/en/latest/development/setup-vagrant.html#os-symlink-error"
|
" https://zulip.readthedocs.io/en/latest/development/setup-recommended.html#os-symlink-error"
|
||||||
)
|
)
|
||||||
sys.exit(1)
|
sys.exit(1)
|
||||||
|
|
||||||
|
|
|
@ -24,7 +24,7 @@ case "$os" in
|
||||||
if [ -e /home/vagrant ]; then
|
if [ -e /home/vagrant ]; then
|
||||||
# shellcheck disable=SC2016
|
# shellcheck disable=SC2016
|
||||||
echo 'To upgrade, run `vagrant destroy`, and then recreate the Vagrant guest.' >&2
|
echo 'To upgrade, run `vagrant destroy`, and then recreate the Vagrant guest.' >&2
|
||||||
echo 'See: https://zulip.readthedocs.io/en/latest/development/setup-vagrant.html' >&2
|
echo 'See: https://zulip.readthedocs.io/en/latest/development/setup-recommended.html' >&2
|
||||||
fi
|
fi
|
||||||
exit 1
|
exit 1
|
||||||
;;
|
;;
|
||||||
|
|
Loading…
Reference in New Issue