PSMDB-263 Update documentation for PSMDB 4.0 release

- [X] Use PSMDB 3.6 as the basis
- [X] Remove all 3.6 release notes
- [X] Remove references to 3.6 where applicable
- [X] Create placeholder release notes & mention the essential changes from upstream
- [X] Remove references to the removed MongoRocks storage engines
- [X] Create the .res directory to store replacement directives, urls, etc.
- [X] Update the conf.py file to hold the expected 4.0 release information
- [X] Update key meta data to use variables instead of literal text

Other issues solved:

- PSMDB-222

.gitignore

@@ -1,3 +1,4 @@
 build
 source/percona-theme/
 source/ext/psdom.pyc
+*~

source/.res/replace.program.rst~

@@ -0,0 +1,3 @@
+
+.. |mongod| replace:: :program:`mongod`
+.. |apt.purge| replace:: :program:`apt purge`

source/.res/replace.program.txt

@@ -0,0 +1,13 @@
+
+.. |apt.purge.percona-server-mongodb| replace:: :bash:`apt purge percona-server-mongodb*`
+.. |apt.purge| replace:: :program:`apt purge`
+.. |apt.remove.percona-server-mongodb| replace:: :bash:`apt remove percona-server-mongodb*`
+.. |apt.remove| replace:: :program:`apt remove`
+.. |apt.update| replace:: :bash:`apt update`
+.. |mongod| replace:: :program:`mongod`
+.. |service.mongod.restart| replace:: :bash:`service mongod restart`
+.. |service.mongod.start| replace:: :bash:`service mongod start`
+.. |service.mongod.status| replace:: :bash:`service mongod status`
+.. |service.mongod.stop| replace:: :bash:`service mongod stop`
+.. |systemctl.enable.mongod| replace:: :bash:`systemctl enable mongod`
+.. |yum.remove.percona-server-mongodb| replace:: :bash:`yum remove percona-server-mongodb*`

source/.res/replace.txt

@@ -0,0 +1,6 @@
+
+.. |prev-version| replace:: 3.6
+.. |mongodb-ce| replace:: MongoDB Community Edition
+.. |docker| replace:: Docker
+.. |tip.run-all.root|  replace:: Run the following commands as root or by using the :program:`sudo` command
+.. |tip.run-this.root| replace:: Run this command as root or by using the :program:`sudo` command

source/.res/replace.txt~

@@ -0,0 +1,3 @@
+
+.. |tip.run-all.root|  replace:: Run the following commands as root or by using the :program:`sudo` command
+.. |tip.run-this.root| replace:: Run this command as root or by using the :program:`sudo` command

source/.res/url.txt

@@ -0,0 +1,6 @@
+.. _Percona website:  https://www.percona.com/downloads/percona-server-mongodb-4.0/
+.. _Percona software repositories: https://www.percona.com/doc/percona-server-for-mongodb/4.0/install/index.html
+.. _`MMAPv1`: https://docs.mongodb.org/manual/core/mmapv1/
+.. _`WiredTiger`: https://docs.mongodb.org/manual/core/wiredtiger/
+.. _`MongoRocks`: http://rocksdb.org
+.. _`Docker Docs`: https://docs.docker.com/

source/.res/url.txt~

@@ -0,0 +1,2 @@
+.. _Percona website:  https://www.percona.com/downloads/percona-server-mongodb-4.0/
+.. _Percona software repositories: https://www.percona.com/doc/percona-server-for-mongodb/4.0/install/index.html

source/comparison.rst

@@ -1,19 +1,17 @@
 .. _compare:
 
-=============================================
+================================================================================
 Percona Server for MongoDB Feature Comparison
-=============================================
+================================================================================
 
-|PSMDB| is based on MongoDB 3.6, and it is the successor to Percona TokuMX,
+|PSMDB| 4.0 is based on MongoDB 4.0. |PSMDB| is the successor to Percona TokuMX,
 which is based on MongoDB 2.4.
 
-Both MongoDB and |PSMDB| include a pluggable storage engine API.
-This enables you to select from a variety of storage engines
-depending on your needs.
-Previous MongoDB versions (before 3.0) and Percona TokuMX
-can run with only one default storage engine.
-For more information about about using various storage engines,
-see :ref:`switch_storage_engines`.
+Both MongoDB and |PSMDB| include a pluggable storage engine API.  This enables
+you to select from a variety of storage engines depending on your needs.
+Previous MongoDB versions (before 3.0) and Percona TokuMX could run with only
+one default storage engine.  For more information about about using various
+storage engines, see :ref:`switch_storage_engines`.
 
 The following table will help you evaluate the differences.
 
@@ -29,13 +27,12 @@ The following table will help you evaluate the differences.
      - * WiredTiger_ (default)
        * MMAPv1_
        * :ref:`inmemory`
-       * :ref:`mongorocks`
      - * WiredTiger_ (default)
        * MMAPv1_
        * In-Memory_ (Enterprise only)
      - Built-in storage engine based on the Fractal Tree index
    * - :ref:`Hot Backup <hot-backup>`
-     - YES for WiredTiger_ and :ref:`mongorocks`
+     - YES for WiredTiger_
      - NO
      - YES
    * - :ref:`Audit Logging <audit-log>`

source/conf.py

@@ -43,18 +43,19 @@
 # The master toctree document.
 master_doc = 'index'
 
-# General information about the project.
-project = u'Percona Server for MongoDB 3.6 documentation'
-copyright = u'Percona LLC and/or its affiliates 2015-2018'
-
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
-#
+
 # The short X.Y version.
-version = '3.6'
+version = '4.0'
 # The full version, including alpha/beta/rc tags.
-release = '3.6.8-2.0'
+release = ".".join([version, '4-1'])
+
+# General information about the project.
+product_name = 'Percona Server for MongoDB'
+project = ' '.join([product_name, version, 'Documentation'])
+copyright = u'Percona LLC and/or its affiliates 2015-2018'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -91,10 +92,16 @@
 
 rst_prolog = '''
 
+.. role:: dir(file)       
+
+.. role:: bash(code)
+   :language: bash
+
+
 .. _`MMAPv1`: https://docs.mongodb.org/manual/core/mmapv1/
 .. _`WiredTiger`: https://docs.mongodb.org/manual/core/wiredtiger/
 .. _`RocksDB`: http://rocksdb.org
-.. _`In-Memory`: https://docs.mongodb.com/v3.6/core/inmemory/
+.. _`In-Memory`: https://docs.mongodb.com/v4.0/core/inmemory/
 
 .. |check|  replace:: ``|[[---CHECK---]]|``
 
@@ -136,7 +143,9 @@
 
 '''
 
-extlinks = {'jirabug': ('https://jira.percona.com/browse/%s',                       '#')}
+extlinks = {'psmdb-bug': ('https://jira.percona.com/browse/PSMDB-%s', 'PSMDB'),
+            'jirabug': ('https://jira.percona.com/browse/%s', '#')
+}
 
 # A list of ignored prefixes for module index sorting.
 #modindex_common_prefix = []
@@ -157,10 +166,10 @@
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
-html_title = 'Percona Server for MongoDB 3.6 Documentation'
+html_title = project
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
-html_short_title = 'Percona Server for MongoDB 3.6 Documentation'
+html_short_title = project
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
@@ -221,9 +230,9 @@
 #html_file_suffix = None
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'PerconaServerforMongoDBdocs'
-
-
+#htmlhelp_basename = 'PerconaServerforMongoDBdocs'
+htmlhelp_basename = "".join(["".join(product_name.split()), 'docs'])
+                    
 # -- Options for LaTeX output --------------------------------------------------
 
 # The paper size ('letter' or 'a4').
@@ -234,10 +243,13 @@
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
-latex_documents = [
-  ('index', 'Percona-Server-for-MongoDB.tex', u'Percona Server for MongoDB 3.6 Documentation',
-   u'Percona LLC and/or its affiliates 2015-2018', 'manual'),
-]
+
+#   'Percona-Server-for-MongoDB.tex', u'Percona Server for MongoDB 3.6 Documentation',
+#   u'Percona LLC and/or its affiliates 2015-2018', 'manual'),
+
+
+latex_documents = [('index', ''.join(['-'.join(product_name.split()), '.tex']),
+                    project, copyright, 'manual')]
 
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.

source/data_at_rest_encryption.rst

@@ -4,8 +4,11 @@
 Data at Rest Encryption
 ================================================================================
 
+:Availability: In |PSMDB| 4.0, this feature is in the *General Availability*
+               state and is ready for use in a production environment.
+
 Data at rest encryption for the WiredTiger storage engine in |mongodb| was
