Merge pull request #2725 from jeff-allen-mongo/v6.3

Merge v6.2 into v6.3

Author: jeff-allen-mongo

.github/pull_request_template.md

@@ -1,9 +1,15 @@
+## DESCRIPTION
+
+
 ## STAGING
 
 
 ## JIRA
 
 
+## BUILD LOG
+
+
 ## Self-Review Checklist
 
 - [ ] Is this free of any warnings or errors in the RST?

Makefile

@@ -182,4 +182,4 @@ examples:
 	curl -SfL https://raw.githubusercontent.com/mongodb/mongo-swift-driver/master/Examples/Docs/Sources/SyncExamples/main.swift -o ${DRIVERS_PATH}/swiftSync.swift
 
 changelogs:
-	python changelogs/generatechangelogs.py
+	python3 changelogs/generatechangelogs.py

changelogs/generatechangelogs.py

@@ -1,9 +1,9 @@
 import collections
 import logging
 import os
-import rstcloth.rstcloth as rstcloth
 import yaml
 from jira import JIRA
+from rstcloth import RstCloth
 
 logger = logging.getLogger('generatechangelogs.py')
 
@@ -94,9 +94,9 @@ def get_issue_structure(config, issues, version):
         # format issue summary to remove backticks
         # (necessary for next-gen)
 
-        issue_summary = issue.fields.summary.encode("utf-8").replace('`', '')
+        issue_summary = issue.fields.summary.replace('`', '')
 
-        issue_pair = (issue.key.encode("utf-8"), issue_summary)
+        issue_pair = (issue.key, issue_summary)
 
         if len(components) == 0:
             # if there isn't a component put this in the last grouping.
@@ -123,7 +123,7 @@ def get_issue_structure(config, issues, version):
     return headings
 
 
