(DOCSP-6719): Updated Style Guide starting with port of Rackspace Style Guide.

Author: Tony Sansone

conf.py

@@ -65,6 +65,7 @@ def has(self, *args):
     '.. |hardlink| replace:: {0}/{1}'.format(conf.project.url, conf.git.branches.current),
     '.. |branch| replace:: ``{0}``'.format(conf.git.branches.current),
     '.. |bi| replace:: MongoDB Connector for BI',
+    '.. |mdbsg| replace:: MongoDB Style Guide'
 ])
 
 pygments_style = 'sphinx'
@@ -79,9 +80,33 @@ def has(self, *args):
     'mms-docs': ('https://docs.cloudmanager.mongodb.com%s', ''),
     'mms-home': ('https://www.mongodb.com/cloud/cloud-manager%s', ''),
     'opsmgr': ('https://docs.opsmanager.mongodb.com/current%s', ''),
+    'cldmgr': ('https://docs.cloudmanager.mongodb.com/%s', ''),
+    'atlas': ('https://docs.atlas.mongodb.com/%s', ''),
     'products': ('https://www.mongodb.com/products%s', ''),
     'wtdocs': ('http://source.wiredtiger.com/mongodb-3.4%s', ''),
-
+    'v2.2': ('https://docs.mongodb.com/v2.2%s', ''),
+    'v2.4': ('https://docs.mongodb.com/v2.4%s', ''),
+    'v2.6': ('https://docs.mongodb.com/v2.6%s', ''),
+    'v3.0': ('https://docs.mongodb.com/v3.0%s', ''),
+    'v3.2': ('https://docs.mongodb.com/v3.2%s', ''),
+    'v3.4': ('https://docs.mongodb.com/v3.4%s', ''),
+    'v3.6': ('https://docs.mongodb.com/v3.6%s', ''),
+    'v4.0': ('https://docs.mongodb.com/v4.0%s', ''),
+    'bic': ('https://docs.mongodb.com/bi-connector/current%s',''),
+    'k8s': ('https://docs.mongodb.com/kubernetes-operator/stable%s',''),
+    'product': ('http://www.mongodb.com/products/%s?jmp=docs',''),
+    'website': ('https://www.mongodb.com%s?jmp=docs',''),
+    'dl': ('http://www.mongodb.com/download-center/%s?jmp=docs',''),
+    'aws': ('http://docs.aws.amazon.com%s',''),
+    'driver' : ('https://docs.mongodb.com/ecosystem/drivers%s', ''),
+    'wikipedia' : ('https://en.wikipedia.org/wiki%s', ''),
+    'mw' : ('https://www.merriam-webster.com/dictionary/%s',''),
+    'mdbdrivers' : ('https://docs.mongodb.com/ecosystem/drivers/%s',''),
+    'cmos17' : ('https://www.chicagomanualofstyle.org/book/ed17%s',''),
+    'sphinx-rst' : ('https://www.sphinx-doc.org/en/master/usage/restructuredtext%s', ''),
+    'sphinx' : ('https://www.sphinx-doc.org/en/master%s', ''),
+    'rst' : ('http://docutils.sourceforge.net/docs/ref/rst%s',''),
+    'cc' : ('https://creativecommons.org/licenses%s','')
 }
 
 ## add `extlinks` for each published version.

source/includes/steps-guides.yaml

@@ -2,42 +2,42 @@ title: "Add guides to your sphinx extensions."
 ref: add-guides
 content: |
   Add 'guides' to the extensions list in conf.py in your repo root.
- 
+
   .. code-block:: sh
-     
+
      extensions = [
-     'sphinx.ext.extlinks',
-     'sphinx.ext.todo',
-     'mongodb',
-     'directives',
-     'intermanual',
-     'testcode',
-     'tabs',
-     'markdown',
-     'fasthtml',
-     'source_constants',
-     'icon'
-     'guides'
-     ]  
+       'sphinx.ext.extlinks',
+       'sphinx.ext.todo',
+       'mongodb',
+       'directives',
+       'intermanual',
+       'testcode',
+       'tabs',
+       'markdown',
+       'fasthtml',
+       'source_constants',
+       'icon'
+       'guides'
+     ]
 ---
-title: Copy the guides directive template into a file in your repo. 
-ref: copy-guide 
+title: Copy the guides directive template into a file in your repo.
+ref: copy-guide
 content: |
   Copy the following directive template into a file to begin
   writing your guide. Make sure it's under the source directory and
   give it a .txt extension. Otherwise it won't build.
 
   .. note::
-  
+
      While the spacing makes this example look a bit like a .yaml
      file, it's really a sphinx directive. This guide should compile as-is.
 
-  .. code-block:: sh 
+  .. code-block:: sh
 
-     .. guide::  
-        title: This is your guide title 
+     .. guide::
+        title: This is your guide title
         author: MongoDB Documentation Team
-        type: Getting Started 
+        type: Getting Started
         level: beginner
         product_version: 4.0
         languages:
