Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: Indicate latest Zulip version in installation and upgrade docs. 

With copy-editing from tabbott, and also a migration to use
LATEST_RELEASE_VERSION, which will be correct even on the /latest/
paths.

Fixes #19695.
This commit is contained in:
Eeshan Garg 2021-09-09 18:16:29 -04:00 committed by Tim Abbott
parent 270a082ecb
commit 3b1cb0b25a
3 changed files with 13 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/conf.py
View File

@ -20,7 +20,7 @@ from typing import Any, Dict, Optional
# sys.path.insert(0, os.path.abspath('.')) # sys.path.insert(0, os.path.abspath('.'))
sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), ".."))) sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), "..")))
from version import ZULIP_VERSION from version import LATEST_RELEASE_VERSION, ZULIP_VERSION
# -- General configuration ------------------------------------------------ # -- General configuration ------------------------------------------------
@ -36,6 +36,7 @@ extensions = [
myst_enable_extensions = [ myst_enable_extensions = [
"colon_fence", "colon_fence",
"substitution",
] ]
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
@ -105,6 +106,10 @@ pygments_style = "sphinx"
# If true, `todo` and `todoList` produce output, else they produce nothing. # If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False todo_include_todos = False
myst_substitutions = {
"LATEST_RELEASE_VERSION": LATEST_RELEASE_VERSION,
}
# -- Options for HTML output ---------------------------------------------- # -- Options for HTML output ----------------------------------------------

6
docs/production/install.md
View File

@ -14,9 +14,9 @@ you can create a test organization at <https://zulip.com/new>.
## Step 1: Download the latest release ## Step 1: Download the latest release
Download and unpack [the latest built server Download and unpack [the latest server
tarball](https://download.zulip.com/server/zulip-server-latest.tar.gz) release](https://download.zulip.com/server/zulip-server-latest.tar.gz)
with the following commands: (**Zulip Server {{ LATEST_RELEASE_VERSION }}**) with the following commands:
```bash ```bash
cd $(mktemp -d) cd $(mktemp -d)

7
docs/production/upgrade-or-modify.md
View File

@ -24,8 +24,9 @@ to a new Zulip release:
for all releases newer than what is currently installed. for all releases newer than what is currently installed.
1. Download the appropriate release tarball from 1. Download the appropriate release tarball from
<https://download.zulip.com/server/> You can download the latest <https://download.zulip.com/server/>. You can get the latest
release with: release (**Zulip Server {{ LATEST_RELEASE_VERSION }}**) with the
following command:
```bash ```bash
curl -fLO https://download.zulip.com/server/zulip-server-latest.tar.gz curl -fLO https://download.zulip.com/server/zulip-server-latest.tar.gz
@ -40,7 +41,7 @@ to a new Zulip release:
1. Log in to your Zulip and run as root: 1. Log in to your Zulip and run as root:
```bash ```bash
/home/zulip/deployments/current/scripts/upgrade-zulip zulip-server-VERSION.tar.gz /home/zulip/deployments/current/scripts/upgrade-zulip zulip-server-latest.tar.gz
``` ```
The upgrade process will: The upgrade process will: