Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
zulip/docs/production/maintain-secure-upgrade.md

43 lines
890 B
Markdown
Raw Normal View History

docs: Migrate from recommonmark to MyST-Parser. Recommonmark is no longer maintained, and MyST-Parser is much more complete. https://myst-parser.readthedocs.io/ Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-08-10 07:55:12 +02:00
```{eval-rst}
docs: Split maintain-secure-upgrade into dedicated docs. * Moves "Management commands" to a top-level section. * Moves "Scalability" as a subsection at the bottom of "Requirements". * Moves "Monitoring" as a subsections at the bottom of "Troubleshooting". * Replaces "API and your Zulip URL" with a link to REST API docs. This documentation text has been irrelevant for some time. * Removes maintain-secure-upgrade from the TOC but the file remains to avoid breaking old links from release blog posts and emails.
2019-11-22 02:07:17 +01:00
:orphan:
```
Move prod maintenance guide to new page.
2016-07-12 22:52:29 +02:00
docs: Split maintain-secure-upgrade into dedicated docs. * Moves "Management commands" to a top-level section. * Moves "Scalability" as a subsection at the bottom of "Requirements". * Moves "Monitoring" as a subsections at the bottom of "Troubleshooting". * Replaces "API and your Zulip URL" with a link to REST API docs. This documentation text has been irrelevant for some time. * Removes maintain-secure-upgrade from the TOC but the file remains to avoid breaking old links from release blog posts and emails.
2019-11-22 02:07:17 +01:00
# Maintain, secure, and upgrade
Move prod maintenance guide to new page.
2016-07-12 22:52:29 +02:00
docs: Split maintain-secure-upgrade into dedicated docs. * Moves "Management commands" to a top-level section. * Moves "Scalability" as a subsection at the bottom of "Requirements". * Moves "Monitoring" as a subsections at the bottom of "Troubleshooting". * Replaces "API and your Zulip URL" with a link to REST API docs. This documentation text has been irrelevant for some time. * Removes maintain-secure-upgrade from the TOC but the file remains to avoid breaking old links from release blog posts and emails.
2019-11-22 02:07:17 +01:00
This was once a long page covering a bunch of topics; those topics
have since all moved to dedicated pages:
docs: Merge "Upgrading" with modifying-zulip. Merges the "Upgrades" section from production/maintain-secure-upgrade.md with production/modifying-zulip.md. Contains significant textual changes by tabbott to read more clearly.
2019-10-14 21:40:48 +02:00
docs: Split maintain-secure-upgrade into dedicated docs. * Moves "Management commands" to a top-level section. * Moves "Scalability" as a subsection at the bottom of "Requirements". * Moves "Monitoring" as a subsections at the bottom of "Troubleshooting". * Replaces "API and your Zulip URL" with a link to REST API docs. This documentation text has been irrelevant for some time. * Removes maintain-secure-upgrade from the TOC but the file remains to avoid breaking old links from release blog posts and emails.
2019-11-22 02:07:17 +01:00
### Monitoring
docs: Format Markdown with Prettier. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-08-20 22:54:08 +02:00
docs: Convert .html#fragment links to .md#fragment. This uses the myst_heading_anchors option to automatically generate header anchors and make Sphinx aware of them. See https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#auto-generated-header-anchors. Note: to be compatible with GitHub, MyST-Parser uses a slightly different convention for .md fragment links than .html fragment links when punctuation is involved. This does not affect the generated fragment links in the HTML output. Fixes #13264. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2022-02-16 01:39:15 +01:00
Moved to [Troubleshooting](troubleshooting.md#monitoring).
docs: Extract security-model.md.
2017-01-18 02:43:17 +01:00
docs: Merge "Upgrading" with modifying-zulip. Merges the "Upgrades" section from production/maintain-secure-upgrade.md with production/modifying-zulip.md. Contains significant textual changes by tabbott to read more clearly.
2019-10-14 21:40:48 +02:00
### Securing your Zulip server
docs: Clean redundant relative links. We previously had a convention of redundantly including the directory in relative links to reduce mistakes when moving content from one file to another. However, these days we have a broken link checker in test-documentation, and after #21237, MyST-Parser will check relative links (including fragments) when you run build-docs. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2022-02-24 00:17:21 +01:00
Moved to [Security model](security-model.md).
docs: Merge "Upgrading" with modifying-zulip. Merges the "Upgrades" section from production/maintain-secure-upgrade.md with production/modifying-zulip.md. Contains significant textual changes by tabbott to read more clearly.
2019-10-14 21:40:48 +02:00
### Upgrading
contributor docs: Rename "Upgrade or modify Zulip" -> "Upgrade Zulip". Fixes part of #23984.
2023-01-17 04:33:42 +01:00
Moved to [Upgrading to a release](upgrade.md#upgrading-to-a-release).
docs: Merge "Upgrading" with modifying-zulip. Merges the "Upgrades" section from production/maintain-secure-upgrade.md with production/modifying-zulip.md. Contains significant textual changes by tabbott to read more clearly.
2019-10-14 21:40:48 +02:00
### Upgrading from a Git repository
Moved to [Upgrading from a Git
contributor docs: Rename "Upgrade or modify Zulip" -> "Upgrade Zulip". Fixes part of #23984.
2023-01-17 04:33:42 +01:00
repository](upgrade.md#upgrading-from-a-git-repository).
docs: Merge "Upgrading" with modifying-zulip. Merges the "Upgrades" section from production/maintain-secure-upgrade.md with production/modifying-zulip.md. Contains significant textual changes by tabbott to read more clearly.
2019-10-14 21:40:48 +02:00
### Upgrading the operating system
Moved to [Upgrading the operating
contributor docs: Rename "Upgrade or modify Zulip" -> "Upgrade Zulip". Fixes part of #23984.
2023-01-17 04:33:42 +01:00
system](upgrade.md#upgrading-the-operating-system).
docs: Merge "Upgrading" with modifying-zulip. Merges the "Upgrades" section from production/maintain-secure-upgrade.md with production/modifying-zulip.md. Contains significant textual changes by tabbott to read more clearly.
2019-10-14 21:40:48 +02:00
docs: Split maintain-secure-upgrade into dedicated docs. * Moves "Management commands" to a top-level section. * Moves "Scalability" as a subsection at the bottom of "Requirements". * Moves "Monitoring" as a subsections at the bottom of "Troubleshooting". * Replaces "API and your Zulip URL" with a link to REST API docs. This documentation text has been irrelevant for some time. * Removes maintain-secure-upgrade from the TOC but the file remains to avoid breaking old links from release blog posts and emails.
2019-11-22 02:07:17 +01:00
### Scalability
docs: Move management docs to a better place and expand. Now that a management command is not required to install Zulip, we can bury the documentation on them a bit more. Fixes: #551.
2016-08-25 05:51:42 +02:00
docs: Convert .html#fragment links to .md#fragment. This uses the myst_heading_anchors option to automatically generate header anchors and make Sphinx aware of them. See https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#auto-generated-header-anchors. Note: to be compatible with GitHub, MyST-Parser uses a slightly different convention for .md fragment links than .html fragment links when punctuation is involved. This does not affect the generated fragment links in the HTML output. Fixes #13264. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2022-02-16 01:39:15 +01:00
Moved to [Scalability](requirements.md#scalability).
docs: Document a few management commands around email.
2019-11-19 00:44:57 +01:00
docs: Split maintain-secure-upgrade into dedicated docs. * Moves "Management commands" to a top-level section. * Moves "Scalability" as a subsection at the bottom of "Requirements". * Moves "Monitoring" as a subsections at the bottom of "Troubleshooting". * Replaces "API and your Zulip URL" with a link to REST API docs. This documentation text has been irrelevant for some time. * Removes maintain-secure-upgrade from the TOC but the file remains to avoid breaking old links from release blog posts and emails.
2019-11-22 02:07:17 +01:00
### Management commands
docs: Document a few management commands around email.
2019-11-19 00:44:57 +01:00
docs: Clean redundant relative links. We previously had a convention of redundantly including the directory in relative links to reduce mistakes when moving content from one file to another. However, these days we have a broken link checker in test-documentation, and after #21237, MyST-Parser will check relative links (including fragments) when you run build-docs. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2022-02-24 00:17:21 +01:00
Moved to [Management commands](management-commands.md).
settings: Set REALMS_HAVE_SUBDOMAINS by default. This change means that almost every Zulip server out there will now be using subdomains for every realm. There are a few complications noted in the release notes.
2017-08-25 03:56:20 +02:00
docs: Split maintain-secure-upgrade into dedicated docs. * Moves "Management commands" to a top-level section. * Moves "Scalability" as a subsection at the bottom of "Requirements". * Moves "Monitoring" as a subsections at the bottom of "Troubleshooting". * Replaces "API and your Zulip URL" with a link to REST API docs. This documentation text has been irrelevant for some time. * Removes maintain-secure-upgrade from the TOC but the file remains to avoid breaking old links from release blog posts and emails.
2019-11-22 02:07:17 +01:00
### API and your Zulip URL
settings: Set REALMS_HAVE_SUBDOMAINS by default. This change means that almost every Zulip server out there will now be using subdomains for every realm. There are a few complications noted in the release notes.
2017-08-25 03:56:20 +02:00
docs: Remove incorrect references to chat.zulip.org. Most of these are Help Center links that should be pointing to the production Help Center.
2020-10-30 00:46:30 +01:00
Moved to [REST API](https://zulip.com/api/rest).