Docsp 18440 (#44)

terakilobyte · web-flow · commit fc851739ddb3 · 2021-09-09T12:32:17.000-07:00
* remove visible todos

* fix link

* link replace to change

* link to retrieve guide

* update api constant

* add ref and link to insert

* hide upsert page

* remove upsert from toctree

* rename ref
diff --git a/source/fundamentals/crud/write-operations.txt b/source/fundamentals/crud/write-operations.txt
@@ -6,9 +6,9 @@ Write Operations
 
 - :doc:`/fundamentals/crud/write-operations/insert`
 - :doc:`/fundamentals/crud/write-operations/change-a-document`
-- :doc:`/fundamentals/crud/write-operations/upsert`
 
 ..
+  - :doc:`/fundamentals/crud/write-operations/upsert`
   - :doc:`/fundamentals/crud/write-operations/delete`
   - :doc:`/fundamentals/crud/write-operations/embedded-arrays`
 
@@ -17,8 +17,8 @@ Write Operations
 
    /fundamentals/crud/write-operations/insert
    /fundamentals/crud/write-operations/change-a-document
-   /fundamentals/crud/write-operations/upsert
 
 ..
+  /fundamentals/crud/write-operations/upsert
   /fundamentals/crud/write-operations/delete
   /fundamentals/crud/write-operations/embedded-arrays
diff --git a/source/fundamentals/crud/write-operations/change-a-document.txt b/source/fundamentals/crud/write-operations/change-a-document.txt
@@ -10,6 +10,8 @@ Change a Document
    :depth: 2
    :class: singlecol
 
+.. _change_document_golang:
+
 Overview
 --------
 
@@ -207,9 +209,7 @@ successful. The ``UpdateResult`` type contains the following properties:
 
 If multiple documents match the query filter passed to ``ReplaceOne()``,
 the method selects and replaces the first matched document. Your replace
-operation will fail if no documents match the query filter. See our **<TODO:
-link>** upsert guide to learn how to insert a new document if no
-documents match the query filter.
+operation will fail if no documents match the query filter.
 
 Example
 ~~~~~~~
diff --git a/source/fundamentals/crud/write-operations/insert.txt b/source/fundamentals/crud/write-operations/insert.txt
@@ -10,6 +10,8 @@ Insert a Document
    :depth: 1
    :class: singlecol
 
+.. _insert_guide_golang:
+
 Overview
 --------
 
@@ -88,8 +90,8 @@ The output should look like this:
 For more information on the types and functions mentioned in this
 section, see the following resources:
 
-- `InsertOne() <{+godocs+}/mongo#Collection.InsertOne>`__  API documentation
-- `InsertOneResult <{+godocs+}/mongo#InsertOneResult>`__ API documentation
+- `InsertOne() <{+api+}/mongo#Collection.InsertOne>`__  API documentation
+- `InsertOneResult <{+api+}/mongo#InsertOneResult>`__ API documentation
 - Server Manual Entry on :manual:`insertOne() </reference/method/db.collection.insertOne/>`
 - Runnable :doc:`Insert a Document Usage Example </usage-examples/insertOne>`
 
@@ -195,7 +197,7 @@ Your output should look like this:
 For more information on the types and functions mentioned in this
 section, see the following resources:
 
-- `InsertMany() <{+godocs+}/mongo#Collection.InsertMany>`__ API documentation
-- `InsertManyResult <{+godocs+}/mongo#InsertManyResult>`__ API documentation
+- `InsertMany() <{+api+}/mongo#Collection.InsertMany>`__ API documentation
+- `InsertManyResult <{+api+}/mongo#InsertManyResult>`__ API documentation
 - Server Manual Entry on :manual:`insertMany() </reference/method/db.collection.insertMany/>`
 - Runnable :doc:`Insert Multiple Documents Example </usage-examples/insertMany>`
diff --git a/source/usage-examples/bulkWrite.txt b/source/usage-examples/bulkWrite.txt
@@ -48,9 +48,10 @@ a Document Usage Example </usage-examples/findOne>`.
 Additional Information
 ----------------------
 
-For more information on performing bulk write operations on a collection
-and handling potential errors, see our guide on <TODO: Bulk Write
-Fundamentals>.
+..
+  For more information on performing bulk write operations on a collection
+  and handling potential errors, see our guide on <TODO: Bulk Write
+  Fundamentals>.
 
 For more information, see our :manual:`Bulk Write Operations
 </core/bulk-write-operations/>` page.
diff --git a/source/usage-examples/command.txt b/source/usage-examples/command.txt
@@ -13,7 +13,7 @@ Example
 .. include:: /includes/usage-examples/run-example-tip.rst
 
 The following example retrieves statistics about the
-``sample_restaurants`` database: 
+``sample_restaurants`` database:
 
 .. literalinclude:: /includes/usage-examples/code-snippets/command.go
    :start-after: begin runCommand
@@ -49,8 +49,9 @@ that contains the following values:
 Additional Information
 ----------------------
 
-For more information on running a command, see our guide on
-<TODO: Run a Command>.
+..
+  For more information on running a command, see our guide on
+  <TODO: Run a Command>.
 
 API Documentation
 ~~~~~~~~~~~~~~~~~
diff --git a/source/usage-examples/count.txt b/source/usage-examples/count.txt
@@ -44,8 +44,9 @@ After you run the preceding example, you should see the following:
 Additional Information
 ----------------------
 
-For more information on counting documents, see our guide on
-<TODO: Counting Documents>.
+..
+  For more information on counting documents, see our guide on
+  <TODO: Counting Documents>.
 
 API Documentation
 ~~~~~~~~~~~~~~~~~
diff --git a/source/usage-examples/deleteMany.txt b/source/usage-examples/deleteMany.txt
@@ -5,15 +5,15 @@ Delete Multiple Documents
 .. default-domain:: mongodb
 
 You can delete multiple documents in a collection by using the
-``DeleteMany()`` method. 
+``DeleteMany()`` method.
 
 Example
 -------
 
 .. include:: /includes/usage-examples/run-example-tip.rst
 
 The following example matches documents in the ``movies`` collection
-in which the ``runtime`` is greater than 800 minutes, deleting all 
+in which the ``runtime`` is greater than 800 minutes, deleting all
 documents matched:
 
 .. literalinclude:: /includes/usage-examples/code-snippets/deleteMany.go
@@ -23,7 +23,7 @@ documents matched:
    :language: go
    :dedent:
 
-Click here <TODO> to see a fully runnable example.
+`Click here <{+example+}/deleteMany.go>`__ to see a fully runnable example.
 
 Expected Result
 ---------------
@@ -46,11 +46,7 @@ Multiple Documents Usage Example </usage-examples/find>`.
 Additional Information
 ----------------------
 
-For more information on deleting documents, specifying query filters,
-and handling potential errors, see our guide on <TODO:
-Deleting a Document>.
-
 API Documentation
 ~~~~~~~~~~~~~~~~~
 
-`DeleteMany() <https://pkg.go.dev/go.mongodb.org/mongo-driver@v1.7.0/mongo#Collection.DeleteMany>`__
+`DeleteMany() <{+api+}/mongo#Collection.DeleteMany>`__
diff --git a/source/usage-examples/deleteOne.txt b/source/usage-examples/deleteOne.txt
@@ -5,7 +5,7 @@ Delete a Document
 .. default-domain:: mongodb
 
 You can delete a document in a collection by using the ``DeleteOne()``
-method. 
+method.
 
 Example
 -------
@@ -23,7 +23,7 @@ matched:
    :language: go
    :dedent:
 
-Click here <TODO> to see a fully runnable example.
+`Click here <{+example+}/deleteOne.go>`__ to see a fully runnable example.
 
 Expected Result
 ---------------
@@ -43,9 +43,10 @@ a Document Usage Example </usage-examples/findOne>`.
 Additional Information
 ----------------------
 
-For more information on deleting documents, specifying query filters,
-and handling potential errors, see our guide on <TODO:
-Deleting a Document>.
+..
+  For more information on deleting documents, specifying query filters,
+  and handling potential errors, see our guide on <TODO:
+  Deleting a Document>.
 
 API Documentation
 ~~~~~~~~~~~~~~~~~
diff --git a/source/usage-examples/find.txt b/source/usage-examples/find.txt
@@ -45,8 +45,8 @@ Additional Information
 ----------------------
 
 For more information on specifying query filters and
-handling potential errors, see our guide on **<TODO: retrieve data
-fundamental page>**.
+handling potential errors, see our guide on
+:doc:`retrieving data </fundamentals/crud/read-operations/retrieve>`.
 
 For more information on query operators,
 see the :manual:`MongoDB query operator reference documentation
diff --git a/source/usage-examples/findOne.txt b/source/usage-examples/findOne.txt
@@ -13,7 +13,7 @@ Example
 .. include:: /includes/usage-examples/run-example-tip.rst
 
 The following example matches documents in the ``movies`` collection
-in which the ``title`` is "The Room", returning the first document 
+in which the ``title`` is "The Room", returning the first document
 matched:
 
 .. literalinclude:: /includes/usage-examples/code-snippets/findOne.go
@@ -45,8 +45,8 @@ Additional Information
 ----------------------
 
 For more information on specifying query filters and
-handling potential errors, see our guide on **<TODO: retrieve data
-fundamental page>**.
+handling potential errors, see our guide on
+:doc:`retrieving data </fundamentals/crud/read-operations/retrieve>`.
 
 For more information on query operators,
 see the :manual:`MongoDB query operator reference documentation
diff --git a/source/usage-examples/insertMany.txt b/source/usage-examples/insertMany.txt
@@ -12,7 +12,7 @@ Example
 
 .. include:: /includes/usage-examples/run-example-tip.rst
 
-The following example inserts two documents in the ``haikus`` collection: 
+The following example inserts two documents in the ``haikus`` collection:
 
 .. note:: Non-existent Database and Collections
 
@@ -55,7 +55,7 @@ Additional Information
 ----------------------
 
 For more information on inserting documents, see our guide on
-**<TODO: inserting documents fundamental page>**.
+:ref:`inserting documents <insert_guide_golang>`.
 
 API Documentation
 ~~~~~~~~~~~~~~~~~
diff --git a/source/usage-examples/insertOne.txt b/source/usage-examples/insertOne.txt
@@ -50,7 +50,7 @@ Additional Information
 ----------------------
 
 For more information on inserting documents, see our guide on
-**<TODO: inserting documents fundamental page>**.
+:ref:`inserting documents <insert_guide_golang>`.
 
 API Documentation
 ~~~~~~~~~~~~~~~~~
diff --git a/source/usage-examples/replaceOne.txt b/source/usage-examples/replaceOne.txt
@@ -49,8 +49,7 @@ Additional Information
 ----------------------
 
 For more information on replacing documents, specifying query filters, and
-handling potential errors, see our guide on **<TODO: change a document
-fundamental page>**.
+handling potential errors, see our guide on :ref:`changing a document <change_document_golang>`.
 
 API Documentation
 ~~~~~~~~~~~~~~~~~
diff --git a/source/usage-examples/updateMany.txt b/source/usage-examples/updateMany.txt
@@ -25,13 +25,13 @@ The following example performs the following on the
    :language: go
    :dedent:
 
-Click here **<TODO: github link to file>** to see a fully runnable example.
+`Click here <{+example+}/updateMany.go>`__ to see a fully runnable example.
 
 Expected Result
 ---------------
 
 After you run the preceding example, you can find the following updated
-documents in the ``listingsAndReviews`` collection: 
+documents in the ``listingsAndReviews`` collection:
 
 .. code-block:: json
    :copyable: false
@@ -49,9 +49,8 @@ Multiple Documents Usage Example </usage-examples/find>`.
 Additional Information
 ----------------------
 
-For more information on updating documents, specifying query filters, and
-handling potential errors, see our guide on **<TODO: change a document
-fundamental page>**.
+For more information on replacing documents, specifying query filters, and
+handling potential errors, see our guide on :ref:`changing a document <change_document_golang>`.
 
 For more information on update operators,
 see the :manual:`MongoDB update operator reference documentation
diff --git a/source/usage-examples/updateOne.txt b/source/usage-examples/updateOne.txt
@@ -5,7 +5,7 @@ Update a Document
 .. default-domain:: mongodb
 
 You can update a document in a collection by using the ``UpdateOne()``
-method. 
+method.
 
 Example
 -------
@@ -15,7 +15,7 @@ Example
 The following example performs the following on the ``restaurants``
 collection:
 
-- Matches a document with a specific ``_id`` 
+- Matches a document with a specific ``_id``
 - Creates a new field in the matched document called ``avg_rating`` with a value of 4.4
 
 .. literalinclude:: /includes/usage-examples/code-snippets/updateOne.go
@@ -25,19 +25,19 @@ collection:
    :language: go
    :dedent:
 
-Click here **<TODO: github link to file>** to see a fully runnable example.
+`Click here <{+example+}/updateOne.go>`__ to see a fully runnable example.
 
 Expected Result
 ---------------
 
 After you run the preceding example, you can find the following updated
-document in the ``restaurants`` collection: 
+document in the ``restaurants`` collection:
 
 .. code-block:: json
    :copyable: false
 
    // result truncated
-   { 
+   {
       "_id" : ObjectId("5eb3d668b31de5d588f42a7a"),
       ...
       "name" : "Green House Cafe",
@@ -51,9 +51,8 @@ a Document Usage Example </usage-examples/findOne>`.
 Additional Information
 ----------------------
 
-For more information on updating documents, specifying query filters, and
-handling potential errors, see our guide on **<TODO: change a document
-fundamental page>**.
+For more information on replacing documents, specifying query filters, and
+handling potential errors, see our guide on :ref:`changing a document <change_document_golang>`.
 
 For more information on update operators,
 see the :manual:`MongoDB update operator reference documentation
diff --git a/source/usage-examples/watch.txt b/source/usage-examples/watch.txt
@@ -30,7 +30,7 @@ Expected Result
 After you run the preceding example, run the :doc:`Insert a
 Document usage example </usage-examples/insertOne>` in a different
 shell. Once you run the insert operation, you should see the following
-output: 
+output:
 
 .. code-block:: json
    :copyable: false
@@ -47,9 +47,11 @@ Additional Information
 ----------------------
 
 For more information on opening a change stream and handling
-potential errors, see the following guides:
+potential errors, see:
+
+..
+  - Go Driver <TODO: Change Stream Guide>
 
-- Go Driver <TODO: Change Stream Guide>
 - MongoDB Server Manual :manual:`Change Streams Documentation </changeStreams>`.
 
 API Documentation
