From 3b1cb0b25a9bef43d9ff417ed09263520678fae8 Mon Sep 17 00:00:00 2001 From: Eeshan Garg Date: Thu, 9 Sep 2021 18:16:29 -0400 Subject: [PATCH] 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. --- docs/conf.py | 7 ++++++- docs/production/install.md | 6 +++--- docs/production/upgrade-or-modify.md | 7 ++++--- 3 files changed, 13 insertions(+), 7 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 2d94b263c0..c561f067d2 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -20,7 +20,7 @@ from typing import Any, Dict, Optional # sys.path.insert(0, os.path.abspath('.')) 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 ------------------------------------------------ @@ -36,6 +36,7 @@ extensions = [ myst_enable_extensions = [ "colon_fence", + "substitution", ] # 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. todo_include_todos = False +myst_substitutions = { + "LATEST_RELEASE_VERSION": LATEST_RELEASE_VERSION, +} + # -- Options for HTML output ---------------------------------------------- diff --git a/docs/production/install.md b/docs/production/install.md index db9968f915..74ee1dd430 100644 --- a/docs/production/install.md +++ b/docs/production/install.md @@ -14,9 +14,9 @@ you can create a test organization at . ## Step 1: Download the latest release -Download and unpack [the latest built server -tarball](https://download.zulip.com/server/zulip-server-latest.tar.gz) -with the following commands: +Download and unpack [the latest server +release](https://download.zulip.com/server/zulip-server-latest.tar.gz) +(**Zulip Server {{ LATEST_RELEASE_VERSION }}**) with the following commands: ```bash cd $(mktemp -d) diff --git a/docs/production/upgrade-or-modify.md b/docs/production/upgrade-or-modify.md index 95b0d408ae..58fe49358d 100644 --- a/docs/production/upgrade-or-modify.md +++ b/docs/production/upgrade-or-modify.md @@ -24,8 +24,9 @@ to a new Zulip release: for all releases newer than what is currently installed. 1. Download the appropriate release tarball from - You can download the latest - release with: + . You can get the latest + release (**Zulip Server {{ LATEST_RELEASE_VERSION }}**) with the + following command: ```bash 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: ```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: