WRITING-1619: BI Connector 2.0

Author: i80and

.gitignore

@@ -6,4 +6,4 @@ DS_Store
 meta.yaml
 fabfile
 giza.log
-source/figures/
+source/images

Makefile

@@ -6,18 +6,25 @@ STAGING_BUCKET=docs-mongodb-org-staging
 PRODUCTION_BUCKET=docs-mongodb-org-prod
 PREFIX=bi-connector
 
-.PHONY: help stage fake-deploy deploy
+.PHONY: help html publish stage fake-deploy deploy
 
 help:
 	@echo 'Targets'
+	@echo '  html        - Build HTML for this branch'
 	@echo '  help         - Show this help message'
 	@echo '  stage        - Host online for review'
 	@echo '  fake-deploy  - Create a fake deployment in the staging bucket'
 	@echo '  deploy       - Deploy to the production bucket'
-	@echo ''
+	@echo
 	@echo 'Variables'
 	@echo '  ARGS         - Arguments to pass to mut-publish'
 
+html:
+	giza make html
+
+publish:
+	giza make publish
+
 stage:
 	mut-publish build/${GIT_BRANCH}/html ${STAGING_BUCKET} --prefix=${PREFIX} --stage ${ARGS}
 	@echo "Hosted at ${STAGING_URL}/${PREFIX}/${USER}/${GIT_BRANCH}/index.html"
@@ -28,10 +35,10 @@ fake-deploy: build/public
 
 deploy: build/public
 	@echo "Doing a dry-run"
-	mut-publish build/public ${PRODUCTION_BUCKET} --prefix=${PREFIX} --deploy --verbose --all-subdirectories --dry-run ${ARGS}
+	mut-publish build/public ${PRODUCTION_BUCKET} --prefix=${PREFIX} --deploy --verbose --dry-run --redirect-prefix='bi-connector' ${ARGS}
 
-	@echo ''
+	@echo
 	read -p "Press any key to perform the previous"
-	mut-publish build/public ${PRODUCTION_BUCKET} --prefix=${PREFIX} --deploy --all-subdirectories ${ARGS}
+	mut-publish build/public ${PRODUCTION_BUCKET} --prefix=${PREFIX} --deploy --redirect-prefix='bi-connector' ${ARGS}
 
 	@echo "Hosted at ${PRODUCTION_URL}/${PREFIX}/index.html"

README.rst

@@ -6,17 +6,24 @@ This repository contains documentation regarding components of the
 the MongoDB Connector for BI (Business Intelligence). This documentation
 builds on the work of the `MongoDB Manual <http://docs.mongodb.org/manual/>`_.
 
-If you already have `giza <https://pypi.python.org/pypi/giza/>`_
-installed, you can download and build this documentation locally with
-the following command: ::
+Building
+--------
 
-     git clone git://github.com/mongodb/docs-bi-connector
-     cd docs-bi-connector/
-     giza make html
+First install `mut <https://github.com/mongodb/mut>`_.
 
-View ``build/html/index.html`` to view your current build of the
+Then you can download and build this documentation locally with
+the following command:
+
+    git clone https://github.com/mongodb/docs-bi-connector.git
+    cd docs-bi-connector/
+    make build
+
+View ``build/master/html/index.html`` to view your current build of the
 documentation.
 
