docsp-27681 - move example classes (#150)

(cherry picked from commit 9ec1bae)
mongodb · Dec 20, 2023 · dbdbbf9 · dbdbbf9
1 parent 3093905
commit dbdbbf9
Show file tree

Hide file tree

Showing 10 changed files with 108 additions and 213 deletions.
diff --git a/source/usage-examples.txt b/source/usage-examples.txt
@@ -4,6 +4,13 @@
 Usage Examples
 ==============
 
+.. facet::
+   :name: genre
+   :values: reference
+
+.. meta::
+   :keywords: code, .NET, operation
+
 .. contents:: On this page
    :local:
    :backlinks: none
@@ -60,3 +67,27 @@ your MongoDB instance:
 
 For more information about connecting to your MongoDB instance, see the
 :ref:`Connection Guide <csharp-connection>`.
+
+Example Classes
+---------------
+
+The usage examples in this section show how to perform operations on documents
+in the ``restaurants`` collection. The examples use the following ``Restaurant``,
+``Address``, and ``GradeEntry`` classes to model the data in this collection:
+
+.. literalinclude:: /includes/code-examples/Restaurant.cs
+   :language: csharp
+   :copyable:
+   :dedent:
+
+.. literalinclude:: /includes/code-examples/Address.cs
+   :language: csharp
+   :copyable:
+   :dedent:
+
+.. literalinclude:: /includes/code-examples/GradeEntry.cs
+   :language: csharp
+   :copyable:
+   :dedent:
+
+.. include:: /includes/convention-pack-note.rst
diff --git a/source/usage-examples/deleteMany.txt b/source/usage-examples/deleteMany.txt
@@ -4,7 +4,12 @@
 Delete Many Documents
 =====================
 
-.. default-domain:: mongodb
+.. facet::
+   :name: genre
+   :values: reference
+
+.. meta::
+   :keywords: code example, .NET, operation
 
 .. contents:: On this page
    :local:
@@ -18,26 +23,6 @@ method or the ``DeleteManyAsync()`` asynchronous method on a collection object.
 Example
 -------
 
-The examples on this page use the following ``Restaurant``, ``Address``, and ``GradeEntry`` 
-classes as models:
-
-.. literalinclude:: /includes/code-examples/Restaurant.cs
-   :language: csharp
-   :copyable:
-   :dedent:
-
-.. literalinclude:: /includes/code-examples/Address.cs
-   :language: csharp
-   :copyable:
-   :dedent:
-
-.. literalinclude:: /includes/code-examples/GradeEntry.cs
-   :language: csharp
-   :copyable:
-   :dedent:
-
-.. include:: /includes/convention-pack-note.rst
-
 The following code deletes all documents in the ``restaurants`` collection whose 
 ``borough`` field value equals the word "Brooklyn".
 

diff --git a/source/usage-examples/deleteOne.txt b/source/usage-examples/deleteOne.txt
@@ -4,7 +4,12 @@
 Delete a Document
 =================
 
-.. default-domain:: mongodb
+.. facet::
+   :name: genre
+   :values: reference
+
+.. meta::
+   :keywords: code example, .NET, operation
 
 .. contents:: On this page
    :local:
@@ -22,31 +27,11 @@ You can delete a document from a collection by using the synchronous
 
    To learn more about using ``DeleteMany()``, see :ref:`csharp-delete-many`.
 
-Examples
---------
-
-The examples on this page use the following ``Restaurant``, ``Address``, and ``GradeEntry`` 
-classes as models:
-
-.. literalinclude:: /includes/code-examples/Restaurant.cs
-   :language: csharp
-   :copyable:
-   :dedent:
-
-.. literalinclude:: /includes/code-examples/Address.cs
-   :language: csharp
-   :copyable:
-   :dedent:
-
-.. literalinclude:: /includes/code-examples/GradeEntry.cs
-   :language: csharp
-   :copyable:
-   :dedent:
-
-.. include:: /includes/convention-pack-note.rst
+Example
+-------
 
-Delete a Document Using Builders
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Delete a Document by Using Builders
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 The following example uses ``Builders`` to delete a document in 
 the ``restaurants`` collection with the ``name`` "Ready Penny Inn".

diff --git a/source/usage-examples/findMany.txt b/source/usage-examples/findMany.txt
@@ -4,7 +4,12 @@
 Find Multiple Documents
 =======================
 
-.. default-domain:: mongodb
+.. facet::
+   :name: genre
+   :values: reference
+
+.. meta::
+   :keywords: code example, .NET, operation
 
 .. contents:: On this page
    :local:
@@ -15,31 +20,11 @@ Find Multiple Documents
 You can retrieve multiple documents from a collection by using the 
 ``Find()`` method.
 
-Examples
---------
-
-The examples on this page use the following ``Restaurant``, ``Address``, and ``GradeEntry`` 
-classes as models:
-
-.. literalinclude:: /includes/code-examples/Restaurant.cs
-   :language: csharp
-   :copyable:
-   :dedent:
-
-.. literalinclude:: /includes/code-examples/Address.cs
-   :language: csharp
-   :copyable:
-   :dedent:
-
-.. literalinclude:: /includes/code-examples/GradeEntry.cs
-   :language: csharp
-   :copyable:
-   :dedent:
-
-.. include:: /includes/convention-pack-note.rst
+Example
+-------
 
-Find Documents Using Builders
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
+Find Documents by Using Builders
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
 
 The following example uses ``Builders`` to find documents in 
 the ``restaurants`` collection with the ``cuisine`` "Pizza".
@@ -77,8 +62,8 @@ corresponding code.
       find multiple documents, see
       `Synchronous Find Multiple Example <{+example+}/find-many/FindMany.cs>`__.
 
-Find Documents Using LINQ
-~~~~~~~~~~~~~~~~~~~~~~~~~
+Find Documents by Using LINQ
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 The following example uses LINQ to find documents in the
 ``restaurants`` collection with the ``cuisine`` "Pizza".

diff --git a/source/usage-examples/findOne.txt b/source/usage-examples/findOne.txt
@@ -4,7 +4,12 @@
 Find a Document
 ===============
 
-.. default-domain:: mongodb
+.. facet::
+   :name: genre
+   :values: reference
+
+.. meta::
+   :keywords: code example, .NET, operation
 
 .. contents:: On this page
    :local:
@@ -14,31 +19,11 @@ Find a Document
 
 You can retrieve a document by using the ``Find()`` method on a collection object.
 
-Examples
---------
-
-The examples on this page use the following ``Restaurant``, ``Address``, and ``GradeEntry`` 
-classes as models:
-
-.. literalinclude:: /includes/code-examples/Restaurant.cs
-   :language: csharp
-   :copyable:
-   :dedent:
-
-.. literalinclude:: /includes/code-examples/Address.cs
-   :language: csharp
-   :copyable:
-   :dedent:
-
-.. literalinclude:: /includes/code-examples/GradeEntry.cs
-   :language: csharp
-   :copyable:
-   :dedent:
-
-.. include:: /includes/convention-pack-note.rst
+Example
+-------
 
-Find a Document Using Builders
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Find a Document by Using Builders
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 The following example uses ``Builders`` to find a document in the ``restaurants``
 collection that has a ``name`` field with a value of "Bagels N Buns".
@@ -74,8 +59,8 @@ corresponding code.
       For a fully runnable example of using the ``Find()`` method
       to synchronously find one document, see the `Synchronous Find One Example <{+example+}/find-one/FindOne.cs>`__.
 
-Find a Document Using LINQ
-~~~~~~~~~~~~~~~~~~~~~~~~~~
+Find a Document by Using LINQ
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 The following example uses LINQ to find a document in the ``restaurants``
 collection that has a ``name`` field with a value of "Bagels N Buns".

diff --git a/source/usage-examples/insertMany.txt b/source/usage-examples/insertMany.txt
@@ -4,7 +4,12 @@
 Insert Multiple Documents
 =========================
 
-.. default-domain:: mongodb
+.. facet::
+   :name: genre
+   :values: reference
+
+.. meta::
+   :keywords: code example, .NET, operation
 
 .. contents:: On this page
    :local:
@@ -15,29 +20,9 @@ Insert Multiple Documents
 You can insert multiple documents into a collection by using the synchronous
 ``InsertMany()`` method or the asynchronous ``InsertManyAsync()`` method.
 
-Examples
---------
-
-The examples on this page use the following ``Restaurant``, ``Address``, and ``GradeEntry`` 
-classes as models:
-
-.. literalinclude:: /includes/code-examples/Restaurant.cs
-   :language: csharp
-   :copyable:
-   :dedent:
-
-.. literalinclude:: /includes/code-examples/Address.cs
-   :language: csharp
-   :copyable:
-   :dedent:
-
-.. literalinclude:: /includes/code-examples/GradeEntry.cs
-   :language: csharp
-   :copyable:
-   :dedent:
+Example
+-------
 
-.. include:: /includes/convention-pack-note.rst
-
 The following example inserts multiple documents into 
 the ``restaurants`` collection.
 

diff --git a/source/usage-examples/insertOne.txt b/source/usage-examples/insertOne.txt
@@ -4,7 +4,12 @@
 Insert a Document
 =================
 
-.. default-domain:: mongodb
+.. facet::
+   :name: genre
+   :values: reference
+
+.. meta::
+   :keywords: code example, .NET, operation
 
 .. contents:: On this page
    :local:
@@ -15,31 +20,10 @@ Insert a Document
 You can insert a single document into a collection by using the synchronous
 ``InsertOne()`` method, or the asynchronous ``InsertOneAsync()`` method.
 
-Examples
---------
+Example
+-------
 
-The examples on this page use the following ``Restaurant``, ``Address``, and ``GradeEntry`` 
-classes as models:
-
-.. literalinclude:: /includes/code-examples/Restaurant.cs
-   :language: csharp
-   :copyable:
-   :dedent:
-
-.. literalinclude:: /includes/code-examples/Address.cs
-   :language: csharp
-   :copyable:
-   :dedent:
-
-.. literalinclude:: /includes/code-examples/GradeEntry.cs
-   :language: csharp
-   :copyable:
-   :dedent:
-
-.. include:: /includes/convention-pack-note.rst
-
-The following example inserts a document into 
-the ``restaurants`` collection.
+The following example inserts a document into the ``restaurants`` collection.
 
 Select the :guilabel:`Asynchronous` or :guilabel:`Synchronous` tab to see the 
 corresponding code.

diff --git a/source/usage-examples/replaceOne.txt b/source/usage-examples/replaceOne.txt
@@ -4,7 +4,12 @@
 Replace a Document
 ==================
 
-.. default-domain:: mongodb
+.. facet::
+   :name: genre
+   :values: reference
+
+.. meta::
+   :keywords: code example, .NET, operation
 
 .. contents:: On this page
    :local:
@@ -18,26 +23,6 @@ or the ``ReplaceOneAsync()`` asynchronous method on a collection object.
 Example
 -------
 
-The examples on this page use the following ``Restaurant``, ``Address``, and ``GradeEntry`` 
-classes as models:
-
-.. literalinclude:: /includes/code-examples/Restaurant.cs
-   :language: csharp
-   :copyable:
-   :dedent:
-
-.. literalinclude:: /includes/code-examples/Address.cs
-   :language: csharp
-   :copyable:
-   :dedent:
-
-.. literalinclude:: /includes/code-examples/GradeEntry.cs
-   :language: csharp
-   :copyable:
-   :dedent:
-
-.. include:: /includes/convention-pack-note.rst
-
 The following code replaces the first document in the ``restaurants`` collection that has a 
 value of "Pizza" in the ``cuisine`` field. After the replacement, this document will 
 have a ``name`` field with a value of "Mongo's Pizza" and new values for the