prep manual to build on snooty (master branch)

DOP-1186: initial prep for manual build on snooty

trivial

mayve fix the columns problem?

DOP-1186: adding the landign pages, intersphinx, etc.

add version source constant

fix name in snooty.toml

test

DOP-1186: admonition class note -> .. note::

DOP-1186: admonition :class: warning -> .. warning::

DOP-1186: admonition :class: important -> .. important::

DOP-1186: remove all copyable-code class instances

DOP-1186: removes legacy .. class:: hidden from TOCs

DOP-1186: address monospace text  md/reST issues

Revert "DOP-1186: remove all copyable-code class instances"

This reverts commit 291a137.

DOP-1186: remove all copyable-code class instances along with leading whitespace

testing!

address class / only deprecation warnings

use highlight roles for map-reduce, tidying

removes 380 instances of the container directive

remaining admonitions and fix yaml spacing

tidy up mongodb web shell references

remaining onlys

fixfixfix

mostly fixing monospaced text that used md not reST

monospace text uses TWO backticks

minor

no includes in replacements

monospace fix

fix wonkiness

more fixes

fix wonkiness

Docsp 12590 address broken links nextgen (mongodb#9)

* (DOCSP-12590): Fix broken links

* add missing alt tags to figure directives

* unlink mongosniff

* correct mongo shell links

* correct mongod binary link

* remove install_compass link

* link mongo.exe to only mongo binary page

* add missing $ to $[<identifier>] link

* fix lastHeartbeat and lastHeartbeatRecv capitalization in links

* unrelated MONGODB-CR typo fix

* fix exe links

* adds additional missing alt tags to figures

* fix broken [<identifier>] links

* fix members[n] links

* fix connPoolStats.replicaSets.[replicaSets].hosts links

* fix dupe replSetGetStatus.members[n].self entry

* fix dupe readconcern target

* fix glossary term capitalizations

* fix most expression link issues

* fix some authaction links

* remove link attempt to PyMongo for general Python method re.compile

* fix most :setting: links

* mongooplog removed in v3.6

* fix BSON binary type links

* correct sh.status.active-mongoses ambig reference

* fix output example indentation

* fix currentOp ambig targets

* unlink removed cmd authSchemaUpgrade

* unlink removed cmd cloneCollection

* unlink removed cmd closeAllDatabases

* unlink removed cmd copydb

* unlink removed cmd createIndex .. which isn't createIndexes

* fix cmd getLastError

* fix cmd dbHash capitalization

* unlink removed cmd eval

* fix cmd findAndModify capitalization

* fix cmd findAndModify capitalization - another instance

* fix cmd getCollectionInfos to method

* fix cmd getLastError.waited to data

* fix cmd getParameters to singular

* unlink removed cmd indexStats

* fix cmd isSelf to include underscore

* fix cmd listCollection to plural

* fix cmd listDatabase to plural

* fix cmd mongod to binary

* unlink removed cmd planCacheListPlans

* unlink removed cmd planCacheListQueryShapes

* unlink removed cmd repairDatabase

* unlink removed cmd replSetHeartbeat

* fix typo cmd replSetInitiate

* unlink removed cmd restoreDatabase

* unlink removed cmd resync

* fix cmd setParameters to singular

* fix cmd splitAt to method

* fix cmd stats to method

* unlink removed cmd storageDetails

* unlink removed cmd text

* unlink removed cmd touch

* fix method Bulk.find.upsert()

* fix method getKeyVault() malformed link

* unlink removed method PlanCache.getPlansByQuery()

* unlink removed method PlanCache.listQueryShapes()

* fix method Session.getOptions() malformed link

* fix method db.collection.watch() malformed link

* fix method db.copyDatabase() malformed link

* fix method cursor.readPref() malformed link - setReadPref is for a Mongo connection obj

* unlink removed method cursor.showDiskLoc()

* unlink removed method db.addUser()

* unlink removed method db.cloneCollection()

* fix method db.collection.explain() malformed link

* fix method db.help() malformed link

* fix methods db.createRole, db.createUser, db.dropAllUsers malformed definitions, breaking all links

* fix method db.dropUser malformed definition, breaking all links

* fix method db.getMongo() malformed link

* fix method db.serverStatus() malformed link

* fix methods db.grantPrivilegesToRole, db.grantRolesToRole, db.revokePrivilegesFromRole, db.revokeRolesFromRole, db.revokeRolesFromUser malformed definitions, breaking all links

* fix method db.dropAllRoles() malformed link

* fix method db.grantPrivilegesToRole() malformed link

* fix method db.grantRolesToRole() malformed link

* fix method db.grantRolesToUser() malformed definitions, breaking all links, and fix malformed link

* fix method db.revokeRolesFromRole() malformed link

* unlink removed method db.loadServerScripts()

* unlink removed method db.serverShutdown()

* Revert "unlink removed method db.serverShutdown()"

This reverts commit e6a6fd5.

* fix method db.shutdownServer() - wrong in SERVER ticket name

* fix method rs.stepDown() capitalization

* unlink removed method sh.getRecentMigrations

* fix method db.updateRole() malformed link

* fix method db.watch() malformed link

* fix method db.serverStatus() capitalization

* fix method db.getMongo() malformed link

* fix methods db.grantRolesToUser() and db.revokeRolesFromUser() malformed links

* unlink undocumented disableLogicalSessionCacheRefresh param

* unlink removed logicalSessionRefreshMinutes param, update ref to Millis where appropriate

* unlink removed newCollectionsUsePowerOf2Sizes param

* remove test bump

Co-authored-by: jeff-allen-mongo <[email protected]>
Co-authored-by: Andrew Feierabend <[email protected]>

more cleaning up

more little link fixes

resolve merge conflict

test fix for gridfx issue

replace ecosystem with driver

DOP-1817, DOP-1821: remove agg gif and hardlink instances

fix aggregation copy to reflect gif removal

DOP-1819: update toc_landing_pages to behave properly

DOP-1808: fix seealsos

DOP-1808: fix sees

fix indentation

more identation'

DOP-1908: remove index instances from manual

update pymongo intersphinx inventory

python work please?

make linearizable not hidden & below title

replicable?

mysterious dedenting is mysterious

DOP-1963: update security table

add widths to security table

widths again

wiggling

testing

more tests

Author: schmalliso

config/migrations.yaml

@@ -10,7 +10,7 @@ dependency:
   # - $(public-output)/manual
   - links
 command: "fab generate.sitemap"
-message: "[sitemap]: sitemap build complete at `date`."
+message: "[sitemap]: sitemap build complete at ``date``."
 action: cmd
 ---
 # target: '$(public-output)/manual'

draft/use-cases/ad-campaign-management.txt

@@ -145,5 +145,7 @@ TODO: describe indexes to optimize this query
 Sharding
 --------
 
-.. seealso:: ":doc:`/faq/sharding`" and the ":wiki:`Sharding` wiki
+.. seealso::
+
+   ":doc:`/faq/sharding`" and the ":wiki:`Sharding` wiki
    page.

draft/use-cases/social-networking-updates-and-profiles.txt

@@ -648,5 +648,7 @@ on ``_id``, then, you'll need to execute the following command:
    ...     'key': {'_id': 1 } } )
    { "collectionsharded": "social.post", "ok": 1 }
 
-.. seealso:: ":doc:`/faq/sharding`" and the ":wiki:`Sharding` wiki
+.. seealso::
+
+   ":doc:`/faq/sharding`" and the ":wiki:`Sharding` wiki
    page.

snooty.toml

@@ -1,16 +1,205 @@
-name = "manual"
+name = "docs"
+title = "MongoDB Manual"
+
+intersphinx = [ "https://pymongo.readthedocs.io/en/stable/objects.inv",
+                "https://motor.readthedocs.io/en/stable/objects.inv",
+                "https://docs.atlas.mongodb.com/objects.inv",
+                "https://docs.mongodb.com/php-library/master/objects.inv",
+                "https://docs.mongodb.com/compass/current/objects.inv",
+                "https://docs.mongodb.com/database-tools/objects.inv"
+               ]
+
+# toc_landing_pages are pages that have pages nested beneath them
+# and **should** open when a user clicks on that page in the TOC 
+# (i.e. they're not drawers)
+toc_landing_pages = [ 
+   "/administration",
+   "/administration/analyzing-mongodb-performance",
+   "/administration/backup-sharded-clusters",
+   "/administration/configuration-and-maintenance",
+   "/administration/install-community",
+   "/administration/install-enterprise-linux",
+   "/administration/install-enterprise",
+   "/administration/install-on-linux/",
+   "/administration/monitoring",
+   "/administration/replica-set-deployment",
+   "/administration/replica-set-maintenance",
+   "/administration/replica-set-member-configuration",
+   "/administration/sharded-cluster-administration",
+   "/administration/sharded-cluster-config-servers",
+   "/administration/upgrade-community-to-enterprise",
+   "/aggregation",
+   "/applications/indexes",
+   "/applications/replication",
+   "/changeStreams",
+   "/core/2d",
+   "/core/2dsphere",
+   "/core/aggregation-pipeline",
+   "/core/auditing",
+   "/core/authentication-mechanisms-enterprise",
+   "/core/authentication-mechanisms",
+   "/core/authentication",
+   "/core/authorization",
+   "/core/backups",
+   "/core/crud",
+   "/core/databases-and-collections",
+   "/core/geohaystack",
+   "/core/index-creation",
+   "/core/index-multikey",
+   "/core/index-text",
+   "/core/index-ttl",
+   "/core/index-wildcard",
+   "/core/journaling",
+   "/core/kerberos",
+   "/core/map-reduce",
+   "/core/query-optimization",
+   "/core/read-isolation-consistency-recency",
+   "/core/read-preference",
+   "/core/replica-set-architectures",
+   "/core/replica-set-high-availability",
+   "/core/replica-set-members",
+   "/core/replica-set-secondary",
+   "/core/security-automatic-client-side-encryption",
+   "/core/security-client-side-encryption-key-management",
+   "/core/security-client-side-encryption",
+   "/core/security-encryption-at-rest",
+   "/core/security-hardening",
+   "/core/security-internal-authentication",
+   "/core/security-ldap",
+   "/core/security-transport-encryption",
+   "/core/security-users",
+   "/core/security-x.509",
+   "/core/sharded-cluster-components",
+   "/core/sharding-balancer-administration",
+   "/core/sharding-data-partitioning",
+   "/core/storage-engines",
+   "/core/transactions",
+   "/core/wiredtiger",
+   "/core/zone-sharding",
+   "/core/zone-sharding",
+   "/crud",
+   "/geospatial-queries",
+   "/indexes",
+   "/installation",
+   "/introduction",
+   "/mongo",
+   "/reference/aggregation",
+   "/reference/bson-types",
+   "/reference/collation",
+   "/reference/command",
+   "/reference/command/nav-administration",
+   "/reference/command/nav-aggregation",
+   "/reference/command/nav-auditing",
+   "/reference/command/nav-authentication",
+   "/reference/command/nav-crud",
+   "/reference/command/nav-diagnostic",
+   "/reference/command/nav-free-monitoring",
+   "/reference/command/nav-geospatial",
+   "/reference/command/nav-plan-cache",
+   "/reference/command/nav-replication",
+   "/reference/command/nav-role-management",
+   "/reference/command/nav-sessions",
+   "/reference/command/nav-sharding",
+   "/reference/command/nav-user-management",
+   "/reference/configuration-options",
+   "/reference/method",
+   "/reference/method/js-bulk",
+   "/reference/method/js-client-side-field-level-encryption",
+   "/reference/method/js-collection",
+   "/reference/method/js-connection",
+   "/reference/method/js-constructor",
+   "/reference/method/js-cursor",
+   "/reference/method/js-database",
+   "/reference/method/js-free-monitoring",
+   "/reference/method/js-native",
+   "/reference/method/js-plan-cache",
+   "/reference/method/js-replication",
+   "/reference/method/js-role-management",
+   "/reference/method/js-sharding",
+   "/reference/method/js-user-management",
+   "/reference/operator/aggregation-pipeline",
+   "/reference/operator/aggregation",
+   "/reference/operator/query-array",
+   "/reference/operator/query-bitwise",
+   "/reference/operator/query-comparison",
+   "/reference/operator/query-element",
+   "/reference/operator/query-evaluation",
+   "/reference/operator/query-geospatial",
+   "/reference/operator/query-logical",
+   "/reference/operator/query-miscellaneous",
+   "/reference/operator/query-modifiers",
+   "/reference/operator/query-projection",
+   "/reference/operator/query",
+   "/reference/operator/update-array",
+   "/reference/operator/update-bitwise",
+   "/reference/operator/update-field",
+   "/reference/operator/update",
+   "/reference/read-concern",
+   "/reference/replication",
+   "/reference/security",
+   "/reference/sharding",
+   "/release-notes/2.4",
+   "/release-notes/2.6",
+   "/release-notes/3.0",
+   "/release-notes/3.2-compatibility",
+   "/release-notes/3.2",
+   "/release-notes/3.4-downgrade",
+   "/release-notes/3.4",
+   "/release-notes/3.6",
+   "/release-notes/4.0",
+   "/release-notes/4.2-downgrade",
+   "/release-notes/4.2",
+   "/release-notes/4.4-downgrade",
+   "/release-notes/4.4",
+   "/replication",
+   "/security",
+   "/sharding",
+   "/storage",
+   "/text-search",
+   "/tutorial/insert-documents",
+   "/tutorial/install-mongodb-enterprise-on-amazon",
+   "/tutorial/install-mongodb-enterprise-on-debian",
+   "/tutorial/install-mongodb-enterprise-on-macos",
+   "/tutorial/install-mongodb-enterprise-on-red-hat",
+   "/tutorial/install-mongodb-enterprise-on-suse",
+   "/tutorial/install-mongodb-enterprise-on-ubuntu",
+   "/tutorial/install-mongodb-enterprise-on-windows",
+   "/tutorial/install-mongodb-on-amazon",
+   "/tutorial/install-mongodb-on-debian",
+   "/tutorial/install-mongodb-on-macos",
+   "/tutorial/install-mongodb-on-red-hat",
+   "/tutorial/install-mongodb-on-suse",
+   "/tutorial/install-mongodb-on-ubuntu",
+   "/tutorial/install-mongodb-on-windows",
+   "/tutorial/query-documents",
+   "/tutorial/remove-documents",
+   "/tutorial/update-documents"
+]
+
+[substitutions]
+compass = "MongoDB Compass"
+mdb-shell = "MongoDB Shell"
+copy = "©"
+# hardlink replace:: {0}/{1}'.format(conf.project.url, conf.git.branches.current)
+# branch replace:: ``{0}``'.format(conf.git.branches.current)
+ent-build = "MongoDB Enterprise"
+year = "2020"
+bi = "MongoDB Connector for BI"
+version = "4.2"
+
 
 [constants]
 package-branch = "4.4" # For rc = testing.  For GA, will be 4.2.
 windows-dir-version = "4.4" # The wizard installs in 4.2 branch
