Skip to content

Commit

Permalink
DOCSP-24390 Hide upgrade, downgrade, install docs from rapid release (#…
Browse files Browse the repository at this point in the history
…1603)

* (DOCSP-19419): Hide upgrade, downgrade, install docs from rapid release

* remove install docs from toc

* update version replacements

* remove missing refs

* remove missing ref

* fix version number for install link

* link formatting

* remove missing ref

* add rapid note to upgrade revision tutorial
  • Loading branch information
jeff-allen-mongo authored Aug 10, 2022
1 parent 8b5abf9 commit 8d29973
Show file tree
Hide file tree
Showing 58 changed files with 86 additions and 4,056 deletions.
2 changes: 1 addition & 1 deletion conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ def has(self, *args):
])

source_constants = {
'version-dev': '5.3', # Current development branch
'version-dev': '6.1', # Current development branch
'package-name-org': 'mongodb-org',
'package-name-enterprise': 'mongodb-enterprise',
'version': version,
Expand Down
4 changes: 1 addition & 3 deletions snooty.toml
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,6 @@ toc_landing_pages = [
"/crud",
"/geospatial-queries",
"/indexes",
"/installation",
"/introduction",
"/mongo",
"/reference/aggregation",
Expand Down Expand Up @@ -225,10 +224,9 @@ windows-dir-version = "6.0" # wizard
package-name-org = "mongodb-org"
package-name-enterprise = "mongodb-enterprise"
package-name = "mongodb"
version = "6.0"
version = "6.1"
latest-lts-version = "6.0"
release = "6.0.0"
version-dev = "6.1"
pgp-version = "{+version+}"
rsa-key = "4B7C549A058F8B6B"
pgp-fingerprint = "E162F504A20CDF15827F718D4B7C549A058F8B6B"
Expand Down
3 changes: 1 addition & 2 deletions source/about.txt
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ which are also distributed with the official MongoDB Packages.
Version and Revisions
---------------------

This version of the manual reflects version {+latest-lts-version+}
This version of the manual reflects version {+version+}
of MongoDB.

See the `MongoDB Documentation Project Page <https://www.mongodb.com/docs>`_
Expand Down Expand Up @@ -96,4 +96,3 @@ For more information on the MongoDB documentation process, see the

If you have any questions, please feel free to open a :issue:`Jira Case
<DOCS>`.

2 changes: 2 additions & 0 deletions source/administration/install-community.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ Install MongoDB Community Edition
:depth: 1
:class: singlecol

.. include:: /includes/rapid-release.rst

These documents provide instructions to install MongoDB Community Edition.

.. _`MongoDB Download Center`: https://www.mongodb.com/try/download/community?tck=docs_server
Expand Down
2 changes: 2 additions & 0 deletions source/administration/install-on-linux.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ Install MongoDB Community Edition on Linux

.. default-domain:: mongodb

.. include:: /includes/rapid-release.rst

These documents provide instructions to install MongoDB Community
Edition for supported Linux systems.

Expand Down
5 changes: 0 additions & 5 deletions source/administration/production-notes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -857,11 +857,6 @@ consider the following recommendations:
default MongoDB directory paths or :doc:`ports
</reference/default-mongodb-port>`.

See: :ref:`Configure SELinux for
MongoDB <install-rhel-configure-selinux>` and :ref:`Configure SELinux
for MongoDB Enterprise <install-enterprise-rhel-configure-selinux>`
for the required configuration.

.. include:: /includes/fact-selinux-server-side-js.rst

.. _readahead:
Expand Down
2 changes: 2 additions & 0 deletions source/administration/upgrade-community-to-enterprise.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ Upgrade MongoDB Community to MongoDB Enterprise
:depth: 1
:class: singlecol

.. include:: /includes/rapid-release.rst

.. include:: /includes/extracts/enterprise-additional-features.rst

The documents in this section provide instructions to upgrade from
Expand Down
3 changes: 1 addition & 2 deletions source/contents.txt
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,7 @@ project, this Manual and additional editions of this text.
:hidden:

Introduction </introduction>
Installation </installation>
MongoDB Shell (mongosh) <https://www.mongodb.com/docs/mongodb-shell/>
MongoDB Shell (mongosh) <https://docs.mongodb.com/mongodb-shell/>
/crud
/aggregation
/data-modeling
Expand Down
2 changes: 1 addition & 1 deletion source/includes/fact-mongodb-intro.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Welcome to the MongoDB {+version-dev+} Manual! MongoDB is a
Welcome to the MongoDB {+version+} Manual! MongoDB is a
document database designed for ease of development
and scaling.

Expand Down
7 changes: 4 additions & 3 deletions source/includes/fact-rapid-release-install.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
To install the latest MongoDB version supported for
on-premises use, MongoDB {+latest-lts-version+}, see the
:manual:`MongoDB 5.0 installation instructions </installation>`.
To install the latest MongoDB version supported for on-premises use,
MongoDB {+latest-lts-version+}, see the
:v6.0:`MongoDB {+latest-lts-version+} installation instructions
</installation>`.
4 changes: 2 additions & 2 deletions source/includes/in-dev.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

.. warning:: MongoDB {+version-dev+} Not Yet Available
.. warning:: MongoDB {+version+} Not Yet Available

MongoDB {+version-dev+} release candidates are not yet available.
MongoDB {+version+} release candidates are not yet available.
This version of the manual is for an upcoming release and is
currently a work in progress.
4 changes: 2 additions & 2 deletions source/includes/rapid-release.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. important::

MongoDB |version| is a rapid release and is only supported for
MongoDB Atlas. MongoDB |version| is not supported for use
MongoDB {+version+} is a rapid release and is only supported for
MongoDB Atlas. MongoDB {+version+} is not supported for use
on-premises. For more information, see
:ref:`release-version-numbers`.

Expand Down
4 changes: 2 additions & 2 deletions source/includes/rc-available.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. important:: MongoDB {+version-dev+} Release Candidates
.. important:: MongoDB {+version+} Release Candidates

MongoDB {+version-dev+} binaries are currently available only as
MongoDB {+version+} binaries are currently available only as
**release candidates**. Release candidates can be used for early
testing of new features, but are not suitable for production
deployments.
Expand Down
21 changes: 7 additions & 14 deletions source/index.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,14 @@ What is MongoDB?
MongoDB is a document database designed for ease of application
development and scaling.

Run MongoDB with
Run MongoDB with `MongoDB Atlas
<https://www.mongodb.com/cloud?tck=docs_server>`__ fully managed in
the cloud.

- `MongoDB Atlas
<https://www.mongodb.com/cloud?tck=docs_server>`__ fully managed in
the cloud,
- the source available and free-to-use :doc:`MongoDB
Community </administration/install-community>`, or
- the :doc:`MongoDB Enterprise Advanced
</administration/install-community>` subscription.
.. button:: Get started with MongoDB Atlas
:uri: https://www.mongodb.com/cloud?tck=docs_server

.. button:: Install MongoDB
:uri: /installation

`Get started with MongoDB Atlas <https://www.mongodb.com/cloud?tck=docs_server>`__
.. include:: /includes/rapid-release.rst

.. image:: /images/hero.png
:alt: Homepage hero image
Expand Down Expand Up @@ -215,8 +209,7 @@ Explore libraries and tools for MongoDB.
:titlesonly:

Introduction </introduction>
Installation </installation>
MongoDB Shell (mongosh) <https://www.mongodb.com/docs/mongodb-shell/>
MongoDB Shell (mongosh) <https://docs.mongodb.com/mongodb-shell/>
/crud
/aggregation
/data-modeling
Expand Down
113 changes: 9 additions & 104 deletions source/installation.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
.. _tutorials-installation:
.. _tutorial-installation:

.. This page is hidden from the TOC and search indexing.

:orphan:

.. meta::
:robots: noindex, nosnippet

===============
Install MongoDB
===============
Expand All @@ -13,114 +20,12 @@ Install MongoDB
:depth: 1
:class: singlecol






.. include:: /includes/unicode-checkmark.rst

.. include:: /includes/unicode-checkmark.rst

MongoDB is available in two server editions: *Community* and
*Enterprise*.

.. _`MongoDB Download Center`: https://www.mongodb.com/try/download/community?tck=docs_server

.. include:: /includes/fact-atlas-banner.rst

This section of the manual contains information on installing
MongoDB.

- For instructions on upgrading your current deployment to MongoDB
{+version+}, see :ref:`{+version+}-upgrade` instead.

- For instructions on upgrading to the latest patch release for your
current version, see :doc:`/tutorial/upgrade-revision` instead.

MongoDB Installation Tutorials
------------------------------

MongoDB installation tutorials are available for the following
platforms, for both the Community Edition and the
:products:`Enterprise Edition
</mongodb-enterprise-advanced?tck=docs_server>`:

.. list-table::
:header-rows: 1
:widths: 10 45 45

* - Platform
- Community Edition
- Enterprise Edition

* - Linux
- | :doc:`/tutorial/install-mongodb-on-red-hat`
| :doc:`/tutorial/install-mongodb-on-ubuntu`
| :doc:`/tutorial/install-mongodb-on-debian`
| :doc:`/tutorial/install-mongodb-on-suse`
| :doc:`/tutorial/install-mongodb-on-amazon`

- | :doc:`/tutorial/install-mongodb-enterprise-on-red-hat`
| :doc:`/tutorial/install-mongodb-enterprise-on-ubuntu`
| :doc:`/tutorial/install-mongodb-enterprise-on-debian`
| :doc:`/tutorial/install-mongodb-enterprise-on-suse`
| :doc:`/tutorial/install-mongodb-enterprise-on-amazon`

* - macOS
- :doc:`/tutorial/install-mongodb-on-os-x`
- :doc:`/tutorial/install-mongodb-enterprise-on-os-x`

* - Windows
- :doc:`/tutorial/install-mongodb-on-windows`
- :doc:`/tutorial/install-mongodb-enterprise-on-windows`

* - Docker
-
- :doc:`/tutorial/install-mongodb-enterprise-with-docker`

.. include:: /includes/unicode-checkmark.rst

Upgrade Community Edition to Enterprise Edition Tutorials
---------------------------------------------------------

.. important::

.. include:: /includes/extracts/enterprise-upgrade-edition-only.rst

- :doc:`/tutorial/upgrade-to-enterprise-standalone`
- :doc:`/tutorial/upgrade-to-enterprise-replica-set`
- :doc:`/tutorial/upgrade-to-enterprise-sharded-cluster`

.. _mongodb-supported-platforms:

Supported Platforms
-------------------

.. versionchanged:: 3.4

MongoDB no longer supports 32-bit x86 platforms.

.. sharedinclude:: server/platform-support/platform-support.rst

.. [#oracle-linux]

MongoDB only supports Oracle Linux running the Red Hat Compatible
Kernel (RHCK). MongoDB does **not** support the Unbreakable
Enterprise Kernel (UEK).

.. [#RockyAlmaLinux-support-install]

MongoDB on-premises products released for RHEL version 8.0+ are
compatible with and supported on Rocky Linux version 8.0+ and
AlmaLinux version 8.0+, contingent upon those distributions meeting their
obligation to deliver full RHEL compatibility.

.. [#SLES12-SP-info]

MongoDB versions 5.0 and greater are tested against SLES 12 service
pack 5. Earlier versions of MongoDB are tested against SLES 12
with no service pack.
.. include:: /includes/rapid-release.rst


.. toctree::
:hidden:
Expand Down
2 changes: 2 additions & 0 deletions source/introduction.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ Introduction to MongoDB
:depth: 1
:class: singlecol

.. include:: /includes/rapid-release-short.rst

Document Database
-----------------

Expand Down
Loading

0 comments on commit 8d29973

Please sign in to comment.