@@ -50,26 +50,26 @@ content: |
           csharp
         result_description:
           This is a handy description of the result you will achieve
-          if you successfully create this guide. 
-        time: 15 
+          if you successfully create this guide.
+        time: 15
         prerequisites:
-          - first do this guide 
-          - then do this one 
+          - first do this guide
+          - then do this one
           - make sure you have installed some stuff
         check_your_environment:
           Check to see if your environment has everything it needs.
           List things you need to complete this guide
             - binaries installed
             - permissions
-            - drivers or libraries 
+            - drivers or libraries
         procedure:
           Feel free to put the steps include here.
-          
+
           At the moment, tabbed content does not display properly when put
           directly in the procedure section. Use an include file for tabbed
-          content. 
+          content.
         summary:
-          Congrats! You accomplished something. 
+          Congrats! You accomplished something.
         whats_next:
           - check out the `guide on such and such </guide/such-and-such>`
 
@@ -84,20 +84,21 @@ content: |
   (tabs-drivers) to toggle.
 
   The following sections are required:
+
    .. list-table::
       :header-rows: 1
-      :widths: auto
-      :class: guide-tablenate 
-     
+      :widths: 10 20 70
+      :class: guide-tablenate
+
       * - field
-        - type   
+        - type
         - possible values
 
       * - title
         - string
         - any
 
-      * - author  
+      * - author
         - string
         - any
 
@@ -106,59 +107,59 @@ content: |
         - beginner, intermediate, advanced
 
       * - time
-        - number  
+        - number
         - any
- 
+
       * - type
         - string
         - Getting Started, Use Case, Deep Dive
- 
+
       * - product_version
         - number
         - any
 
       * - prerequisites
-        - text     
+        - text
         - any
-     
+
       * - summary
         - text
         - any
-    
+  
       * - procedure
-        - text    
+        - text  
         - any
-     
+
       * - result_description
         - text
         - any
 ---
-title: Document the content with steps required to complete the tutorial 
-ref: make-steps 
+title: Document the content with steps required to complete the tutorial
+ref: make-steps
 content: |
   Document the steps required for your guide. If you'd like content
   with numbered steps, use a step file.
- 
+
   Step files are *.yaml* files that get converted during the build process
   to *.rst* files and
   are included as `/<dir>/steps/<something>.rst`. When you create the .yaml
   step file, name it according to the convention:
 
   .. note::
-     
+
      Guides use headings to delineate sections. If you would like to provide
      subsections for your guides sections, use subheadings.
 
-  
+
   .. code-block:: sh
- 
+
      <dir>/steps-<something>.yaml
 
   Here is an example of a .yaml steps file. Notice that you can
   nest includes within the step content if you wish.
 
-  .. code-block:: sh 
-     
+  .. code-block:: sh
+
      title: Find the ``mongo`` Shell
      ref: mongo-shell
      content: |
@@ -182,7 +183,7 @@ content: |
 
 ---
 title: Add What's Next and See Also (optional) sections
-ref: whats-next 
+ref: whats-next
 content: |
 
   The *What's Next* and *See Also* sections are important for
@@ -208,20 +209,20 @@ content: |
   can be referenced using the fully qualified url:
 
   .. code-block:: sh
-     
+
      `Site to link to <http://fully.qualified.domain/stuff>`__.
 
 ---
 title: Add the Guide to a Table of Contents
-ref: add-to-toc 
+ref: add-to-toc
 content: |
 
   To add the guide to a table of contents, use the same method you would
   use for any standard docs content.
 
   In the .txt file for the TOC in question, add the link.
 
-  .. code-block:: none 
+  .. code-block:: none
 
      .. toctree::
         :titlesonly:

source/reference/cond.txt

@@ -22,6 +22,41 @@ evaluate suppressed content.
 
    .. code-block:: rst
 
+      Access :guilabel:`Data Explorer`
+      --------------------------------
+
+      .. cond:: cloud
+
+         .. note::
+
+            To access :guilabel:`Data Explorer`, you must have been
+            granted access through one of the following roles:
+
+            - :authrole:`Project Owner` or
+              :authrole:`Organization Owner`
+
+            - :authrole:`Project Data Access Admin`
+
+            - :authrole:`Project Data Access Read/Write`
+
+            - :authrole:`Project Data Access Read Only`
+
+
+            Data Explorer is not available for trial versions of |mms|
+            after the initial 30 day trial period.
+
       .. cond:: onprem
 
-         .. include:: /release-notes/changelogs/changelog-backup-agent-onprem.rst
+         .. note::
+
+            To access :guilabel:`Data Explorer`, you must have been
+            granted access through one of the following roles:
+
+            - :authrole:`Project Owner` or
+              :authrole:`Organization Owner`
+
+            - :authrole:`Project Data Access Admin`
+
+            - :authrole:`Project Data Access Read/Write`
+
+            - :authrole:`Project Data Access Read Only`