-package-name-org = "mongodb-org"
-package-name-enterprise = "mongodb-enterprise"
 version = "4.4"
-release = "{+release+}"
+version-dev = "4.4"
+release = "4.4.1"
 pgp-version = "{+version+}"
-pgp-fingerprint = "E162F504A20CDF15827F718D4B7C549A058F8B6B"
+package-name-org = "mongodb-org"
+package-name-enterprise = "mongodb-enterprise"
 rsa-key = "4B7C549A058F8B6B"
+pgp-fingerprint = "E162F504A20CDF15827F718D4B7C549A058F8B6B"
 pgp-fingerprint-fmt = "E162 F504 A20C DF15 827F  718D 4B7C 549A 058F 8B6B"
-windows-sha256 = "C777DF7816BB8C9A760FDEA782113949408B6F39D72BE29A2551FA51E2FE0473"
 pgp-short-fingerprint = "0x4B7C549A058F8B6B"
-source-available = "`source available and free to use <https://github.com/mongodb/mongo/>`_"
+windows-sha256 = "C777DF7816BB8C9A760FDEA782113949408B6F39D72BE29A2551FA51E2FE0473"
+source-available = ":github:`source available and free to use <mongodb/mongo>`"

source/about.txt

@@ -26,20 +26,12 @@ Attribution-NonCommercial-ShareAlike 3.0 United States License
 
 |copy| MongoDB, Inc. 2008-|year|
 
-Editions
+Man Pages
 --------
 
 In addition to the `MongoDB Manual <https://docs.mongodb.com/manual/#>`_, you can
-also access this content in the following editions:
-
-- :hardlink:`HTML tar.gz <manual.tar.gz>`
-
-- :hardlink:`EPUB Format <MongoDB-manual.epub>`
-
-MongoDB Reference documentation is also available as part of `dash
-<http://kapeli.com/dash>`_. You can also access the :hardlink:`MongoDB
-Man Pages <manpages.tar.gz>` which are also distributed with the
-official MongoDB Packages.
+access the :manual:`MongoDB Man Pages </manpages.tar.gz>`, 
+which are also distributed with the official MongoDB Packages.
 
 Version and Revisions
 ---------------------
@@ -52,11 +44,6 @@ Manual. You can see the full revision history and track ongoing
 improvements and additions for all versions of the manual from its `GitHub
 repository <https://github.com/mongodb/docs>`_.
 
-This edition reflects "|branch|" branch of the documentation
-as of the "|commit|" revision. This branch is explicitly accessible
-via "|hardlink|" and you can always reference the commit of the
-current manual in the :hardlink:`release.txt` file.
-
 The most up-to-date, current, and stable version of the manual is
 always available at "https://docs.mongodb.com/manual/".
 

source/administration/analyzing-mongodb-performance.txt

@@ -47,11 +47,11 @@ affecting your performance, refer to the :ref:`server-status-locks`
 section and the :ref:`globalLock` section of the
 :dbcommand:`serverStatus` output.
 
-Dividing :serverstatus:`locks.timeAcquiringMicros` by
-:serverstatus:`locks.acquireWaitCount`
+Dividing :serverstatus:`locks.<type>.timeAcquiringMicros` by
+:serverstatus:`locks.<type>.acquireWaitCount`
 can give an approximate average wait time for a particular lock mode.
 
-:serverstatus:`locks.deadlockCount` provide
+:serverstatus:`locks.<type>.deadlockCount` provide
 the number of times the lock acquisitions encountered deadlocks.
 
 If :serverstatus:`globalLock.currentQueue.total` is consistently high,
@@ -156,8 +156,7 @@ processes run with FTDC on by default. For more information on MongoDB
 Support options, visit
 `Getting Started With MongoDB Support <https://www.mongodb.com/support/get-started?tck=docs_server>`_.
 
-.. admonition:: FTDC Privacy
-   :class: important
+.. important:: FTDC Privacy
 
    FTDC data files are compressed and not human-readable. MongoDB Inc.
    engineers cannot access FTDC data without explicit permission

source/administration/backup-sharded-clusters.txt

@@ -4,9 +4,6 @@ Backup and Restore Sharded Clusters
 
 .. default-domain:: mongodb
 
-.. role:: red(strong)
-   :class: text-danger
-
 .. contents:: On this page
    :local:
    :backlinks: none
@@ -19,25 +16,23 @@ The following tutorials describe backup and restoration for sharded clusters:
 
    .. include:: /includes/extracts/sharded-clusters-backup-restore-mongodump-mongorestore-restriction.rst
 
-.. class:: toc
-
-   :doc:`/tutorial/backup-sharded-cluster-with-filesystem-snapshots`
-      Use file system snapshots back up each component in the sharded
-      cluster individually. The procedure involves stopping the cluster
-      balancer. If your system configuration allows file system backups,
-      this might be more efficient than using MongoDB tools.
+:doc:`/tutorial/backup-sharded-cluster-with-filesystem-snapshots`
+   Use file system snapshots back up each component in the sharded
+   cluster individually. The procedure involves stopping the cluster
+   balancer. If your system configuration allows file system backups,
+   this might be more efficient than using MongoDB tools.
 
-   :doc:`/tutorial/backup-sharded-cluster-with-database-dumps`
-      Create backups using :binary:`~bin.mongodump` to back up each
-      component in the cluster individually.
+:doc:`/tutorial/backup-sharded-cluster-with-database-dumps`
+   Create backups using :binary:`~bin.mongodump` to back up each
+   component in the cluster individually.
 
-   :doc:`/tutorial/schedule-backup-window-for-sharded-clusters`
-      Limit the operation of the cluster balancer to provide a window
-      for regular backup operations.
+:doc:`/tutorial/schedule-backup-window-for-sharded-clusters`
+   Limit the operation of the cluster balancer to provide a window
+   for regular backup operations.
 
-   :doc:`/tutorial/restore-sharded-cluster`
-      An outline of the procedure and consideration for restoring an
-      *entire* sharded cluster from backup.
+:doc:`/tutorial/restore-sharded-cluster`
+   An outline of the procedure and consideration for restoring an
+   *entire* sharded cluster from backup.
 
 
 .. toctree::

source/administration/change-streams-production-recommendations.txt

@@ -1,4 +1,4 @@
-.. index:: changeStreams notification
+
 
 =========================================
 Change Streams Production Recommendations

source/administration/configuration-and-maintenance.txt

@@ -7,26 +7,24 @@ Configuration and Maintenance
 This section describes routine management operations, including
 updating your MongoDB deployment's configuration.
 
-.. class:: toc
+:doc:`/administration/configuration`
+   Outlines common MongoDB configurations and examples of
+   best-practice configurations for common use cases.
 
-   :doc:`/administration/configuration`
-      Outlines common MongoDB configurations and examples of
-      best-practice configurations for common use cases.
+:doc:`/tutorial/upgrade-revision`
+   Introduces the basic process for upgrading a MongoDB deployment
+   between different minor release versions.
 
-   :doc:`/tutorial/upgrade-revision`
-      Introduces the basic process for upgrading a MongoDB deployment
-      between different minor release versions.
+:doc:`/tutorial/manage-mongodb-processes`
+   Start, configure, and manage running :binary:`~bin.mongod`
+   process.
 
-   :doc:`/tutorial/manage-mongodb-processes`
-      Start, configure, and manage running :binary:`~bin.mongod`
-      process.
+:doc:`/tutorial/terminate-running-operations`
+   Stop in progress MongoDB client operations using
+   :method:`db.killOp()` and :method:`~cursor.maxTimeMS()`.
 
-   :doc:`/tutorial/terminate-running-operations`
-      Stop in progress MongoDB client operations using
-      :method:`db.killOp()` and :method:`~cursor.maxTimeMS()`.
-
-   :doc:`/tutorial/rotate-log-files`
-      Archive the current log files and start new ones.
+:doc:`/tutorial/rotate-log-files`
+   Archive the current log files and start new ones.
 
 
 .. toctree::