From 08e9686cd28140523ed80994197d4d35521c0766 Mon Sep 17 00:00:00 2001 From: David Rosa Date: Mon, 16 Jan 2023 20:33:42 -0700 Subject: [PATCH] contributor docs: Rename "Upgrade or modify Zulip" -> "Upgrade Zulip". Fixes part of #23984. --- docs/_templates/layout.html | 2 +- docs/overview/changelog.md | 4 ++-- docs/overview/release-lifecycle.md | 6 +++--- docs/production/authentication-methods.md | 2 +- docs/production/deployment.md | 6 +++--- docs/production/export-and-import.md | 2 +- docs/production/index.md | 2 +- docs/production/install.md | 2 +- docs/production/maintain-secure-upgrade.md | 6 +++--- docs/production/modify.md | 4 ++-- docs/production/postgresql.md | 2 +- docs/production/requirements.md | 4 ++-- docs/production/settings.md | 4 ++-- docs/production/{upgrade-or-modify.md => upgrade.md} | 2 +- docs/subsystems/settings.md | 2 +- 15 files changed, 25 insertions(+), 25 deletions(-) rename docs/production/{upgrade-or-modify.md => upgrade.md} (99%) diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html index d5499e4591..5b9bb76422 100644 --- a/docs/_templates/layout.html +++ b/docs/_templates/layout.html @@ -30,7 +30,7 @@ # version e.g. to say that something is likely to have changed. # For more info see: https://www.sphinx-doc.org/en/master/templating.html #} - {% if pagename in ["production/modify"] and release.endswith('+git') %} + {% if pagename in ["production/modify", "production/upgrade"] and release.endswith('+git') %} {# # This page doesn't exist in the stable documentation yet. # This temporary workaround prevents test failures and should be removed after the next release. diff --git a/docs/overview/changelog.md b/docs/overview/changelog.md index 977aaf71cd..aa59a79f77 100644 --- a/docs/overview/changelog.md +++ b/docs/overview/changelog.md @@ -964,7 +964,7 @@ log][commit-log] for an up-to-date list of all changes. [docker-zulip-manual]: https://github.com/zulip/docker-zulip#manual-configuration [smokescreen]: ../production/deployment.md#customizing-the-outgoing-http-proxy -[update-settings-docs]: ../production/upgrade-or-modify.md#updating-settingspy-inline-documentation +[update-settings-docs]: ../production/upgrade.md#updating-settingspy-inline-documentation #### Full feature changelog @@ -1253,7 +1253,7 @@ log][commit-log] for an up-to-date list of all changes. Upgrade notes for all releases one is upgrading across. [manage-shell]: ../production/management-commands.md#managepy-shell -[postgresql-upgrade]: ../production/upgrade-or-modify.md#upgrading-postgresql +[postgresql-upgrade]: ../production/upgrade.md#upgrading-postgresql #### Full feature changelog diff --git a/docs/overview/release-lifecycle.md b/docs/overview/release-lifecycle.md index bf15cefceb..7946261312 100644 --- a/docs/overview/release-lifecycle.md +++ b/docs/overview/release-lifecycle.md @@ -86,7 +86,7 @@ in a stable release. A Zulip design goal is for there never to be a reason to run an old version of Zulip. We work extremely hard to make sure Zulip is stable for self-hosters, has no regressions, and that the [Zulip upgrade -process](../production/upgrade-or-modify.md) Just Works. +process](../production/upgrade.md) Just Works. The Zulip server and clients apps are all carefully engineered to ensure compatibility with old versions. In particular: @@ -108,7 +108,7 @@ release series except in rare cases involving a security issue or critical bug just after publishing a major release. [blog-major-releases]: https://blog.zulip.com/tag/major-releases/ -[upgrade-from-git]: ../production/upgrade-or-modify.md#upgrading-from-a-git-repository +[upgrade-from-git]: ../production/upgrade.md#upgrading-from-a-git-repository ### Security releases @@ -228,7 +228,7 @@ independently as needed. [electron]: https://www.electronjs.org/ [upgrading-to-main]: ../production/modify.md#upgrading-to-main -[os-upgrade]: ../production/upgrade-or-modify.md#upgrading-the-operating-system +[os-upgrade]: ../production/upgrade.md#upgrading-the-operating-system [chat-zulip-org]: https://zulip.com/development-community/ [fork-zulip]: ../production/modify.md [zulip-server]: https://github.com/zulip/zulip diff --git a/docs/production/authentication-methods.md b/docs/production/authentication-methods.md index e93a731f7d..dcbe82df35 100644 --- a/docs/production/authentication-methods.md +++ b/docs/production/authentication-methods.md @@ -888,4 +888,4 @@ passwordless login as any user in a development environment. It's mentioned on this page only for completeness. [custom-profile-fields]: https://zulip.com/help/custom-profile-fields -[update-inline-comments]: upgrade-or-modify.md#updating-settingspy-inline-documentation +[update-inline-comments]: upgrade.md#updating-settingspy-inline-documentation diff --git a/docs/production/deployment.md b/docs/production/deployment.md index db13db0fbb..12216ca39a 100644 --- a/docs/production/deployment.md +++ b/docs/production/deployment.md @@ -19,7 +19,7 @@ git clone https://github.com/zulip/zulip.git zulip-server-git and then [continue the normal installation instructions](install.md#step-2-install-zulip). -You can also [upgrade Zulip from Git](upgrade-or-modify.md#upgrading-from-a-git-repository). +You can also [upgrade Zulip from Git](upgrade.md#upgrading-from-a-git-repository). The most common use case for this is upgrading to `main` to get a feature that hasn't made it into an official release yet (often @@ -646,7 +646,7 @@ for servers that are upgraded frequently by core Zulip developers. #### `git_repo_url` Default repository URL used when [upgrading from a Git -repository](upgrade-or-modify.md#upgrading-from-a-git-repository). +repository](upgrade.md#upgrading-from-a-git-repository). ### `[application_server]` @@ -783,7 +783,7 @@ for potential values. #### `version` The version of PostgreSQL that is in use. Do not set by hand; use the -[PostgreSQL upgrade tool](upgrade-or-modify.md#upgrading-postgresql). +[PostgreSQL upgrade tool](upgrade.md#upgrading-postgresql). ### `[memcached]` diff --git a/docs/production/export-and-import.md b/docs/production/export-and-import.md index 9d7b0ed1f2..0ab23a931e 100644 --- a/docs/production/export-and-import.md +++ b/docs/production/export-and-import.md @@ -361,7 +361,7 @@ cd /home/zulip/deployments/current This could take several minutes to run depending on how much data you're importing. -[upgrade-zulip-from-git]: upgrade-or-modify.md#upgrading-from-a-git-repository +[upgrade-zulip-from-git]: upgrade.md#upgrading-from-a-git-repository #### Import options diff --git a/docs/production/index.md b/docs/production/index.md index b447beb7df..8ba71de3ab 100644 --- a/docs/production/index.md +++ b/docs/production/index.md @@ -11,7 +11,7 @@ troubleshooting management-commands settings mobile-push-notifications -upgrade-or-modify +upgrade modify security-model authentication-methods diff --git a/docs/production/install.md b/docs/production/install.md index 95c4b2db70..9fbf2e1d6c 100644 --- a/docs/production/install.md +++ b/docs/production/install.md @@ -133,7 +133,7 @@ Learning more: - Follow [Zulip on Twitter](https://twitter.com/zulip). - Learn how to [configure your Zulip server settings](settings.md). - Learn about [Backups, export and import](export-and-import.md) - and [upgrading](upgrade-or-modify.md) a production Zulip + and [upgrading](upgrade.md) a production Zulip server. [realm-admin-docs]: https://zulip.com/help/getting-your-organization-started-with-zulip diff --git a/docs/production/maintain-secure-upgrade.md b/docs/production/maintain-secure-upgrade.md index 352bc78331..3fcd4fe206 100644 --- a/docs/production/maintain-secure-upgrade.md +++ b/docs/production/maintain-secure-upgrade.md @@ -17,17 +17,17 @@ Moved to [Security model](security-model.md). ### Upgrading -Moved to [Upgrading to a release](upgrade-or-modify.md#upgrading-to-a-release). +Moved to [Upgrading to a release](upgrade.md#upgrading-to-a-release). ### Upgrading from a Git repository Moved to [Upgrading from a Git -repository](upgrade-or-modify.md#upgrading-from-a-git-repository). +repository](upgrade.md#upgrading-from-a-git-repository). ### Upgrading the operating system Moved to [Upgrading the operating -system](upgrade-or-modify.md#upgrading-the-operating-system). +system](upgrade.md#upgrading-the-operating-system). ### Scalability diff --git a/docs/production/modify.md b/docs/production/modify.md index e0f7aee6a0..263df54eba 100644 --- a/docs/production/modify.md +++ b/docs/production/modify.md @@ -86,7 +86,7 @@ across future Zulip releases. Eventually, you'll want to upgrade to a new Zulip release. If your changes were integrated into that Zulip release or are otherwise no longer needed, you can just [upgrade as -usual](upgrade-or-modify.md#upgrading-to-a-release). If you [upgraded to +usual](upgrade.md#upgrading-to-a-release). If you [upgraded to `main`](#upgrading-to-main); review that section again; new maintenance releases are likely "older" than your current installation and you might need to upgrade to `main` again rather than to the @@ -236,6 +236,6 @@ other organizations, consider [contributing them](../contributing/contributing.md). [fork-clone]: ../git/cloning.md#get-zulip-code -[upgrade-zulip-from-git]: ./upgrade-or-modify.md#upgrading-from-a-git-repository +[upgrade-zulip-from-git]: ./upgrade.md#upgrading-from-a-git-repository [git-guide]: ../git/index.md [zulip/zulip]: https://github.com/zulip/zulip/ diff --git a/docs/production/postgresql.md b/docs/production/postgresql.md index 23c75c9d86..1a19d9571f 100644 --- a/docs/production/postgresql.md +++ b/docs/production/postgresql.md @@ -10,7 +10,7 @@ included with the base operating system (E.g. PostgreSQL 12 on Ubuntu PostgreSQL releases [upgrade to PostgreSQL 14][upgrade-postgresql], as we may drop support for older PostgreSQL in a future release. -[upgrade-postgresql]: upgrade-or-modify.md#upgrading-postgresql +[upgrade-postgresql]: upgrade.md#upgrading-postgresql #### Remote PostgreSQL database diff --git a/docs/production/requirements.md b/docs/production/requirements.md index 3ec6f5d34f..4506ab79b1 100644 --- a/docs/production/requirements.md +++ b/docs/production/requirements.md @@ -19,7 +19,7 @@ To run a Zulip server, you will need: For details on each of these requirements, see below. -[upgrade-from-git]: upgrade-or-modify.md#upgrading-from-a-git-repository +[upgrade-from-git]: upgrade.md#upgrading-from-a-git-repository ## Server @@ -55,7 +55,7 @@ sudo apt update ``` [docker-zulip-homepage]: https://github.com/zulip/docker-zulip#readme -[upgrade-os]: upgrade-or-modify.md#upgrading-the-operating-system +[upgrade-os]: upgrade.md#upgrading-the-operating-system [ubuntu-repositories]: https://help.ubuntu.com/community/Repositories/Ubuntu [enable-universe]: https://help.ubuntu.com/community/Repositories/CommandLine#Adding_the_Universe_and_Multiverse_Repositories diff --git a/docs/production/settings.md b/docs/production/settings.md index ac0320e3a3..2ba8fc2993 100644 --- a/docs/production/settings.md +++ b/docs/production/settings.md @@ -28,7 +28,7 @@ from an old version of Zulip, we recommend [carefully updating your comment documentation for new configuration settings after upgrading to each new major release. -[update-settings-docs]: upgrade-or-modify.md#updating-settingspy-inline-documentation +[update-settings-docs]: upgrade.md#updating-settingspy-inline-documentation [settings-py-template]: https://github.com/zulip/zulip/blob/main/zproject/prod_settings_template.py Since Zulip's settings file is a Python script, there are a number of @@ -133,4 +133,4 @@ Zulip documentation cover everything anyone might want to know about running Zulip in production. Next: [Backups, export and import](export-and-import.md) and -[upgrading](upgrade-or-modify.md) Zulip in production. +[upgrading](upgrade.md) Zulip in production. diff --git a/docs/production/upgrade-or-modify.md b/docs/production/upgrade.md similarity index 99% rename from docs/production/upgrade-or-modify.md rename to docs/production/upgrade.md index 3668dc0fea..a1091194e0 100644 --- a/docs/production/upgrade-or-modify.md +++ b/docs/production/upgrade.md @@ -1,4 +1,4 @@ -# Upgrade or modify Zulip +# Upgrade Zulip This page explains how to upgrade Zulip, including: diff --git a/docs/subsystems/settings.md b/docs/subsystems/settings.md index fb4e88d98f..af7301ceb0 100644 --- a/docs/subsystems/settings.md +++ b/docs/subsystems/settings.md @@ -62,7 +62,7 @@ In a production environment, we have: is the main documentation for Zulip settings, we recommend that production installations [carefully update `/etc/zulip/settings.py` every major - release](../production/upgrade-or-modify.md#updating-settingspy-inline-documentation) + release](../production/upgrade.md#updating-settingspy-inline-documentation) to pick up new inline documentation. - `/etc/zulip/zulip-secrets.conf` (generated by