Patch 14

.gitignore

@@ -8,7 +8,7 @@ build/*
 *.bak
 .DS_Store
 source/includes/hash.rst
-source/includes/install-curl-release*.rst
+source/includes/install-*-release-*.rst
 source/includes/table-*.rst
 source/includes/toc-*.rst
 source/includes/dfn*.rst
@@ -35,3 +35,5 @@ docs_meta.yaml
 fabfile
 source/includes/toc/
 source/includes/table/
+source/includes/steps/
+source/includes/manpage-options-audit-settings.rst

README.rst

@@ -5,16 +5,18 @@ MongoDB Documentation
 This repository contains a major revision of the MongoDB
 documentation, currently accessible at <http://docs.mongodb.org/manual/>.
 You can download and build locally if you already have `Sphinx
-<http://sphinx.pocoo.org/>`_ installed, with the following command: ::
+<http://sphinx.pocoo.org/>`_ and other dependencies installed, with
+the following command: ::
 
      git clone git://github.com/mongodb/docs
      cd docs/
+     python bootstrap.py
      make html
 
 Visit ``docs/mongodb/build/html/index.html`` to view the current state
-of the documentation. You may also wish to install `Pygments
-<http://pygments.org>`_ to provide syntax highlighting for code
-examples.
+of the documentation. See `MongoDB Documentation Buildsystem
+<http://docs.mongodb.org/manual/meta/build/>`_ for complete
+instructions on building the MongoDB documentation.
 
 To contribute to the documentation please fork this repository on
 GitHub and issue a pull request. File issue reports or requests at the

bin/builddata/htaccess.yaml

@@ -33,13 +33,85 @@ outputs:
   - 'v2.2'
 ---
 redirect-path: '/MongoDB-Manual.epub'
-url-base: '/MongoDB-manual.epub'
+url-base: '/mongoDB-manual.epub'
 type: 'redirect'
 code: 301
 outputs:
   - 'all'
   - 'manual'
 ---
+redirect-path: '/MongoDB-manual.epub'
+url-base: '/mongodb-manual.epub'
+type: 'redirect'
+code: 301
+outputs:
+  - 'all'
+  - 'manual'
+---
+redirect-path: '/MongoDB-manual.epub'
+url-base: '/mongodb-manual.epub'
+type: 'redirect'
+code: 301
+outputs:
+  - 'all'
+  - 'manual'
+---
+redirect-path: '/MongoDB-manual-master.epub'
+url-base: '/mongodb-manual.epub'
+type: 'redirect'
+code: 301
+outputs:
+  - 'master'
+---
+redirect-path: '/MongoDB-Manual-master.epub'
+url-base: '/mongodb-manual.epub'
+type: 'redirect'
+code: 301
+outputs:
+  - 'master'
+---
+redirect-path: '/MongoDB-Manual-master.epub'
+url-base: '/mongodb-manual.epub'
+type: 'redirect'
+code: 301
+outputs:
+  - 'master'
+---
+redirect-path: '/MongoDB-manual-master.epub'
+url-base: '/mongodb-manual-master.epub'
+type: 'redirect'
+code: 301
+outputs:
+  - 'master'
+---
+redirect-path: '/MongoDB-Manual-v2.4.epub'
+url-base: '/mongodb-manual-v2.4.epub'
+type: 'redirect'
+code: 301
+outputs:
+  - 'v2.4'
+---
+redirect-path: '/MongoDB-manual-v2.4.epub'
+url-base: '/mongodb-manual-v2.4.epub'
+type: 'redirect'
+code: 301
+outputs:
+  - 'v2.4'
+---
+redirect-path: '/MongoDB-Manual-v2.2.epub'
+url-base: '/mongodb-manual-v2.2.epub'
+type: 'redirect'
+code: 301
+outputs:
+  - 'v2.2'
+---
+redirect-path: '/MongoDB-manual-master.epub'
+url-base: '/mongodb-manual-v2.2.epub'
+type: 'redirect'
+code: 301
+outputs:
+  - 'v2.2'
+---
 redirect-path: '/core/replica-set-high-availability'
 url-base: '/core/replication'
 type: 'redirect'

bin/builddata/integration.yaml

@@ -1,19 +1,23 @@
-targets:
-  - 'latex'
-  - 'json'
-  - 'html'
-  - 'man'
-  - 'sitemap'
-doc-root:
-  - 'sitemap.xml'
-  - 'osd.xml'
-  - 'manual'
-  - '.htaccess'
-  - '10gen-gpg-key.asc'
-  - '10gen-security-gpg-key.asc'
-branch-root:
-  - ''
-  - 'MongoDB-manual.epub'
-  - 'single'
-  - [ 'single', 'index.html' ]
+fr:
+  inherit: base
+es:
+  inherit: base
+ja:
+  inherit: base
+zh:
+  inherit: base
+it:
+  inherit: base
+base:
+  targets:
+    - 'latex'
+    - 'json'
+    - 'singlehtml'
+    - 'html'
+    - 'man'
+    - 'epub'
+    - 'dirhtml'
+  doc-root: ['manual']
+  branch-root:
+    - ''
 ...

bin/builddata/intersphinx.yaml

@@ -18,6 +18,10 @@ name: python3
 url: http://docs.python.org/3/
 path: python3.inv
 ---
+name: sphinx
+url: http://sphinx-doc.org/
+path: sphinx.inv  
+---
 name: django
 url: https://django.readthedocs.org/en/latest/
 path: django.inv

bin/builddata/migrations.yaml

@@ -4,18 +4,24 @@
 # The build system generator will only use the first two items of the
 # document in any list.
 
-target: '$(branch-output)/dirhtml'
-dependency: 'dirhtml'
-action: 'touch'
+target: $(branch-output)/sitemap.xml.gz
+dependency:
+  - $(public-branch-output)
+  - $(public-output)/manual
+  - links
+command: "fab generate.sitemap"
+message: "[sitemap]: sitemap build complete at `date`."
+action: cmd
+---
+target: '$(public-output)/manual'
+dependency: 'v2.4'
+action: 'link'
+type: 'phony'
 ---
 target: '$(branch-output)/html'
 dependency: 'html'
 action: 'touch'
 ---
-target: '$(branch-output)/singlehtml'
-dependency: 'singlehtml'
-action: 'touch'
----
 target: setup
 dependency:
   - 'mongodb-domain.yaml'
@@ -26,37 +32,6 @@ dependency: 'bin/builddata/mongodb-domain.yaml'
 action: 'cp'
 type: 'build'
 ---
-target: '$(branch-output)/singlehtml/contents.html'
-dependency: '$(branch-output)/singlehtml'
-action: 'dep'
----
-target: '$(public-branch-output)/MongoDB-manual.epub'
-dependency: '$(public-branch-output)/MongoDB-manual-$(current-branch).epub'
-action: 'dep'
----
-target: '$(public-branch-output)/MongoDB-Manual-$(current-branch).epub'
-dependency: '$(branch-output)/epub/mongodb-manual.epub'
-action: 'dep'
----
-target: '$(branch-output)/epub/mongodb-manual.epub'
-dependency: 'epub'
-action: 'dep'
----
-target: '$(public-branch-output)'
-dependency: '$(branch-output)/dirhtml'
-action: 'transfer'
-filter:
-  - '/meta/reference'
-  - '/meta/use-cases'
-  - '/meta/administration'
-  - '/meta/manual'
----
-target: '$(public-branch-output)/single'
-dependency: '$(branch-output)/singlehtml'
-action: 'transfer'
-filter:
-  - '/contents.html'
----
 target: '$(public-output)/sitemap.xml'
 dependency: 'source/.static/sitemap.xml'
 action: 'cp'
@@ -81,50 +56,12 @@ target: 'manpages'
 dependency: 'man'
 action: 'dep'
 ---
-target: '$(public-branch-output)/sitemap.xml.gz'
-dependency: '$(branch-output)/sitemap.xml.gz'
-action: 'cp'
-type: 'access'
----
-target: '$(public-branch-output)/single/search.html'
-dependency: '$(branch-output)/dirhtml/search/index.html'
-action: 'cp'
-type: 'content'
----
-target: '$(public-branch-output)/MongoDB-manual-$(current-branch).epub'
-dependency: '$(branch-output)/epub/mongodb-manual.epub'
-action: 'cp'
-type: 'content'
----
-target: '$(public-output)/manual'
-dependency: '$(manual-branch)'
-action: 'link'
-type: 'structural'
----
-target: '$(public-branch-output)/MongoDB-manual.epub'
-dependency: 'MongoDB-manual-$(current-branch).epub'
-action: 'link'
-type: 'phony'
----
 target: '$(public-output)/'
 action: 'mkdir'
 ---
 target: '$(output)'
 action: 'mkdir'
 ---
-target: $(branch-output)/sitemap.xml.gz
-dependency:
-  - $(public-branch-output)
-  - $(public-output)/manual
-  - links
-command: "fab generate.sitemap"
-message: "[sitemap]: sitemap build complete at `date`."
-action: cmd
----
-target: sitemap
-dependency: $(branch-output)/sitemap.xml.gz
-action: dep
----
 target: htaccess
 dependency: $(public-output)/.htaccess
 action: dep
@@ -135,9 +72,4 @@ dependency:
   - $(tools)/bin/htaccess.py
 command: "fab generate.htaccess:$(public-output)/.htaccess"
 action: cmd
----
-target: "$(public-branch-output)/single/index.html"
-dependency: "$(branch-output)/singlehtml/contents.html"
-command: "fab process.input:$(branch-output)/singlehtml/contents.html process.output:$(public-branch-output)/single/index.html process.manual_single_html"
-action: cmd
 ...

bin/builddata/push.yaml

@@ -1,54 +1,54 @@
 target: push
-paths: 
+paths:
   remote: /data/sites/docs
   local: public
-  static: ['.htaccess', 'manual']
+  static: ['manual']
 options: ['branched', 'recursive']
 env: publication
 dependency: push-if-up-to-date
 ---
 target: push-all
-paths: 
+paths:
   remote: /data/sites/docs
   local: public
-  static: '.htaccess'
+  static: ['manual']
 options: ['recursive']
 branched: false
 env: publication
 dependency: publish
 ---
 target: push-with-delete
-paths: 
+paths:
   remote: /data/sites/docs
   local: public
-  static: ['.htaccess', 'manual']
+  static: ['manual']
 options: ['delete', 'branched', 'recursive']
 env: publication
 dependency: publish
 ---
 target: stage
-paths: 
+paths:
   remote: /srv/public/test
   local: public
-  static: 'manual'
-options: ['branched', 'recursive']
+  static: [ 'manual' ]
+options: [ 'branched', 'recursive' ]
 env: staging
 dependency: stage-if-up-to-date
 ---
 target: stage-all
-paths: 
+paths:
   remote: /srv/public/test
   local: public
-  static: 'manual'
+  static: ['manual']
 options: ['recursive']
 env: staging
 dependency: publish
 ---
 target: stage-with-delete
-paths: 
+paths:
   remote: /srv/public/test
   local: public
-  static: 'manual'
+  static: ['manual']
 options: ['delete', 'branched', 'recursive']
 env: staging
 dependency: publish