Update hugo files

mongodb · Mar 5, 2024 · 0160d72 · 0160d72
1 parent 72674d0
commit 0160d72
Show file tree

Hide file tree

Showing 23 changed files with 799 additions and 798 deletions.
diff --git a/contributing/index.html b/contributing/index.html
@@ -1833,16 +1833,16 @@ <h3 id="headers">Headers</h3>
 <li>Header Postlude</li>
 </ul>
 <p>Example:</p>
-<pre tabindex="0"><code class="language-{.cpp}" data-lang="{.cpp}">// Copyright 2018-present MongoDB Inc.
+<pre tabindex="0"><code>// Copyright 2018-present MongoDB Inc.
 //
-// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);
+// Licensed under the Apache License, Version 2.0 (the &#34;License&#34;);
 // you may not use this file except in compliance with the License.
 // You may obtain a copy of the License at
 //
 // http://www.apache.org/licenses/LICENSE-2.0
 //
 // Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,
+// distributed under the License is distributed on an &#34;AS IS&#34; BASIS,
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
@@ -1882,7 +1882,7 @@ <h3 id="headers">Headers</h3>
 </li>
 </ul>
 <p>Example:</p>
-<pre tabindex="0"><code class="language-{.cpp}" data-lang="{.cpp}">class foo {
+<pre tabindex="0"><code>class foo {
 
     public:
       foo();

diff --git a/contributing/testing-legacy/index.html b/contributing/testing-legacy/index.html
@@ -1755,12 +1755,12 @@ <h1>Testing the legacy driver</h1>
 <p>Note: The 26compat branch differs from the instructions below as follows:</p>
 <ul>
 <li>MongoOrchestration is not required.</li>
-<li>The target to run unit tests is &lsquo;smokeCppUnittests&rsquo; (or &lsquo;test&rsquo;, or &lsquo;smoke&rsquo;), not &lsquo;unit&rsquo;</li>
+<li>The target to run unit tests is &lsquo;smokeCppUnittests&rsquo; (or &rsquo;test&rsquo;, or &lsquo;smoke&rsquo;), not &lsquo;unit&rsquo;</li>
 <li>The build-[test] aliases are not supported (the run- aliases are supported, however)</li>
 <li>There are no integration tests</li>
-<li>The target to run the examples is &lsquo;smokeClient&rsquo;, not &lsquo;examples&rsquo;</li>
+<li>The target to run the examples is &lsquo;smokeClient&rsquo;, not &rsquo;examples&rsquo;</li>
 <li>You must have a mongod running on port 27999 to run the examples.</li>
-<li>The &lsquo;test&rsquo; target does not run all tests, only the unit tests (see above).</li>
+<li>The &rsquo;test&rsquo; target does not run all tests, only the unit tests (see above).</li>
 </ul>
 <h3 id="unit-tests">Unit tests</h3>
 <p>Unit tests do not require a running mongod or mongo-orchestration. These

diff --git a/contributing/testing-mongocxx/index.html b/contributing/testing-mongocxx/index.html
@@ -1759,8 +1759,8 @@ <h2 id="writing-new-tests">Writing new tests</h2>
 <p>If you&rsquo;d like to add a feature to the driver, please write a test for it as
 well.  Additions to existing classes should have new sections added to the
 existing test cases:</p>
-<pre tabindex="0"><code>TEST_CASE(&quot;existing_class&quot;, &quot;[existing_class]&quot;) {
-   SECTION(&quot;Can do some new thing&quot;) {
+<pre tabindex="0"><code>TEST_CASE(&#34;existing_class&#34;, &#34;[existing_class]&#34;) {
+   SECTION(&#34;Can do some new thing&#34;) {
       ...
       REQUIRE(new_thing_works);
    }

diff --git a/index.html b/index.html
@@ -1,7 +1,7 @@
 <!DOCTYPE html>
 <html lang="en">
   <head>
-	<meta name="generator" content="Hugo 0.92.2" />
+	<meta name="generator" content="Hugo 0.117.0">
     <meta charset="utf-8">
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <meta name="description" content="">

diff --git a/index.xml b/index.xml
@@ -14,8 +14,8 @@
 
       <guid>https://mongocxx.org/mongocxx-v3/polyfill-selection/</guid>
       <description>The mongocxx driver uses C++17 features std::optional and std::string_view. To use the C++17 standard library implementations for these features, set the CMake configuration variable CMAKE_CXX_STANDARD to 17 or higher. Otherwise, to compile the mongocxx driver for pre-C++17 configurations, a polyfill library implementation must be selected from the following options (note: &amp;ldquo;default&amp;rdquo; refers to pre-C++17 configurations when no polyfill library is explicitly selected):
-  bsoncxx (default only when -DENABLE_BSONCXX_POLY_USE_IMPLS=ON)
-Select with -DBSONCXX_POLY_USE_IMPLS=ON.</description>
+bsoncxx (default only when -DENABLE_BSONCXX_POLY_USE_IMPLS=ON)
+Select with -DBSONCXX_POLY_USE_IMPLS=ON. This option is most recommended, as it does not require additional external library dependencies.</description>
     </item>
 
     <item>
@@ -26,8 +26,8 @@ Select with -DBSONCXX_POLY_USE_IMPLS=ON.</description>
       <guid>https://mongocxx.org/mongocxx-v3/installation/windows/</guid>
       <description>Step 1: Choose a C++17 polyfill First, choose a C++17 polyfill library.
 Step 2: Download the latest version of the mongocxx driver. The most reliable starting point for building the mongocxx driver is the latest release tarball.
-The mongocxx releases page will have links to the release tarball for the version you wish you install. For example, to download version 3.10.0:
-curl -OL https://github.com/mongodb/mongo-cxx-driver/releases/download/r3.10.0/mongo-cxx-driver-r3.10.0.tar.gz tar -xzf mongo-cxx-driver-r3.10.0.tar.gz cd mongo-cxx-driver-r3.10.0/build Make sure you change to the build directory of whatever source tree you obtain.</description>
+The mongocxx releases page will have links to the release tarball for the version you wish you install. For example, to download version 3.10.1:
+curl -OL https://github.com/mongodb/mongo-cxx-driver/releases/download/r3.10.1/mongo-cxx-driver-r3.10.1.tar.gz tar -xzf mongo-cxx-driver-r3.10.1.tar.gz cd mongo-cxx-driver-r3.10.1/build Make sure you change to the build directory of whatever source tree you obtain.</description>
     </item>
 
     <item>
@@ -38,8 +38,8 @@ curl -OL https://github.com/mongodb/mongo-cxx-driver/releases/download/r3.10.0/m
       <guid>https://mongocxx.org/mongocxx-v3/installation/macos/</guid>
       <description>Step 1: Choose a C++17 polyfill First, choose a C++17 polyfill library.
 Step 2: Download the latest version of the mongocxx driver. The most reliable starting point for building the mongocxx driver is the latest release tarball.
-The mongocxx releases page will have links to the release tarball for the version you wish you install. For example, to download version 3.10.0:
-curl -OL https://github.com/mongodb/mongo-cxx-driver/releases/download/r3.10.0/mongo-cxx-driver-r3.10.0.tar.gz tar -xzf mongo-cxx-driver-r3.10.0.tar.gz cd mongo-cxx-driver-r3.10.0/build Make sure you change to the build directory of whatever source tree you obtain.</description>
+The mongocxx releases page will have links to the release tarball for the version you wish you install. For example, to download version 3.10.1:
+curl -OL https://github.com/mongodb/mongo-cxx-driver/releases/download/r3.10.1/mongo-cxx-driver-r3.10.1.tar.gz tar -xzf mongo-cxx-driver-r3.10.1.tar.gz cd mongo-cxx-driver-r3.10.1/build Make sure you change to the build directory of whatever source tree you obtain.</description>
     </item>
 
     <item>
@@ -50,8 +50,8 @@ curl -OL https://github.com/mongodb/mongo-cxx-driver/releases/download/r3.10.0/m
       <guid>https://mongocxx.org/mongocxx-v3/installation/linux/</guid>
       <description>Step 1: Choose a C++17 polyfill First, choose a C++17 polyfill library.
 Step 2: Download the latest version of the mongocxx driver. The most reliable starting point for building the mongocxx driver is the latest release tarball.
-The mongocxx releases page will have links to the release tarball for the version you wish you install. For example, to download version 3.10.0:
-curl -OL https://github.com/mongodb/mongo-cxx-driver/releases/download/r3.10.0/mongo-cxx-driver-r3.10.0.tar.gz tar -xzf mongo-cxx-driver-r3.10.0.tar.gz cd mongo-cxx-driver-r3.10.0/build Make sure you change to the build directory of whatever source tree you obtain.</description>
+The mongocxx releases page will have links to the release tarball for the version you wish you install. For example, to download version 3.10.1:
+curl -OL https://github.com/mongodb/mongo-cxx-driver/releases/download/r3.10.1/mongo-cxx-driver-r3.10.1.tar.gz tar -xzf mongo-cxx-driver-r3.10.1.tar.gz cd mongo-cxx-driver-r3.10.1/build Make sure you change to the build directory of whatever source tree you obtain.</description>
     </item>
 
     <item>
@@ -61,7 +61,7 @@ curl -OL https://github.com/mongodb/mongo-cxx-driver/releases/download/r3.10.0/m
 
       <guid>https://mongocxx.org/mongocxx-v3/installation/advanced/</guid>
       <description>Additional Options for Integrators In the event that you are building the BSON C++ library and/or the C++ driver to embed with other components and you wish to avoid the potential for collision with components installed from a standard build or from a distribution package manager, you can make use of the BSONCXX_OUTPUT_BASENAME and MONGOCXX_OUTPUT_BASENAME options to cmake.
-cmake .. \  -DBSONCXX_OUTPUT_BASENAME=custom_bsoncxx \  -DMONGOCXX_OUTPUT_BASENAME=custom_mongocxx The above command would produce libraries named libcustom_bsoncxx.</description>
+cmake .. \ -DBSONCXX_OUTPUT_BASENAME=custom_bsoncxx \ -DMONGOCXX_OUTPUT_BASENAME=custom_mongocxx The above command would produce libraries named libcustom_bsoncxx.</description>
     </item>
 
     <item>
@@ -79,7 +79,7 @@ cmake .. \  -DBSONCXX_OUTPUT_BASENAME=custom_bsoncxx \  -DMONGOCXX_OUTPUT_BASENA
       <pubDate>Mon, 15 Aug 2016 16:11:58 +0530</pubDate>
 
       <guid>https://mongocxx.org/mongocxx-v3/api-abi-versioning/</guid>
-      <description>API Versioning  We use semantic versioning. bsoncxx and mongocxx both define corresponding CMake variables for MAJOR, MINOR, and PATCH.  ABI Versioning  Both bsoncxx and mongocxx both have a single scalar ABI version. Only bump ABI version on incompatible ABI change (not for ABI additions). We stay on ABI version _noabi (without bumping for incompatible changes) until ABI is stable.  Parallel Header Installation  For mongocxx, install all headers to $PREFIX/mongocxx/v$ABI/.</description>
+      <description>API Versioning We use semantic versioning. bsoncxx and mongocxx both define corresponding CMake variables for MAJOR, MINOR, and PATCH. ABI Versioning Both bsoncxx and mongocxx both have a single scalar ABI version. Only bump ABI version on incompatible ABI change (not for ABI additions). We stay on ABI version _noabi (without bumping for incompatible changes) until ABI is stable. Parallel Header Installation For mongocxx, install all headers to $PREFIX/mongocxx/v$ABI/. For bsoncxx, install all headers to $PREFIX/bsoncxx/v$ABI/.</description>
     </item>
 
     <item>
@@ -110,8 +110,8 @@ The mongo::client::initialize function The mongo::client::initialize function, f
       <guid>https://mongocxx.org/mongocxx-v3/configuration/</guid>
       <description>In the mongocxx driver, most configuration is done via the connection URI. Some additional connection options are possible via the mongocxx::options::client class.
 Configuring TLS/SSL To enable TLS (SSL), set tls=true in the URI:
- mongodb://mongodb.example.com/?tls=true
- By default, mongocxx will verify server certificates against the local system CA list. You can override that either by specifying different settings in the connection string, or by creating a mongocxx::options::tls object and passing it to tls_opts on mongocxx::options::client.</description>
+mongodb://mongodb.example.com/?tls=true
+By default, mongocxx will verify server certificates against the local system CA list. You can override that either by specifying different settings in the connection string, or by creating a mongocxx::options::tls object and passing it to tls_opts on mongocxx::options::client.</description>
     </item>
 
     <item>
@@ -120,7 +120,7 @@ Configuring TLS/SSL To enable TLS (SSL), set tls=true in the URI:
       <pubDate>Mon, 15 Aug 2016 16:11:58 +0530</pubDate>
 
       <guid>https://mongocxx.org/legacy-v1/installation/</guid>
-      <description>Table of Contents  How to ask for Help Get the source code Choose a branch  legacy branch   Compile the Driver  SCons options when Compiling the C++ Driver  Targets Client Options Path Options Build Options SCons Options Windows Options Mac OS X Options Deprecated Options   Windows Considerations   Example C++ Driver Compilations  Debug Builds Building on Windows  Building against the pre-built boost binaries Building a DLL Building multiple Windows library variants     Using the driver in your application  Initialization and Configuration Client Headers Client Libraries  Windows autolinking Linking with the static client library      How to ask for Help If you are having difficulty building the driver after reading the below instructions, please post on the MongoDB Community Forums to ask for help.</description>
+      <description>Table of Contents How to ask for Help Get the source code Choose a branch legacy branch Compile the Driver SCons options when Compiling the C++ Driver Targets Client Options Path Options Build Options SCons Options Windows Options Mac OS X Options Deprecated Options Windows Considerations Example C++ Driver Compilations Debug Builds Building on Windows Building against the pre-built boost binaries Building a DLL Building multiple Windows library variants Using the driver in your application Initialization and Configuration Client Headers Client Libraries Windows autolinking Linking with the static client library How to ask for Help If you are having difficulty building the driver after reading the below instructions, please post on the MongoDB Community Forums to ask for help.</description>
     </item>
 
     <item>
@@ -142,10 +142,11 @@ Next, you may wish to take a look at the MongoDB Manual for a language independe
 
       <guid>https://mongocxx.org/reporting-bugs/</guid>
       <description>If you think you have found a bug or want to see a new feature in the C++ driver, please open an issue in JIRA:
-  Create a Jira account and login.
-  Navigate to the CXX project.
-  Click Create Issue. Provide as much information as possible about the issue and the steps to reproduce it.
-  Be aware that bug reports in JIRA for the C++ driver are public.</description>
+Create a Jira account and login.
+Navigate to the CXX project.
+Click Create Issue. Provide as much information as possible about the issue and the steps to reproduce it.
+Be aware that bug reports in JIRA for the C++ driver are public.
+If you identify a security vulnerability in a driver or any other MongoDB project, please report it according to the instructions found in Create a Vulnerability Report.</description>
     </item>
 
     <item>
@@ -188,10 +189,10 @@ Even if you create multiple child objects from a single client, and synchronize
 
       <guid>https://mongocxx.org/mongocxx-v3/tutorial/</guid>
       <description>See the full code for this tutorial in tutorial.cpp.
-Prerequisites   A mongod instance running on localhost on port 27017.
-  The mongocxx Driver. See Installation for mongocxx.
-  The following statements at the top of your source file:
-  #include &amp;lt;cstdint&amp;gt;#include &amp;lt;iostream&amp;gt;#include &amp;lt;vector&amp;gt; #include &amp;lt;bsoncxx/builder/basic/document.hpp&amp;gt;#include &amp;lt;bsoncxx/json.hpp&amp;gt;#include &amp;lt;mongocxx/client.hpp&amp;gt;#include &amp;lt;mongocxx/instance.hpp&amp;gt;#include &amp;lt;mongocxx/stdx.hpp&amp;gt;#include &amp;lt;mongocxx/uri.hpp&amp;gt; using bsoncxx::builder::basic::kvp; using bsoncxx::builder::basic::make_array; using bsoncxx::builder::basic::make_document; Compiling The mongocxx driver&amp;rsquo;s installation process will install a libmongocxx.</description>
+Prerequisites A mongod instance running on localhost on port 27017.
+The mongocxx Driver. See Installation for mongocxx.
+The following statements at the top of your source file:
+#include &amp;lt;cstdint&amp;gt; #include &amp;lt;iostream&amp;gt; #include &amp;lt;vector&amp;gt; #include &amp;lt;bsoncxx/builder/basic/document.hpp&amp;gt; #include &amp;lt;bsoncxx/json.hpp&amp;gt; #include &amp;lt;mongocxx/client.hpp&amp;gt; #include &amp;lt;mongocxx/instance.hpp&amp;gt; #include &amp;lt;mongocxx/stdx.hpp&amp;gt; #include &amp;lt;mongocxx/uri.hpp&amp;gt; using bsoncxx::builder::basic::kvp; using bsoncxx::builder::basic::make_array; using bsoncxx::builder::basic::make_document; Compiling The mongocxx driver&amp;rsquo;s installation process will install a libmongocxx.pc file for use with pkg-config.</description>
     </item>
 
     <item>
@@ -213,7 +214,7 @@ BSONObj p = BSON( GENOID &amp;lt;&amp;lt; &amp;#34;name&amp;#34; &amp;lt;&amp;lt
 
       <guid>https://mongocxx.org/mongocxx-v3/working-with-bson/</guid>
       <description>The mongocxx driver ships with a new library, bsoncxx. This article will go over some of the different types in this library, and how and when to use each. For more information and example code, see our examples.
- Document Builders Owning BSON Documents (values) Non-owning BSON Documents (views) Optionally-owning BSON Documents(view_or_value) BSON Document Lifetime Printing BSON Documents Getting Fields out of BSON Documents  Document Builders The bsoncxx library offers four interfaces for building BSON: one-off functions, a basic builder, a list builder and a stream-based builder.</description>
+Document Builders Owning BSON Documents (values) Non-owning BSON Documents (views) Optionally-owning BSON Documents(view_or_value) BSON Document Lifetime Printing BSON Documents Getting Fields out of BSON Documents Document Builders The bsoncxx library offers four interfaces for building BSON: one-off functions, a basic builder, a list builder and a stream-based builder.</description>
     </item>
 
     <item>

diff --git a/legacy-v1/breaking-changes/index.html b/legacy-v1/breaking-changes/index.html
@@ -1773,7 +1773,7 @@ <h2 id="changes-to-apis">Changes to APIs</h2>
 <li>The <code>ensureIndex</code> and related methods have been removed. The replacement is the new <code>createIndex</code> method.</li>
 <li><code>IndexSpec::dropDuplicates()</code> is now deprecated as it is a no-op in MongoDB 3.0.</li>
 <li>The <code>QUERY</code> macro has been replaced by <code>MONGO_QUERY</code>.</li>
-<li>The <code>ConnectionString::parse</code> method now requires it&rsquo;s argument to be in the MongoDB URL (&ldquo;mongodb://&hellip;&quot;) format. To use the old format, use the new <code>ConnectionString::parseDeprecated</code> method.</li>
+<li>The <code>ConnectionString::parse</code> method now requires it&rsquo;s argument to be in the MongoDB URL (&ldquo;mongodb://&hellip;&rdquo;) format. To use the old format, use the new <code>ConnectionString::parseDeprecated</code> method.</li>
 <li>The <code>ConnectionPool</code> and <code>ScopedDbConnection</code> classes have been removed.</li>
 </ul>
 <h2 id="behavior-changes">Behavior Changes</h2>