From 02eec294335d82bce92fdf1bfb0f43c8c598d99e Mon Sep 17 00:00:00 2001 From: David Rosa Date: Fri, 9 Sep 2022 20:31:23 -0400 Subject: [PATCH] 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. --- docs/development/index.md | 2 +- docs/development/overview.md | 6 +++--- docs/development/remote.md | 2 +- docs/development/setup-advanced.md | 8 ++++---- .../{setup-vagrant.md => setup-recommended.md} | 0 docs/git/cloning.md | 4 ++-- docs/git/setup.md | 2 +- tools/lib/provision.py | 2 +- tools/provision | 2 +- 9 files changed, 14 insertions(+), 14 deletions(-) rename docs/development/{setup-vagrant.md => setup-recommended.md} (100%) diff --git a/docs/development/index.md b/docs/development/index.md index 38e93839b4..a2aebff32c 100644 --- a/docs/development/index.md +++ b/docs/development/index.md @@ -6,7 +6,7 @@ maxdepth: 3 --- Development environment installation -Recommended setup +Recommended setup Advanced setup Using the development environment Developing remotely diff --git a/docs/development/overview.md b/docs/development/overview.md index 917524007e..0cac9679e5 100644 --- a/docs/development/overview.md +++ b/docs/development/overview.md @@ -77,11 +77,11 @@ machine, take a look at our tips for [dev-remote]: remote.md [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-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 [testing]: ../testing/testing.md [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 diff --git a/docs/development/remote.md b/docs/development/remote.md index eac8b7dbf5..5ec5e18f22 100644 --- a/docs/development/remote.md +++ b/docs/development/remote.md @@ -271,7 +271,7 @@ Next, read the following to learn more about developing for Zulip: - [Testing][rtd-testing] [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-using-dev-env]: using.md [rtd-testing]: ../testing/testing.md diff --git a/docs/development/setup-advanced.md b/docs/development/setup-advanced.md index f947a393ee..d2dee08119 100644 --- a/docs/development/setup-advanced.md +++ b/docs/development/setup-advanced.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 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). ## Installing using Vagrant with VirtualBox on Windows 10 :::{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. ::: @@ -101,7 +101,7 @@ $ git config core.symlinks 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 have not been enabled. @@ -124,7 +124,7 @@ $ echo $CYGWIN 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 will automatically set `git config core.symlink false` on a repository diff --git a/docs/development/setup-vagrant.md b/docs/development/setup-recommended.md similarity index 100% rename from docs/development/setup-vagrant.md rename to docs/development/setup-recommended.md diff --git a/docs/git/cloning.md b/docs/git/cloning.md index 4900ffde2d..fd3d63a862 100644 --- a/docs/git/cloning.md +++ b/docs/git/cloning.md @@ -100,7 +100,7 @@ source projects in general, we recommend following our [detailed guide for first-time contributors][zulip-rtd-dev-first-time]. 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 @@ -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-zulip]: https://github.com/zulip/zulip/ [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-tools-setup]: zulip-tools.md#set-up-git-repo-script diff --git a/docs/git/setup.md b/docs/git/setup.md index 38544b5ebe..b812498571 100644 --- a/docs/git/setup.md +++ b/docs/git/setup.md @@ -31,7 +31,7 @@ We also highly recommend the following: [Bash][gitbook-other-envs-bash] and [Zsh][gitbook-other-envs-zsh]. 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 diff --git a/tools/lib/provision.py b/tools/lib/provision.py index 339ce89bc1..d8e72766a2 100755 --- a/tools/lib/provision.py +++ b/tools/lib/provision.py @@ -69,7 +69,7 @@ except OSError: ) print("See this page for more information:") 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) diff --git a/tools/provision b/tools/provision index ee4f547c17..dae7578fdf 100755 --- a/tools/provision +++ b/tools/provision @@ -24,7 +24,7 @@ case "$os" in if [ -e /home/vagrant ]; then # shellcheck disable=SC2016 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 exit 1 ;;