-def generate_changelog_rst(config, headings, fixVersion):
+def generate_changelog_rst(config, headings, fixVersion, outputFile):
     """
     Generate the changelog rst from the groupings established in
     get_issue_structure()
@@ -135,90 +135,87 @@ def generate_changelog_rst(config, headings, fixVersion):
         for component in sub_headings:
             nested[component] = enclosing_level
 
-    # build the changelog content itself.
-    r = rstcloth.RstCloth()
-    level = 3
+    with open (outputFile, 'w') as f:
+        # build the changelog content itself.
+        r = RstCloth(f)
+        level = 3
 
-    r.ref_target("{0}-changelog".format(fixVersion))
-    r.newline()
-    r.heading(text="{0} Changelog".format(fixVersion), char='-')
-    r.newline()
+        r.ref_target("{0}-changelog".format(fixVersion))
+        r.newline()
+        r.heading(text="{0} Changelog".format(fixVersion), char='-')
+        r.newline()
 
-    # process all of the issues by group.
-    for heading, issues in headings.items():
-        if heading in nested:
-            # we deal with nested headings when we do their parent. skip here.
-            continue
-        else:
-            if heading in config.get('nesting') and len(issues) == 0:
-                # if a heading has subheadings, and all are empty, then we should skip it entirely.
-                empty_sub_headings = 0
-                for sub in config.get('nesting').get(heading):
-                    if len(headings[sub]) == 0:
-                        empty_sub_headings += 1
-                if empty_sub_headings == len(config.get('nesting').get(heading)):
-                    continue
-            elif len(issues) == 0:
-                # skip empty headings.
+        # process all of the issues by group.
+        for heading, issues in headings.items():
+            if heading in nested:
+                # we deal with nested headings when we do their parent. skip here.
                 continue
-
-            # format the heading.
-            r.heading(text=heading, indent=0,
-                      char='~')
-            r.newline()
-
-            if len(issues) == 1:
-                r.content("{1} {0}".format(issues[0][1], r.role(
-                    "issue", issues[0][0])), wrap=False)
             else:
-                for issue in issues:
-                    r.li("{1} {0}".format(issue[1], r.role(
-                        "issue", issue[0])), wrap=False)
-            r.newline()
-
-            # repeat the above formatting with minor variations to do the nesting.
-            if heading in config.get('nesting'):
-                for sub in config.get('nesting').get(heading):
-                    if len(headings[sub]) == 0:
+                if heading in config.get('nesting') and len(issues) == 0:
+                    # if a heading has subheadings, and all are empty, then we should skip it entirely.
+                    empty_sub_headings = 0
+                    for sub in config.get('nesting').get(heading):
+                        if len(headings[sub]) == 0:
+                            empty_sub_headings += 1
+                    if empty_sub_headings == len(config.get('nesting').get(heading)):
                         continue
+                elif len(issues) == 0:
+                    # skip empty headings.
+                    continue
 
-                    r.heading(text=sub, indent=0,
-                              # char=giza.content.helper.character_levels[level+1])
-                              char='`')
-                    r.newline()
-
-                    sub_issues = headings[sub]
-                    if len(sub_issues) == 0:
-                        r.content("{1} {0}".format(sub_issues[0][1].strip(), r.role(
-                            "issue", sub_issues[0][0])), wrap=False)
-                    else:
-                        for issue in sub_issues:
-                            r.li("{1} {0}".format(issue[1].strip(), r.role(
-                                "issue", issue[0])), wrap=False)
-                    r.newline()
-
-    return r
+                # format the heading.
+                r.heading(text=heading, indent=0,
+                        char='~')
+                r.newline()
+
+                if len(issues) == 1:
+                    r.content("{1} {0}".format(issues[0][1], r.role(
+                        "issue", issues[0][0])))
+                else:
+                    for issue in issues:
+                        r.li("{1} {0}".format(issue[1], r.role(
+                            "issue", issue[0])))
+                r.newline()
+
+                # repeat the above formatting with minor variations to do the nesting.
+                if heading in config.get('nesting'):
+                    for sub in config.get('nesting').get(heading):
+                        if len(headings[sub]) == 0:
+                            continue
+
+                        r.heading(text=sub, indent=0,
+                                # char=giza.content.helper.character_levels[level+1])
+                                char='`')
+                        r.newline()
+
+                        sub_issues = headings[sub]
+                        if len(sub_issues) == 0:
+                            r.content("{1} {0}".format(sub_issues[0][1].strip(), r.role(
+                                "issue", sub_issues[0][0])))
+                        else:
+                            for issue in sub_issues:
+                                r.li("{1} {0}".format(issue[1].strip(), r.role(
+                                    "issue", issue[0])))
+                        r.newline()
 
+        print(
+            "wrote changelog '{0}'. Commit this file independently.".format(outputFile))
 
-def write_changelog_file(rst, fixVersion):
 
-    # Output the rst to source/includes/changelogs/releases
+def generate_output_filePath(fixVersion):
     sourceDir = os.path.abspath(os.path.join(os.path.dirname(__file__), '..'))
     fn = fixVersion + ".rst"
     outputDir = os.path.join(
         sourceDir, "source/includes/changelogs/releases", fn)
-    rst.write(outputDir)
-    logger.info(
-        "wrote changelog '{0}'. Commit this file independently.".format(outputDir))
-
-    print(
-        "wrote changelog '{0}'. Commit this file independently.".format(outputDir))
-
 
+    return outputDir
 
 def main():
     # Prompt user for the version to generate the changelog for:
-    fixVersion = raw_input("Enter changelog version: ")
+    fixVersion = input("Enter changelog version: ")
+
+    # Generate the outputfile
+    outputFile = generate_output_filePath(fixVersion)
 
     # Get list of JIRA issues to include in changelog
     issues = get_jira_issues(fixVersion)
@@ -230,10 +227,10 @@ def main():
     issue_headings = get_issue_structure(config, issues, fixVersion)
 
     # Convert the issue headings into rst
-    changelog_rst = generate_changelog_rst(config, issue_headings, fixVersion)
+    changelog_rst = generate_changelog_rst(config, issue_headings, fixVersion, outputFile)
 
     # Write the changelog to source/includes/changelogs/releases
-    write_changelog_file(changelog_rst, fixVersion)
+    # write_changelog_file(changelog_rst, fixVersion)
 
 if __name__ == "__main__":
     main()

changelogs/requirements-changelogs.txt

@@ -0,0 +1,6 @@
+###### Requirements without Version Specifiers ######
+
+cryptography
+jira
+PyJWT
+rstcloth

config/changelog_conf.yaml

@@ -5,6 +5,8 @@ groups:
 
   "Security":
     - Security
+    - Queryable Encryption
+    - Field Level Encryption
   "Sharding":
     - Sharding
   "Replication":

config/redirects

@@ -2053,6 +2053,8 @@ raw: ${prefix}/${version}/applications/drivers -> ${base}/drivers/
 [*-v5.3]: ${prefix}/${version}/core/queryable-encryption -> ${base}/${version}/core/security-client-side-encryption
 
 # Release Notes redirects
+[*-v6.1]: ${prefix}/${version}/release-notes/6.2 -> ${base}/${version}/release-notes
+
 [*-v5.0]: ${prefix}/${version}/release-notes/6.0 -> ${base}/${version}/release-notes
 [*-v5.0]: ${prefix}/${version}/release-notes/6.0-compatibility/ -> ${base}/${version}/release-notes
 [*-v5.0]: ${prefix}/${version}/release-notes/6.0-changelog/ -> ${base}/${version}/release-notes
@@ -2090,3 +2092,6 @@ raw: ${prefix}/${version}/applications/drivers -> ${base}/drivers/
 (v5.3-*]: ${prefix}/${version}/reference/method/quit -> ${base}/${version}/reference/method/js-native
 (v5.3-*]: ${prefix}/${version}/reference/method/sleep -> ${base}/${version}/reference/method/js-native
 (v5.3-*]: ${prefix}/${version}/reference/method/version -> ${base}/${version}/reference/method/js-native
+
+(v4.2-*]: ${prefix}/${version}/reference/method/db.copyDatabase -> ${base}/database-tools/mongodump/#std-label-mongodump-example-copy-clone-database
+(v4.2-*]: ${prefix}/${version}/reference/method/db.cloneDatabase -> ${base}/database-tools/mongodump/#std-label-mongodump-example-copy-clone-database

snooty.toml

@@ -102,6 +102,7 @@ toc_landing_pages = [
    "/indexes",
    "/introduction",
    "/mongo",
+   "/reference",
    "/reference/aggregation",
    "/reference/bson-types",
    "/reference/change-events",
@@ -231,17 +232,24 @@ package-name-enterprise = "mongodb-enterprise"
 package-name = "mongodb"
 version = "6.3"
 latest-lts-version = "6.0"
-release = "6.0.1"
-version-dev = "6.0"
+last-supported-version = "5.0"
+release = "6.2.1"
+version-dev = "6.3"
 pgp-version = "{+version+}"
 rsa-key = "4B7C549A058F8B6B"
 pgp-fingerprint = "E162F504A20CDF15827F718D4B7C549A058F8B6B"
 pgp-fingerprint-fmt = "E162 F504 A20C DF15 827F  718D 4B7C 549A 058F 8B6B"
 pgp-short-fingerprint = "0x4B7C549A058F8B6B"
 windows-sha256 = "C777DF7816BB8C9A760FDEA782113949408B6F39D72BE29A2551FA51E2FE0473"
 source-available = ":github:`source available and free to use <mongodb/mongo>`"
+pcre-abbr = ":abbr:`PCRE (Perl Compatible Regular Expressions)`"
+pcre = "Perl Compatible Regular Expressions"
+# In Use Encryption Constants
 csfle = "Client-Side Field Level Encryption"
 csfle-abbrev = "CSFLE"
+in-use-doc = "document with encrypted fields"
+in-use-doc-title = "Document with Encrypted Fields"
+in-use-docs = "documents with encrypted fields"
 kms-long = "Key Management System"
 kms-abbr = ":abbr:`KMS ({+kms-long+})`"
 km-service-long = "Key Management Service"
@@ -253,8 +261,6 @@ dek-abbr-no-hover = "DEK"
 cmk-abbr-no-hover = "CMK"
 key-vault-long = "Key Vault collection"
 key-vault-long-title = "Key Vault Collection"
-java-driver-version = "4.6"
-java-driver-api = "https://mongodb.github.io/mongo-java-driver/{+java-driver-version+}/apidocs"
 aws-abbr = ":abbr:`AWS (Amazon Web Services)`"
 aws-iam-abbr = ":abbr:`IAM (Identity and Access Management)`"
 aws-arn-abbr = ":abbr:`ARN (Amazon Resource Name)`"
@@ -270,7 +276,8 @@ kmip-kms-no-hover = "KMIP-compliant key provider"
 kmip-kms = "{+kmip-hover+}-compliant key provider"
 kmip-kms-title = "KMIP-Compliant Key Provider"
 csfle-code-snippets-gen-keys = "https://github.com/mongodb/docs/tree/master/source/includes/quick-start/generate-master-key"
-libmongocrypt-version = "1.5"
+libmongocrypt-version = "1.7"
+mongodb-crypt-version = "1.6.1"
 sample-app-url-csfle = "https://github.com/mongodb-university/docs-in-use-encryption-examples/tree/main/csfle"
 sample-app-url-qe = "https://github.com/mongodb-university/docs-in-use-encryption-examples/tree/main/queryable-encryption"
 qe = "Queryable Encryption"
@@ -284,9 +291,19 @@ shared-library-package = "``crypt_shared``"
 efm = "``encryptedFieldsMap``"
 auto-encrypt-options = "autoEncryptionOpts"
 title-auto-encrypt-options = "AutoEncryptionOpts"
-pcre-abbr = ":abbr:`PCRE (Perl Compatible Regular Expressions)`"
-pcre = "Perl Compatible Regular Expressions"
-
+# Driver Constants
+java-driver-full = "MongoDB Java driver"
+node-driver-full = "MongoDB Node.js driver"
+go-driver-full = "MongoDB Go driver"
+pymongo = "PyMongo"
+csharp-driver-full = "MongoDB C#/.NET driver"
+java-driver-version = "4.6"
+java-driver-api = "https://mongodb.github.io/mongo-java-driver/{+java-driver-version+}/apidocs"
+pymongo-api-docs = "https://pymongo.readthedocs.io/en/stable/api"
+node-libmongocrypt-binding-docs = "https://github.com/mongodb/libmongocrypt/tree/master/bindings"
+csharp-api-docs = "https://mongodb.github.io/mongo-csharp-driver/2.18/apidocs/html"
+java-api-docs = "https://mongodb.github.io/mongo-java-driver/4.7/apidocs"
+go-api-docs = "https://pkg.go.dev/go.mongodb.org/[email protected]"
 
 [[banners]]
 targets = [

source/administration/analyzing-mongodb-performance.txt

@@ -1,3 +1,5 @@
+.. _performance:
+
 ===================
 MongoDB Performance
 ===================

source/administration/backup-sharded-clusters.txt

@@ -1,3 +1,5 @@
+.. _backup-restore-sharded-clusters:
+
 ===================================
 Backup and Restore Sharded Clusters
 ===================================

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

@@ -1,4 +1,4 @@
-
+.. _change-streams-prod-recommendations:
 
 =========================================
 Change Streams Production Recommendations

source/administration/configuration-and-maintenance.txt

@@ -1,3 +1,5 @@
+.. _config-maintenance:
+
 =============================
 Configuration and Maintenance
 =============================

source/administration/configuration.txt

@@ -86,9 +86,6 @@ Consider the following basic configuration:
       destination: file
       path: "/var/log/mongodb/mongod.log"
       logAppend: true
-   storage:
-      journal:
-         enabled: true
 
 For most standalone servers, this is a sufficient base
 configuration. It makes several assumptions, but consider the
@@ -168,11 +165,6 @@ following explanation:
   :binary:`~bin.mongod` does not overwrite an existing log file
   following the server start operation.
 
-- :setting:`storage.journal.enabled` is ``true``, which enables
-  :term:`journaling <journal>`.  Journaling ensures single instance
-  write-durability. 64-bit builds of :binary:`~bin.mongod` enable
-  journaling by default. Thus, this setting may be redundant.
-
 Given the default configuration, some of these values may be
 redundant. However, in many situations explicitly stating the
 configuration increases overall system intelligibility.
@@ -275,8 +267,8 @@ Sharding Configuration
 
 Sharding requires :binary:`~bin.mongod` instances with different
 :binary:`~bin.mongod` configurations for the :ref:`config servers
-<sharded-cluster-config-server>` and the :doc:`shards
-</core/sharded-cluster-shards>`. The config servers store the cluster's
+<sharded-cluster-config-server>` and the :ref:`shards
+<shards-concepts>`. The config servers store the cluster's
 metadata, while the shards store the data.
 
 To configure the config server :binary:`~bin.mongod` instances, in the
@@ -357,7 +349,7 @@ The :setting:`~storage.dbPath` value controls the location of the
 :binary:`~bin.mongod` instance's data directory. Ensure that each database
 has a distinct and well labeled data directory. The
 :setting:`~processManagement.pidFilePath` controls where :binary:`~bin.mongod` process
-places it's :term:`process id (PID) <PID>` file. As this tracks the specific
+places it's :term:`process ID (PID) <PID>` file. As this tracks the specific
 :binary:`~bin.mongod` file, it is crucial that file be unique and well
 labeled to make it easy to start and stop these processes.