DOCSP-37931: cleanup (#24)

Author: rustagir

snooty.toml

@@ -5,6 +5,8 @@ intersphinx = [ "https://www.mongodb.com/docs/manual/objects.inv",
                 "https://www.mongodb.com/docs/atlas/objects.inv"
               ]
 
+sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/"
+
 toc_landing_pages = [
     "/tutorials/connect/",
     "/tutorials/write-ops/",

source/get-started/pojo-qs.txt

@@ -4,6 +4,13 @@
 Quick Start (POJO Examples)
 ===========================
 
+.. facet::
+   :name: genre
+   :values: tutorial
+
+.. meta::
+   :keywords: code example, get started, connect, change data, POJO
+
 .. contents:: On this page
    :local:
    :backlinks: none
@@ -18,10 +25,7 @@ The code examples in this guide come from the `PojoQuickTour.java
 <{+driver-source-gh+}/blob/master/driver-reactive-streams/src/examples/reactivestreams/tour/PojoQuickTour.java>`__
 file in the driver source code GitHub repository.
 
-.. important::
-
-   This guide uses the ``Subscriber`` implementations, which are
-   described in the :ref:`Quick Start Primer <javars-primer>`.
+.. include:: /includes/subscriber-note.rst
 
 Prerequisites
 -------------

source/get-started/primer.txt

@@ -4,6 +4,13 @@
 Primer
 ======
 
+.. facet::
+   :name: genre
+   :values: reference
+
+.. meta::
+   :keywords: code example, design, types
+
 .. contents:: On this page
    :local:
    :backlinks: none

source/get-started/quickstart.txt

@@ -4,6 +4,13 @@
 Quick Start
 ===========
 
+.. facet::
+   :name: genre
+   :values: tutorial
+
+.. meta::
+   :keywords: code example, get started, connect, change data
+
 .. contents:: On this page
    :local:
    :backlinks: none
@@ -19,10 +26,7 @@ file in the driver source code GitHub repository.
    For instructions about how to install the {+driver-short+},
    see the :ref:`installation guide <javars-install>`.
 
-.. important::
-
-   This guide uses the ``Subscriber`` implementations, which are
-   described in the :ref:`Quick Start Primer <javars-primer>`.
+.. include:: /includes/subscriber-note.rst
 
 Prerequisites
 -------------

source/includes/connect-section.rst

@@ -0,0 +1,16 @@
+First, connect to a MongoDB deployment, then declare and define
+``MongoDatabase`` and ``MongoCollection`` instances.
+
+The following code connects to a standalone
+MongoDB deployment running on ``localhost`` on port ``27017``. Then, it
+defines the ``database`` variable to refer to the ``test`` database and
+the ``collection`` variable to refer to the ``restaurants`` collection:
+
+.. code-block:: java
+
+   MongoClient mongoClient = MongoClients.create();
+   MongoDatabase database = mongoClient.getDatabase("test");
+   MongoCollection<Document> collection = database.getCollection("restaurants");
+
+To learn more about connecting to MongoDB deployments,
+see the :ref:`javars-connect` tutorial.

source/includes/prereq-restaurants.rst

@@ -0,0 +1,8 @@
+You must set up the following components to run the code examples in
+this guide:
+
+- A ``test.restaurants`` collection populated with documents from the
+  ``restaurants.json`` file in the `documentation assets GitHub
+  <https://raw.githubusercontent.com/mongodb/docs-assets/drivers/restaurants.json>`__.
+
+- The following import statements:

source/includes/subscriber-note.rst

@@ -0,0 +1,4 @@
+.. important::
+
+   This guide uses the ``Subscriber`` implementations, which are
+   described in the :ref:`Quick Start Primer <javars-primer>`.

source/reference/logging.txt

@@ -4,6 +4,13 @@
 Logging
 =======
 
+.. facet::
+   :name: genre
+   :values: reference
+
+.. meta::
+   :keywords: record logs, log types
+
 By default, logging is enabled via the popular `SLF4J
 <https://www.slf4j.org/>`__ API. Logging is optional, so the driver
 uses SLF4J if the driver detects the presence of SLF4J API (class

source/reference/monitoring.txt

@@ -4,6 +4,13 @@
 JMX Monitoring
 ==============
 
+.. facet::
+   :name: genre
+   :values: reference
+
+.. meta::
+   :keywords: code example, record messages
+
 .. contents:: On this page
    :local:
    :backlinks: none

source/tutorials/aggregation.txt

@@ -4,6 +4,13 @@
 Aggregation Framework
 =====================
 
+.. facet::
+   :name: genre
+   :values: reference
+
+.. meta::
+   :keywords: code example, create insights, change data
+
 .. contents:: On this page
    :local:
    :backlinks: none
@@ -19,52 +26,27 @@ To learn more about aggregation, see :manual:`Aggregation Pipeline
 Prerequisites
 -------------
 
-You must set up the following components to run the code examples in
-this guide:
-
-- A ``test.restaurants`` collection populated with documents from the
-  ``restaurants.json`` file in the `documentation assets GitHub
-  <https://raw.githubusercontent.com/mongodb/docs-assets/drivers/restaurants.json>`__.
-
-- The following import statements:
-
-  .. code-block:: java
-  
-     import com.mongodb.reactivestreams.client.MongoClients;
-     import com.mongodb.reactivestreams.client.MongoClient;
-     import com.mongodb.reactivestreams.client.MongoCollection;
-     import com.mongodb.reactivestreams.client.MongoDatabase;
-     import com.mongodb.client.model.Aggregates;
-     import com.mongodb.client.model.Accumulators;
-     import com.mongodb.client.model.Projections;
-     import com.mongodb.client.model.Filters;
-           
-     import org.bson.Document;
+.. include:: /includes/prereq-restaurants.rst
 
-.. important::
+.. code-block:: java
+
+   import com.mongodb.reactivestreams.client.MongoClients;
+   import com.mongodb.reactivestreams.client.MongoClient;
+   import com.mongodb.reactivestreams.client.MongoCollection;
+   import com.mongodb.reactivestreams.client.MongoDatabase;
+   import com.mongodb.client.model.Aggregates;
+   import com.mongodb.client.model.Accumulators;
+   import com.mongodb.client.model.Projections;
+   import com.mongodb.client.model.Filters;
+           
+   import org.bson.Document;
 
-   This guide uses the ``Subscriber`` implementations, which are
-   described in the :ref:`Quick Start Primer <javars-primer>`.
+.. include:: /includes/subscriber-note.rst
 
 Connect to a MongoDB Deployment
 -------------------------------
 
-First, connect to a MongoDB deployment, then declare and define
-``MongoDatabase`` and ``MongoCollection`` instances.
-
-The following code connects to a standalone
-MongoDB deployment running on ``localhost`` on port ``27017``. Then, it
-defines the ``database`` variable to refer to the ``test`` database and
-the ``collection`` variable to refer to the ``restaurants`` collection:
-
-.. code-block:: java
-
-   MongoClient mongoClient = MongoClients.create();
-   MongoDatabase database = mongoClient.getDatabase("test");
-   MongoCollection<Document> collection = database.getCollection("restaurants");
-
-To learn more about connecting to MongoDB deployments,
-see the :ref:`javars-connect` tutorial.
+.. include:: /includes/connect-section.rst
 
 Perform Aggregation
 -------------------

source/tutorials/bulk-writes.txt

@@ -4,6 +4,13 @@
 Bulk Write Operations
 =====================
 
+.. facet::
+   :name: genre
+   :values: reference
+
+.. meta::
+   :keywords: code example, multiple changes
+
 Starting in v2.6, MongoDB supports bulk write commands
 for insert, update, and delete operations in a way that allows the
 driver to implement the correct semantics for ``BulkWriteResult`` and
@@ -18,10 +25,7 @@ operations:
    the errors. Unordered bulk operations do not guarantee an order of
    execution.
 
-.. important::
-
-   This guide uses the ``Subscriber`` implementations, which are
-   described in the :ref:`Quick Start Primer <javars-primer>`.
+.. include:: /includes/subscriber-note.rst
 
 The following code provides examples using ordered and unordered
 operations:

source/tutorials/change-stream.txt

@@ -4,6 +4,13 @@
 Change Streams
 ==============
 
+.. facet::
+   :name: genre
+   :values: reference
+
+.. meta::
+   :keywords: code example, watch for changes
+
 .. contents:: On this page
    :local:
    :backlinks: none
@@ -22,53 +29,28 @@ attempts to resume if it encounters a potentially recoverable error.
 Prerequisites
 -------------
 
-You must set up the following components to run the code examples in
-this guide:
-
-- A ``test.restaurants`` collection populated with documents from the
-  ``restaurants.json`` file in the `documentation assets GitHub
-  <https://raw.githubusercontent.com/mongodb/docs-assets/drivers/restaurants.json>`__.
+.. include:: /includes/prereq-restaurants.rst
 
-- The following import statements:
-
-  .. code-block:: java
-  
-     import com.mongodb.reactivestreams.client.MongoClients;
-     import com.mongodb.reactivestreams.client.MongoClient;
-     import com.mongodb.reactivestreams.client.MongoCollection;
-     import com.mongodb.reactivestreams.client.MongoDatabase;
-      
-     import com.mongodb.client.model.Aggregates;
-     import com.mongodb.client.model.Filters;
-     import com.mongodb.client.model.changestream.FullDocument;
-     import com.mongodb.client.model.changestream.ChangeStreamDocument;
-     
-     import org.bson.Document;
+.. code-block:: java
 
-.. important::
+   import com.mongodb.reactivestreams.client.MongoClients;
+   import com.mongodb.reactivestreams.client.MongoClient;
+   import com.mongodb.reactivestreams.client.MongoCollection;
+   import com.mongodb.reactivestreams.client.MongoDatabase;
+    
+   import com.mongodb.client.model.Aggregates;
+   import com.mongodb.client.model.Filters;
+   import com.mongodb.client.model.changestream.FullDocument;
+   import com.mongodb.client.model.changestream.ChangeStreamDocument;
+   
+   import org.bson.Document;
 
-   This guide uses the ``Subscriber`` implementations, which are
-   described in the :ref:`Quick Start Primer <javars-primer>`.
+.. include:: /includes/subscriber-note.rst
 
 Connect to a MongoDB Deployment
 -------------------------------
 
-First, connect to a MongoDB deployment, then declare and define
-``MongoDatabase`` and ``MongoCollection`` instances.
-
-The following code connects to a standalone
-MongoDB deployment running on ``localhost`` on port ``27017``. Then, it
-defines the ``database`` variable to refer to the ``test`` database and
-the ``collection`` variable to refer to the ``restaurants`` collection:
-
-.. code-block:: java
-
-   MongoClient mongoClient = MongoClients.create();
-   MongoDatabase database = mongoClient.getDatabase("test");
-   MongoCollection<Document> collection = database.getCollection("restaurants");
-
-To learn more about connecting to MongoDB deployments,
-see the :ref:`javars-connect` tutorial.
+.. include:: /includes/connect-section.rst
 
 Watch for Changes on a Collection
 ---------------------------------

source/tutorials/command.txt

@@ -4,6 +4,13 @@
 Run Commands
 ============
 
+.. facet::
+   :name: genre
+   :values: reference
+
+.. meta::
+   :keywords: code example, database command
+
 .. contents:: On this page
    :local:
    :backlinks: none
@@ -20,14 +27,7 @@ in the Server manual.
 Prerequisites
 -------------
 
-You must set up the following components to run the code examples in
-this guide:
-
-- A ``test.restaurants`` collection populated with documents from the
-  ``restaurants.json`` file in the `documentation assets GitHub
-  <https://raw.githubusercontent.com/mongodb/docs-assets/drivers/restaurants.json>`__.
-
-- The following import statements:
+.. include:: /includes/prereq-restaurants.rst
 
 .. code-block:: java
 
@@ -36,10 +36,7 @@ this guide:
    import com.mongodb.reactivestreams.client.MongoDatabase;
    import org.bson.Document;
 
-.. important::
-
-   This guide uses the ``Subscriber`` implementations, which are
-   described in the :ref:`Quick Start Primer <javars-primer>`.
+.. include:: /includes/subscriber-note.rst
 
 Connect to a MongoDB Deployment
 -------------------------------

source/tutorials/connect.txt

@@ -4,6 +4,13 @@
 Connect to MongoDB
 ==================
 
+.. facet::
+   :name: genre
+   :values: reference
+
+.. meta::
+   :keywords: code example, connect to MongoDB, modify connection
+
 .. toctree::
 
    /tutorials/connect/tls/

source/tutorials/connect/auth.txt

@@ -4,6 +4,13 @@
 Authentication
 ==============
 
+.. facet::
+   :name: genre
+   :values: reference
+
+.. meta::
+   :keywords: code example, verify, AWS, Kerberos
+
 .. contents:: On this page
    :local:
    :backlinks: none