From 75f6d543bbc377efbd57e7497fe172838d610d4c Mon Sep 17 00:00:00 2001 From: Lauryn Menard Date: Tue, 30 Sep 2025 16:51:23 +0200 Subject: [PATCH] docs: Rename "security-model.md" to "securing-your-zulip-server.md". Updates relative links and any "security-model" label for ref links. (cherry picked from commit 04275d8e1477b3fac22aa20828b35de94083ce00) --- SECURITY.md | 4 ++-- docs/_templates/layout.html | 2 +- docs/overview/architecture-overview.md | 2 +- docs/overview/changelog.md | 2 +- docs/overview/release-lifecycle.md | 4 ++-- docs/production/index.md | 2 +- docs/production/maintain-secure-upgrade.md | 2 +- docs/production/password-strength.md | 2 +- .../{security-model.md => securing-your-zulip-server.md} | 0 docs/production/upload-backends.md | 2 +- 10 files changed, 11 insertions(+), 11 deletions(-) rename docs/production/{security-model.md => securing-your-zulip-server.md} (100%) diff --git a/SECURITY.md b/SECURITY.md index 7c6bbd6657..928185efda 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -11,7 +11,7 @@ response within 24 hours. Please include details on the issue and how you'd like to be credited in our release notes when we publish the fix. -Our [security model][security-model] document may be a helpful +Our [security model][securing-your-zulip-server] document may be a helpful resource. ## Security announcements @@ -32,6 +32,6 @@ reason to run older major releases. See also our documentation on the [Zulip release lifecycle][release-lifecycle]. -[security-model]: https://zulip.readthedocs.io/en/latest/production/security-model.html +[securing-your-zulip-server]: https://zulip.readthedocs.io/en/latest/production/securing-your-zulip-server.html [upgrades]: https://zulip.readthedocs.io/en/stable/production/upgrade.html#upgrading-to-a-release [release-lifecycle]: https://zulip.readthedocs.io/en/latest/overview/release-lifecycle.html diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html index 4217f0bf1b..067fc840d7 100644 --- a/docs/_templates/layout.html +++ b/docs/_templates/layout.html @@ -6,7 +6,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/system-configuration", "production/reverse-proxies"] and release.endswith('+git') %} + {% if pagename in ["production/securing-your-zulip-server"] 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/architecture-overview.md b/docs/overview/architecture-overview.md index dd013b04be..fa1d0d329a 100644 --- a/docs/overview/architecture-overview.md +++ b/docs/overview/architecture-overview.md @@ -53,7 +53,7 @@ means that one person might be a user of multiple Zulip realms. The administrators of an organization have a great deal of control over who can register an account, what permissions new users have, etc. For more on security considerations and options, see [the security model -section](../production/security-model.md) and the [Zulip help +section](../production/securing-your-zulip-server.md) and the [Zulip help center](https://zulip.com/help/). ## Components diff --git a/docs/overview/changelog.md b/docs/overview/changelog.md index 563193ec94..455658eb39 100644 --- a/docs/overview/changelog.md +++ b/docs/overview/changelog.md @@ -1958,7 +1958,7 @@ _Released 2023-01-23_ - Updated the Intercom integration to return success on `HEAD` requests, which it uses to verify its configuration. - Documented how each - [rate limit](../production/security-model.md#rate-limiting) + [rate limit](../production/securing-your-zulip-server.md#rate-limiting) category is used. - Documented the `reset_authentication_attempt_count` command for when users lock themselves out. diff --git a/docs/overview/release-lifecycle.md b/docs/overview/release-lifecycle.md index 010f88707c..6911e0dfc2 100644 --- a/docs/overview/release-lifecycle.md +++ b/docs/overview/release-lifecycle.md @@ -51,9 +51,9 @@ When new security releases are published, we simultaneously publish the fixes to the `main` and stable release branches, so that anyone using those branches can immediately upgrade as well. -See also our [security model][security-model] documentation. +See also our [security model][securing-your-zulip-server] documentation. -[security-model]: ../production/security-model.md +[securing-your-zulip-server]: ../production/securing-your-zulip-server.md ### Git versions diff --git a/docs/production/index.md b/docs/production/index.md index 5ce74b03e5..a7bfbf831d 100644 --- a/docs/production/index.md +++ b/docs/production/index.md @@ -14,7 +14,7 @@ system-configuration mobile-push-notifications upgrade modify -security-model +securing-your-zulip-server authentication-methods export-and-import postgresql diff --git a/docs/production/maintain-secure-upgrade.md b/docs/production/maintain-secure-upgrade.md index a87c115651..7915680478 100644 --- a/docs/production/maintain-secure-upgrade.md +++ b/docs/production/maintain-secure-upgrade.md @@ -13,7 +13,7 @@ Moved to [Troubleshooting](troubleshooting.md#monitoring). ### Securing your Zulip server -Moved to [Security model](security-model.md). +Moved to [Securing your Zulip server](securing-your-zulip-server.md). ### Upgrading diff --git a/docs/production/password-strength.md b/docs/production/password-strength.md index 869f1efa19..14ced4b4eb 100644 --- a/docs/production/password-strength.md +++ b/docs/production/password-strength.md @@ -8,7 +8,7 @@ When a user tries to set a password, we use [zxcvbn][zxcvbn] to check that it isn't a weak one. See discussion in [our main docs for server -admins](security-model.md#passwords). This doc explains in more +admins](securing-your-zulip-server.md#passwords). This doc explains in more detail how we set the default threshold (`PASSWORD_MIN_GUESSES`) we use. First, read the doc section there. (It's short.) diff --git a/docs/production/security-model.md b/docs/production/securing-your-zulip-server.md similarity index 100% rename from docs/production/security-model.md rename to docs/production/securing-your-zulip-server.md diff --git a/docs/production/upload-backends.md b/docs/production/upload-backends.md index 90990e5700..c6c94ad9f9 100644 --- a/docs/production/upload-backends.md +++ b/docs/production/upload-backends.md @@ -168,7 +168,7 @@ The file uploads bucket should have a policy of: ``` The file-uploads bucket should not be world-readable. See the -[documentation on the Zulip security model](security-model.md) for +[documentation on the Zulip security model](securing-your-zulip-server.md) for details on the security model for uploaded files. However, the avatars bucket is intended to be world-readable, so its