+Contributing
+------------
+
 To contribute to the documentation, please fork this repository on
 GitHub and issue a pull request. If you have not done so already,
 please sign the `MongoDB/10gen Contributor Agreement

conf.py

@@ -5,6 +5,7 @@
 #
 # This file is execfile()d with the current directory set to its containing dir.
 
+import base64
 import sys
 import os.path
 import datetime
@@ -59,22 +60,13 @@
 extlinks = {
     'issue': ('https://jira.mongodb.org/browse/%s', '' ),
     'manual': ('http://docs.mongodb.com/manual%s', ''),
-
+    'v3.4': ('http://docs.mongodb.com/v3.4%s', ''),
 }
 
 intersphinx_mapping = {}
-
-try:
-    for i in intersphinx_libs:
-        intersphinx_mapping[i['name']] = ( i['url'], os.path.join(conf.paths.projectroot,
-                                                              conf.paths.output,
-                                                              i['path']))
-except:
-    for i in intersphinx_libs:
-        intersphinx_mapping[i.name] = ( i.url, os.path.join(conf.paths.projectroot,
-                                                              conf.paths.output,
-                                                              i.path))
-
+for i in intersphinx_libs:
+    intersphinx_mapping[i.name] = (i.url, os.path.join(conf.paths.projectroot,
+                                                       conf.paths.output, i.path))
 
 languages = [
     ("ar", "Arabic"),

config/build_conf.yaml

@@ -5,7 +5,7 @@ git:
 project:
   name: 'bi-connector'
   tag: 'bi-connector'
-  url: 'http://docs.mongodb.com'
+  url: 'https://docs.mongodb.com/bi-connector/'
   title: "MongoDB Connector for BI"
   branched: true
 system:
@@ -27,15 +27,17 @@ system:
     - 'push.yaml'
     - 'integration.yaml'
     - 'sphinx_local.yaml'
-    - images: '/source/images/metadata.yaml'
     - htaccess: ['htaccess.yaml']
 version:
   release: '2.0'
   branch: 'master'
 assets:
   - branch: master
     path: build/docs-tools
-    repository: http://github.com/mongodb/docs-tools.git
+    repository: https://github.com/mongodb/docs-tools.git
+  - branch: bi-connector
+    path: source/images/bi-connector
+    repository: https://github.com/mongodb/docs-assets.git
 paths:
   output: 'build'
   source: 'source'

config/htaccess.yaml

@@ -0,0 +1,51 @@
+# Each YAML document has the following schema:
+#
+# from: "the path to the redirected URL"
+# to: "the path to the new location for the resource"
+# type: "currently this script only supports 'redirect', and
+#        ignores all documents with another type."
+# code: "the HTTP redirect code. Raises exception if not 301, 302, 303."
+# outputs: "a list of branches/paths as follows:"
+#
+# - 'all': generates redirects for all published branches, but *not* 'manual'. But giza will take care of manual as part of integration.yaml logic in redirects.py
+#
+# - '<branch>': generates redirects for a specific branch.
+#
+# - 'before-<branch>': generates redirects for all branches that
+#   reflect releases previous to the specified branch. (Inclusive.)
+#
+# - 'after-<branch>': generates redirects for all branches that
+#   reflect releases after the specified branch. (Non-inclusive.)
+#
+# All paths are relative to the ``source/`` directory.
+#
+########################################################################
+
+from: '/reference/mongobiuser'
+to: '/components'
+type: 'redirect'
+code: 301
+outputs:
+  - 'after-v1.1': {'/bi-connector': 'https://docs.mongodb.com/bi-connector'}
+---
+from: '/reference/mongobischema'
+to: '/components'
+type: 'redirect'
+code: 301
+outputs:
+  - 'after-v1.1': {'/bi-connector': 'https://docs.mongodb.com/bi-connector'}
+---
+from: '/reference/mongosqld'
+to: '/components'
+type: 'redirect'
+code: 301
+outputs:
+  - 'before-v1.1': {'/bi-connector': 'https://docs.mongodb.com/bi-connector'}
+---
+code: 301
+from: '/'
+to: '/v1.1'
+outputs:
+  - {'/bi-connector': 'https://docs.mongodb.com/bi-connector'}
+type: redirect
+...

config/intersphinx.yaml

@@ -2,7 +2,7 @@ name: mongodb
 url: https://docs.mongodb.com/manual/
 path: mongodb.inv
 ---
-name: python2
+name: python
 url: https://docs.python.org/2/
 path: python2.inv
 ...

source/components.txt

@@ -10,21 +10,29 @@ MongoDB Connector for BI Components
    :depth: 1
    :class: singlecol
 
+.. versionchanged:: 2.0
+   Version 2.0 of the |bi| introduces a new architecture that replaces
+   the previous PostgreSQL foreign data wrapper with the new
+   :program:`mongosqld`.
+
+   As a result, the |bi| no longer requires ``mongobiuser`` and
+   ``mongobischema``.
+
+   .. include:: /includes/fact-upgrade.rst
+
 .. include:: /includes/fact-bi-enterprise.rst
 
 The |bi| provides a suite of configuration tools.
 
-- :program:`mongobiuser` can modify users in the |bi|.
 - :program:`mongodrdl` generates database schema information for use
   with the |bi|.
-- :program:`mongobischema` will load the resulting files
-  into the |bi|.
+- :program:`mongosqld` proxies incoming queries between a MySQL client
+  and a MongoDB server.
 
 .. class:: hidden
 
    .. toctree::
       :titlesonly:
 
-      /reference/mongobiuser
       /reference/mongodrdl
-      /reference/mongobischema
+      /reference/mongosqld