paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-04 05:53:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Make production unreleased documentation notices more visible.

Browse Source 
Previously, Google might take you to /latest rather than /stable, and
you might get information about the next release, not the current one.

Fixes #13056.
This commit is contained in:
Tim Abbott
2019-08-23 16:32:37 -07:00
parent 3999a2db4d
commit e6340c6e54
2 changed files with 36 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
docs/production/install.md
View File

@@ -1,5 +1,23 @@
# Production Installation
<!---
The `.. only:: unreleased` syntax invokes an rST "directive"
called `only`, defined by Sphinx:
https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#including-content-based-on-tags
It's controlled by `docs/conf.py` through the `tags` object.
-->
```eval_rst
.. only:: unreleased
.. warning::
You are reading a **development version** of the Zulip documentation.
These instructions may not correspond to the latest Zulip Server
release. See `documentation for the latest release`__.
__ https://zulip.readthedocs.io/en/stable/production/install.html
```
You'll need an Ubuntu or Debian system that satisfies
[the installation requirements](../production/requirements.html). Alternatively,
you can use a preconfigured
@@ -32,24 +50,6 @@ using code from our [repository on GitHub](https://github.com/zulip/zulip/).
## Step 2: Install Zulip
<!---
The `.. only:: unreleased` syntax invokes an rST "directive"
called `only`, defined by Sphinx:
https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#including-content-based-on-tags
It's controlled by `docs/conf.py` through the `tags` object.
-->
```eval_rst
.. only:: unreleased
.. warning::
You are reading a **development version** of the Zulip documentation.
These instructions may not correspond to the latest Zulip Server
release. See `documentation for the latest release`__.
__ https://zulip.readthedocs.io/en/stable/prod-install.html
```
To set up Zulip with the most common configuration, you can run the
installer as follows:

18
docs/production/requirements.md
View File

@@ -1,5 +1,23 @@
# Requirements
<!---
The `.. only:: unreleased` syntax invokes an rST "directive"
called `only`, defined by Sphinx:
https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#including-content-based-on-tags
It's controlled by `docs/conf.py` through the `tags` object.
-->
```eval_rst
.. only:: unreleased
.. warning::
You are reading a **development version** of the Zulip documentation.
These instructions may not correspond to the latest Zulip Server
release. See `documentation for the latest release`__.
__ https://zulip.readthedocs.io/en/stable/production/requirements.html
```
To run a Zulip server, you will need:
* A dedicated machine or VM
* A supported OS: