Skip to content

Publish v5.0 branch on snooty #5141

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion config/migrations.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down
4 changes: 3 additions & 1 deletion draft/use-cases/ad-campaign-management.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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.
4 changes: 3 additions & 1 deletion draft/use-cases/social-networking-updates-and-profiles.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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.
200 changes: 193 additions & 7 deletions snooty.toml
Original file line number Diff line number Diff line change
@@ -1,16 +1,202 @@
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 = "©"
ent-build = "MongoDB Enterprise"
year = "2020"
bi = "MongoDB Connector for BI"
version = "{+version+}"


[constants]
package-branch = "5.0" # For rc = testing. For GA, will be 4.2.
windows-dir-version = "5.0" # The wizard installs in 4.2 branch
package-branch = "5.0"
windows-dir-version = "5.0" # wizard
package-name-org = "mongodb-org"
package-name-enterprise = "mongodb-enterprise"
version = "5.0"
release = "{+release+}"
release = "5.0"
pgp-version = "{+version+}"
pgp-fingerprint = "E162F504A20CDF15827F718D4B7C549A058F8B6B"
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>`"
5 changes: 0 additions & 5 deletions source/about.txt
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,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/".

Expand Down
9 changes: 4 additions & 5 deletions source/administration/analyzing-mongodb-performance.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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
Expand Down
33 changes: 14 additions & 19 deletions source/administration/backup-sharded-clusters.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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::
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. index:: changeStreams notification


=========================================
Change Streams Production Recommendations
Expand Down
30 changes: 14 additions & 16 deletions source/administration/configuration-and-maintenance.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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::
Expand Down
Loading