-introduced in |mongodb-enterprise| version 3.2. to ensure that encrypted data
+introduced in |mongodb-enterprise| version 3.2 to ensure that encrypted data
 files can be decrypted and read by parties with the decryption key.
 
 .. seealso::
@@ -15,16 +18,11 @@ files can be decrypted and read by parties with the decryption key.
 
 .. rubric:: Differences from Upstream
 
-The |feature| in |PSMDB| is introduced in version 3.6 to be compatible with
+The |feature| in |PSMDB| was introduced in version 3.6 to be compatible with
 |feature| in |mongodb|. In the current release of |PSMDB|, the |feature| does
 not include support for |abbr.kmip|, |vault| or |amazon-aws| key management
 services.
 
-.. important:: 
-
-   This feature is considered **BETA** quality. Do not use the |feature| in a
-   production environment.
-
 .. rubric:: Important Configuration Options
 
 |PSMDB| supports the ``encryptionCipherMode`` option where you choose one of the

source/hot-backup.rst

@@ -1,17 +1,16 @@
 .. _hot-backup:
 
-==========
+================================================================================
 Hot Backup
-==========
+================================================================================
 
-|PSMDB| includes an integrated open-source hot backup system
-for the default WiredTiger_ and alternative :ref:`mongorocks` storage engine.
-It creates a physical data backup on a running server
-without notable performance and operating degradation.
+|PSMDB| includes an integrated open-source hot backup system for the default
+WiredTiger_ storage engine.  It creates a physical data backup on a running
+server without notable performance and operating degradation.
 
-To take a hot backup of the database in your current ``dbpath``,
-run the ``createBackup`` command as administrator on the ``admin`` database
-and specify the backup directory.
+To take a hot backup of the database in your current ``dbpath``, run the
+``createBackup`` command as administrator on the ``admin`` database and specify
+the backup directory.
 
 .. code-block:: text
 

source/index.rst

@@ -1,56 +1,54 @@
 .. _dochome:
 
-==================================================
+================================================================================
 Percona Server for MongoDB |version| Documentation
-==================================================
+================================================================================
 
 |PSMDB| is a free, enhanced, fully compatible, open source, drop-in replacement
 for MongoDB 3.6 Community Edition with enterprise-grade features.
 It requires no changes to MongoDB applications or code.
 
 |PSMDB| provides the following features:
 
-* MongoDB's original MMAPv1_ storage engine,
-  and the default WiredTiger_ engine
-* Optional :ref:`inmemory` and :ref:`mongorocks` storage engines
-* :ref:`External SASL authentication <ext-auth>`
+- MongoDB's original MMAPv1_ storage engine, and the default
+  WiredTiger_ engine
+- Optional :ref:`inmemory` storage engine
+- :ref:`External SASL authentication <ext-auth>`
   using OpenLDAP or Active Directory
-* :ref:`Audit logging <audit-log>`
+- :ref:`Audit logging <audit-log>`
   to track and query database interactions of users or applications
-* :ref:`hot-backup` for the default WiredTiger_
-  and alternative :ref:`mongorocks` storage engine
-* :ref:`rate-limit` to decrease the impact of the profiler on performance
+- :ref:`hot-backup` for the default WiredTiger_
+- :ref:`rate-limit` to decrease the impact of the profiler on performance
 
------
+--------------------------------------------------------------------------------
 
 Introduction
-============
+================================================================================
 
 .. toctree::
    :maxdepth: 1
 
    Feature Comparison <comparison>
 
 Installation
-============
+================================================================================
 
 .. toctree::
    :maxdepth: 2
    :includehidden:
    :titlesonly:
 
    install/index
-   Upgrading from MongoDB Community Edition <install/upgrade_from_mongodb>
-   Upgrading from Version 3.4 <install/upgrade_from_34>
+   install/upgrade_from_mongodb
+   install/upgrade_from_36
 
 Features
-========
+================================================================================
 
 .. toctree::
    :maxdepth: 1
 
    inmemory
-   mongorocks
    hot-backup
    rate-limit
    authentication
@@ -60,7 +58,7 @@ Features
    data_at_rest_encryption
 
 Reference
-=========
+================================================================================
 
 .. toctree::
    :maxdepth: 1
@@ -73,3 +71,4 @@ Reference
    copyright
    trademark-policy
 
+.. include:: .res/replace.txt