DOP-1345: build BI Connector on snooty (#260)

schmalliso · web-flow · commit 0f29b65b3069 · 2020-09-25T12:01:57.000-04:00
* DOP-1345: prep bi-connector current for snooty build

* clean up deprecated elements, add alt text to image

* deal with broken targets

* update to use bic-v2.10 role

* minor: updates to snootify recent commits

* fix extlink roles

* attempts

* fix broken link
diff --git a/snooty.toml b/snooty.toml
@@ -1,18 +1,28 @@
 name = "bi-connector"
+title = "MongoDB Connector for BI"
+
+intersphinx = ["https://docs.mongodb.com/manual/objects.inv", 
+               "https://docs.atlas.mongodb.com/objects.inv"]
+
+toc_landing_pages = ["/installation", "/client-applications", "/connect/mysql", 
+                     "/authentication", "/schema-configuration", "/components", 
+                     "/release-notes"]
 
 [constants]
+atlas = "MongoDB Atlas"
 bi-atlas-short = "BI Connector for Atlas"
+bi-full = "MongoDB Connector for Business Intelligence"
 bi-short = "BI Connector"
+cm-full = "MongoDB Cloud Manager"
 download-center = "`MongoDB Download Center <https://www.mongodb.com/download-center/bi-connector>`__"
 download-center-bi = "`MongoDB Connector for BI <https://www.mongodb.com/download-center/bi-connector>`__"
 download-center-tableau = "`MongoDB Connector for BI <https://www.mongodb.com/download-center/bi-connector?jmp=tbl>`__"
 download-center-url = "https://www.mongodb.com/download-center/bi-connector"
+java-plugin = "MongoSQL Authentication Plugin for MySQL Connector/J"
 odbc-driver = "`MongoDB ODBC Driver for BI Connector <https://github.com/mongodb/mongo-odbc-driver/releases/>`__"
+om-full = "MongoDB Ops Manager"
 
 [substitutions]
-branch = "``{0}``'.format(conf.git.branches.current)"
-copy = "unicode:: U+000A9',"
-year = "{0}'.format(datetime.date.today().year)"
 ent-build = "MongoDB Enterprise"
 hardlink = "https://docs.mongodb.com/bi-connector/"
 adc = ":abbr:`ADC (Active Directory Controller)`"
@@ -22,8 +32,10 @@ bi-atlas = "MongoDB Connector for Business Intelligence for MongoDB Atlas"
 bi-short = "BI Connector"
 bi = "MongoDB Connector for BI"
 cidr = ":abbr:`CIDR (Classless Inter-Domain Routing)`"
+csr = ":abbr:`CSR (Certificate Signing Request)`"
 dsn = ":abbr:`DSN (Data Source Name)`"
 epoch-time = "Timestamp in the number of seconds that have elapsed since the `UNIX epoch <https://en.wikipedia.org/wiki/Unix_time?oldid=828172017>`__"
+fqdn = ":abbr:`FQDN (Fully Qualified Domain Name)`"
 https = ":abbr:`HTTPS (Secure HyperText Transport Protocol)`"
 http = ":abbr:`HTTP (HyperText Transport Protocol)`"
 iana = ":abbr:`IANA (Internet Assigned Numbers Authority)`"
diff --git a/source/atlas-bi-connector.txt b/source/atlas-bi-connector.txt
@@ -24,5 +24,5 @@ To install the {+bi-full+} on premises, see the
 .. note::
 
    You can also deploy the {+bi-full+} to the
-   :cm:`{+cm-full+} </tutorial/deploy-bi-connector/>` or
-   :om:`{+om-full+} </tutorial/deploy-bi-connector/>`.
+   :cloudmgr:`{+cm-full+} </tutorial/deploy-bi-connector/>` or
+   :opsmgr:`{+om-full+} </tutorial/deploy-bi-connector/>`.
diff --git a/source/authentication.txt b/source/authentication.txt
@@ -269,7 +269,14 @@ authenticate using your BI tool, install either the C or JDBC
 authentication plugin depending on which is compatible with your BI
 Tool:
 
-.. include:: /includes/toc/dfn-list-client-dependencies.rst
+:doc:`/reference/auth-plugin-c`
+   Instructions for installing the C Authentication Plugin, which 
+   facilitates authentication between the BI Connector and SQL clients 
+   such as :doc:`Tableau </connect/tableau>` and the 
+   :doc:`MySQL shell </connect/mysql>`.
+
+:doc:`/reference/auth-plugin-jdbc`
+   Instructions for installing the JDBC Authentication Plugin.
 
 For more
 information on connecting BI Tools to the |bi-short|, see
@@ -308,11 +315,10 @@ and password), |ldap|, or Kerberos:
 
 .. include:: /includes/auth-mechanisms-example.rst
 
-.. class:: hidden
 
-   .. toctree::
-      :titlesonly:
+.. toctree::
+   :titlesonly:
 
-      /reference/auth-plugin-c
-      /reference/auth-plugin-jdbc
-      /tutorial/kerberos
+   /reference/auth-plugin-c
+   /reference/auth-plugin-jdbc
+   /tutorial/kerberos
diff --git a/source/client-applications.txt b/source/client-applications.txt
@@ -75,16 +75,15 @@ Intelligence tools.
      link: https://docs.mongodb.com/bi-connector/current/connect/looker
 
 
-.. class:: hidden
-
-   .. toctree::
-      :titlesonly:
-
-      /connect/excel
-      /connect/mysql
-      /connect/tableau
-      /connect/qlik
-      /connect/microstrategy
-      /connect/powerbi
-      /connect/spotfire-cloud
-      /connect/looker
+
+.. toctree::
+   :titlesonly:
+
+   /connect/excel
+   /connect/mysql
+   /connect/tableau
+   /connect/qlik
+   /connect/microstrategy
+   /connect/powerbi
+   /connect/spotfire-cloud
+   /connect/looker
diff --git a/source/components.txt b/source/components.txt
@@ -37,12 +37,11 @@ The following tools are available for use with the |bi|:
   facilitate secure transmission of authentication credentials between
   :binary:`~bin.mongosqld` and a MySQL client.
 
-.. class:: hidden
 
-   .. toctree::
-      :titlesonly:
+.. toctree::
+   :titlesonly:
 
-      /reference/mongosqld
-      /reference/mongodrdl
-      /reference/mongotranslate
-      MongoDB ODBC Driver </reference/odbc-driver>
+   /reference/mongosqld
+   /reference/mongodrdl
+   /reference/mongotranslate
+   MongoDB ODBC Driver </reference/odbc-driver>
diff --git a/source/connect/tableau-no-auth.txt b/source/connect/tableau-no-auth.txt
@@ -1,5 +1,7 @@
 :noprevnext:
 
+.. _connect-with-tableau:
+
 ==============================================================
 Connect from Tableau Desktop without Authentication or TLS/SSL
 ==============================================================
diff --git a/source/connect/tableau.txt b/source/connect/tableau.txt
@@ -6,22 +6,9 @@ Connect from Tableau Desktop
 
 .. default-domain:: mongodb
 
-.. contents:: On this page
-   :local:
-   :backlinks: none
-   :depth: 1
-   :class: singlecol
+.. toctree::
+   :titlesonly:
 
-.. _connect-with-tableau:
-
-.. versionadded:: 2.2
-
-.. include:: /includes/toc/dfn-list-tableau.rst
-.. class:: hidden
-
-   .. toctree::
-      :titlesonly:
-
-      /connect/tableau-no-auth
-      /connect/tableau-auth
-      /connect/tableau-auth-ssl
+   /connect/tableau-no-auth
+   /connect/tableau-auth
+   /connect/tableau-auth-ssl
diff --git a/source/includes/c-auth-supported-platforms.rst b/source/includes/c-auth-supported-platforms.rst
@@ -8,7 +8,6 @@ The plugin is built and tested on the following platforms:
 
 - RHEL 7.0 (64-bit)
 
-.. admonition:: Testing Environment
-   :class: important
+.. important:: Testing Environment
 
    .. include:: /includes/fact-c-auth-compatibility.rst
diff --git a/source/includes/fact-mongodrdl-example.rst b/source/includes/fact-mongodrdl-example.rst
@@ -11,7 +11,7 @@ database ``test``:
 
 Run :binary:`~bin.mongodrdl` to generate a schema based on this collection:
 
-.. class:: copyable-code
+
 .. code-block:: sh
 
    mongodrdl -d test -c abc -o schema.drdl
diff --git a/source/includes/fact-v210-schema-options.rst b/source/includes/fact-v210-schema-options.rst
@@ -1,2 +1,2 @@
 To learn more about version 2.10's schema options, see the
-:v2.10:`2.10 documentation </reference/mongosqld/#schema-options>`.
+:bic-v2.10:`2.10 documentation </reference/mongosqld/#schema-options>`.
diff --git a/source/includes/steps-local-quickstart.yaml b/source/includes/steps-local-quickstart.yaml
@@ -82,7 +82,7 @@ level: 4
 stepnum: 3
 content: |
   Create a System DSN by following instructions in the :ref:`tutorial
-  <create-system-dsn>`. For the
+  <create-system-dsn-bi-connector>`. For the
   purposes of this local test installation you can leave the
   :guilabel:`User`, :guilabel:`Password` and :guilabel:`Authentication`
   fields blank, because :binary:`~bin.mongosqld` is running without the
diff --git a/source/index.txt b/source/index.txt
@@ -32,6 +32,7 @@ business intelligence tools.
 .. figure:: /images/bi-connector/cloud-none-vert.png
    :figwidth: 536px
    :align: center
+   :alt: Diagram showing that other BI tools communicate with the DSN, which communicates with MongoDB's BI Connector, which in turn communicates with the MongoDB database.
 
 System Components
 -----------------
@@ -119,20 +120,19 @@ data visualization with |bi-short|.
 Learn more about setting up a local |bi-short| test installation
 in the :doc:`Quick Start Guide </local-quickstart>`.
 
-.. class:: hidden
-
-   .. toctree::
-      :titlesonly:
-
-      Quick Start Guide </local-quickstart>
-      /atlas-bi-connector
-      Install BI Connector</installation>
-      /launch
-      /tutorial/create-system-dsn
-      Connect BI Tools </client-applications>
-      /authentication
-      /schema-configuration
-      Components </components>
-      /reference
-      FAQ </faq>
-      Release Notes </release-notes>
+
+.. toctree::
+   :titlesonly:
+
+   Quick Start Guide </local-quickstart>
+   /atlas-bi-connector
+   Install BI Connector</installation>
+   /launch
+   /tutorial/create-system-dsn
+   Connect BI Tools </client-applications>
+   /authentication
+   /schema-configuration
+   Components </components>
+   /reference
+   FAQ </faq>
+   Release Notes </release-notes>
diff --git a/source/installation.txt b/source/installation.txt
@@ -23,7 +23,14 @@ the guide for your platform below to install the |bi-short|, or see
 Installation Guides
 -------------------
 
-.. include:: /includes/toc/dfn-list-install.rst
+:doc:`/tutorial/install-bi-connector-windows`
+    Instructions for installing the BI Connector on Windows systems.
+:doc:`/tutorial/install-bi-connector-macos`
+    Instructions for installing the BI Connector on macOS systems.
+:doc:`/tutorial/install-bi-connector-rhel`
+    Instructions for installing the BI Connector on RHEL-based systems.
+:doc:`/tutorial/install-bi-connector-debian`
+    Instructions for installing the BI Connector on debian-based systems. 
 
 Supported Platforms
 -------------------
@@ -87,12 +94,11 @@ systems:
 
 - PPC64LE systems running Red Hat Enterprise Linux 7.1+
 
-.. class:: hidden
 
-   .. toctree::
-      :titlesonly:
+.. toctree::
+   :titlesonly:
 
-      /tutorial/install-bi-connector-windows
-      /tutorial/install-bi-connector-macos
-      /tutorial/install-bi-connector-rhel
-      /tutorial/install-bi-connector-debian
+   /tutorial/install-bi-connector-windows
+   /tutorial/install-bi-connector-macos
+   /tutorial/install-bi-connector-rhel
+   /tutorial/install-bi-connector-debian
diff --git a/source/launch.txt b/source/launch.txt
@@ -223,7 +223,7 @@ Install ``mongosqld`` as a System Service
        content: |
 
 |bi-short| requires a configuration file with the
-:setting:`systemLog.path` setting specified when running as a
+:setting:`~mongosqld.systemLog.path` setting specified when running as a
 system service. Using your preferred text editor, create a
 ``mongosqld.conf`` file. To review the configuration file options,
 see :ref:`Configuration File <config-format>`. For example:
diff --git a/source/reference.txt b/source/reference.txt
@@ -4,23 +4,13 @@ Reference
 
 .. default-domain:: mongodb
 
-.. contents:: On this page
-   :local:
-   :backlinks: none
-   :depth: 1
-   :class: singlecol
+.. toctree::
+   :titlesonly:
 
-.. include:: /includes/toc/dfn-list-reference-landing.rst
-
-.. class:: hidden
-
-   .. toctree::
-      :titlesonly:
-
-      /tutorial/ssl-setup
-      /reference/drdl
-      /reference/log-messages
-      /reference/type-conversion
-      /reference/user-authorization
-      /reference/system-variables
-      /supported-operations
+   /tutorial/ssl-setup
+   /reference/drdl
+   /reference/log-messages
+   /reference/type-conversion
+   /reference/user-authorization
+   /reference/system-variables
+   /supported-operations
diff --git a/source/reference/auth-plugin-jdbc.txt b/source/reference/auth-plugin-jdbc.txt
@@ -17,16 +17,18 @@ JDBC Authentication Plugin
 Prerequisites
 -------------
 
-This plugin requires a version of MySQL Connector/J between :mvn:`5.1.39 </mysql/mysql-connector-java/5.1.39>` and the latest 5.1.x. It can't use MySQL Server or MySQL Connector/J 8.0 or later.
+This plugin requires a version of MySQL Connector/J between 
+`5.1.39 <https://mvnrepository.com/artifact/mysql/mysql-connector-java/5.1.39>`__ 
+and the latest 5.1.x. It can't use MySQL Server or MySQL Connector/J 8.0 or later.
 
 Installing the Plugin
 ---------------------
 
 To download the plugin ``.jar`` file, choose one of the following
 options:
 
-Download from the :gh:`GitHub repository </mongodb/mongosql-auth-java/releases/>`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Download from the :github:`GitHub repository </mongodb/mongosql-auth-java/releases/>`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 1. Select the ``.jar`` file from the download site.
 
@@ -35,7 +37,7 @@ Download from the :gh:`GitHub repository </mongodb/mongosql-auth-java/releases/>
 Use `Maven <https://maven.apache.org/>`__
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-1. Include the :mvn:`{+java-plugin+} </org.mongodb/mongosql-auth>`
+1. Include the `{+java-plugin+} <https://mvnrepository.com/artifact/org.mongodb/mongosql-auth>`__
    library in the ``CLASSPATH``. The Maven coordinates are:
 
    .. code-block:: xml
@@ -48,9 +50,9 @@ Use `Maven <https://maven.apache.org/>`__
 
    .. seealso::
       To learn more about Maven, refer to its `documentation site
-      <https://maven.apache.org/guides/index.html>`_.
+      <https://maven.apache.org/guides/index.html>`__.
 
-#. Include :mvn:`MySQL Connector/J </mysql/mysql-connector-java>`
+#. Include `MySQL Connector/J <https://mvnrepository.com/artifact/mysql/mysql-connector-java>`__
    in the ``CLASSPATH``. The Maven coordinates are:
 
    .. code-block:: xml
@@ -70,7 +72,8 @@ Use `Maven <https://maven.apache.org/>`__
    .. seealso::
 
       To learn about the ``authenticationPlugins`` query parameter,
-      see the :mysql:`MySQL documentation </doc/connector-j/5.1/en/connector-j-reference-configuration-properties.html>`.
+      see the `MySQL documentation 
+      <https://dev.mysql.com/doc/connector-j/5.1/en/connector-j-reference-configuration-properties.html>`__.
 
    You may also specify the authentication mechanism and authentication
    source as a query parameter on the ``username``.
diff --git a/source/reference/mongodrdl.txt b/source/reference/mongodrdl.txt
diff --git a/source/reference/mongosqld.txt b/source/reference/mongosqld.txt
diff --git a/source/reference/mongotranslate.txt b/source/reference/mongotranslate.txt
diff --git a/source/release-notes.txt b/source/release-notes.txt
diff --git a/source/schema-configuration.txt b/source/schema-configuration.txt
diff --git a/source/tutorial/create-system-dsn.txt b/source/tutorial/create-system-dsn.txt
diff --git a/source/tutorial/kerberos.txt b/source/tutorial/kerberos.txt
diff --git a/worker.sh b/worker.sh

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`To learn more about version 2.10's schema options, see the`
`2`		-:v2.10:`2.10 documentation </reference/mongosqld/#schema-options>`.
	`2`	+:bic-v2.10:`2.10 documentation </reference/mongosqld/#schema-options>`.