updated callout types (#145)

kyuan-mongodb · web-flow · commit 68a285f661ad · 2021-08-03T09:44:54.000-04:00
diff --git a/source/fundamentals/aggregation.txt b/source/fundamentals/aggregation.txt
@@ -101,7 +101,7 @@ Connect to a MongoDB Deployment
        }
    }
 
-.. tip::
+.. seealso::
 
    For information on connecting to MongoDB, see the :ref:`Connection Guide <mongoclient>`
 
@@ -133,7 +133,7 @@ In the following example, the aggregation pipeline:
 - Uses a :manual:`$group </reference/operator/aggregation/group/>` stage to group the matching documents by the ``stars``
   field, accumulating a count of documents for each distinct value of ``stars``.
 
-.. note::
+.. seealso::
 
    You can build the expressions used in this example using the :ref:`aggregation builders <aggregates-builders>`.
 
diff --git a/source/fundamentals/builders/aggregates.txt b/source/fundamentals/builders/aggregates.txt
@@ -274,7 +274,7 @@ Use the ``out()`` method to create an :manual:`$out </reference/operator/aggrega
 pipeline stage that writes all documents to the specified collection in
 the same database.
 
-.. tip::
+.. important::
 
    The ``$out`` stage must be the last stage in any aggregation pipeline.
 
@@ -293,7 +293,7 @@ Merge
 Use the ``merge()`` method to create a :manual:`$merge </reference/operator/aggregation/merge/>`
 pipeline stage that merges all documents into the specified collection.
 
-.. tip::
+.. important::
 
    The ``$merge`` stage must be the last stage in any aggregation pipeline.
 
diff --git a/source/fundamentals/builders/projections.txt b/source/fundamentals/builders/projections.txt
@@ -254,7 +254,7 @@ When you've specified matching criteria in the **query** portion of your operati
 variant to specify a :manual:`positional projection </reference/operator/projection/positional/#sorts-and-the-positional-operator>` to include
 the first element of an array. Only documents that match the query filter will be retrieved.
 
-.. warning::
+.. important::
 
    In MongoDB versions < 4.4, the specified array field must appear in the query filter. Beginning in MongoDB 4.4,
    you can use a positional project on an array field that does not appear in the query filter.
diff --git a/source/fundamentals/connection.txt b/source/fundamentals/connection.txt
@@ -40,7 +40,7 @@ instance of a ``MongoClient``, even across multiple threads. All resource
 usage limits, such as max connections, apply to individual
 ``MongoClient`` instances.
 
-.. note::
+.. tip::
 
    Always call ``MongoClient.close()`` to clean up resources when an
    instance is no longer needed.
@@ -162,7 +162,7 @@ Select the tab corresponding to the code snippet you would like to see:
          MongoClient mongoClient = MongoClients.create(settings);
 
 
-.. note::
+.. tip::
 
    Although it is possible to connect to a replica set deployment by
    providing only a single host, you should provide the driver with the
diff --git a/source/fundamentals/connection/jndi.txt b/source/fundamentals/connection/jndi.txt
@@ -105,7 +105,7 @@ JNDI DataSource.
       This will make a ``MongoClient`` instance accessible via the JNDI name
       ``mongodb/MyMongoClient`` in the ``java:comp/env`` context.
 
-.. note::
+.. seealso::
 
    For JNDI implementations other than those listed here, you can create
    your own ``Factory`` wrapper based on the driver's built-in
diff --git a/source/fundamentals/crud/compound-operations.txt b/source/fundamentals/crud/compound-operations.txt
@@ -312,7 +312,7 @@ instance:
 - Try to find an empty room for Pat and reserve it. As there are not any rooms
   left, return ``null``. 
 
-.. note:: Write Lock
+.. important:: Write Lock
 
    Your MongoDB instance places a write lock on the document you are modifying
    for the duration of your compound operation. 
diff --git a/source/fundamentals/crud/read-operations/cursor.txt b/source/fundamentals/crud/read-operations/cursor.txt
@@ -150,7 +150,7 @@ iterate through results in a functional style:
    :start-after: begin forEachIteration
    :end-before: end forEachIteration
 
-.. warning::
+.. important::
 
    Initiating methods return objects that implement the ``Iterable`` interface which allows you
    to iterate through them using iterator methods. Sometimes, we use an enhanced
diff --git a/source/fundamentals/crud/read-operations/geo.txt b/source/fundamentals/crud/read-operations/geo.txt
@@ -54,7 +54,7 @@ containing two or three number values:
 - Latitude in the second position (required)
 - Elevation in the third position (optional)
 
-.. tip:: Longitude then Latitude
+.. important:: Longitude then Latitude
 
   GeoJSON orders coordinates as longitude first and latitude second. This may
   be surprising as geographic coordinate system conventions generally list
@@ -138,7 +138,7 @@ For more information on legacy coordinate pairs, see the
 
 .. external resource
 
-.. note:: Supported Operators
+.. tip:: Supported Operators
 
    Spherical (``2dsphere``) and flat (``2d``) indexes support some, but
    not all, of the same query operators. For a full list of operators
@@ -248,7 +248,7 @@ The output of the code snippet should look something like this:
    {"location": {"address": {"city": "Flushing"}}}
    {"location": {"address": {"city": "Elmhurst"}}}
 
-.. note:: Fun Fact
+.. tip:: Fun Fact
 
    MongoDB uses the
    :manual:`same reference system </reference/glossary/#std-term-WGS84>`
diff --git a/source/fundamentals/crud/read-operations/limit.txt b/source/fundamentals/crud/read-operations/limit.txt
@@ -92,7 +92,7 @@ length:
     Document{{_id=6, title=A Dance with Dragons, author=Martin, length=1104}}
     Document{{_id=4, title=Infinite Jest, author=Wallace, length=1104}}
 
-.. note::
+.. tip::
 
    The order in which you call ``limit()`` and ``sort()`` does not matter
    because the driver reorders the calls to apply the sort first and the
diff --git a/source/fundamentals/crud/read-operations/retrieve.txt b/source/fundamentals/crud/read-operations/retrieve.txt
@@ -150,7 +150,7 @@ To open a change stream, call the ``watch()`` method on an instance of a
 You can pass an aggregation pipeline to this method to notify you as
 soon as a change occurs.
 
-.. note::
+.. important::
 
    Change streams don't support standalone MongoDB instances because
    standalone MongoDB instances don't have an oplog. 
diff --git a/source/fundamentals/crud/read-operations/skip.txt b/source/fundamentals/crud/read-operations/skip.txt
@@ -106,6 +106,7 @@ After the paint store runs the query, they find the three best-selling colors ar
 red, and white. 
 
 .. note::
+
    If the value of skip is greater than or equal to the number of matched
    documents for a query, that query returns no documents.
 
diff --git a/source/fundamentals/crud/read-operations/sort.txt b/source/fundamentals/crud/read-operations/sort.txt
@@ -315,7 +315,7 @@ indicate how closely each result matches the search string. Use the
 ``Sorts.metaTextScore()`` static factory method to build your sort criteria to
 sort by the text score.
 
-.. warning:: Make Sure to Create a Text Index
+.. important:: Make Sure to Create a Text Index
 
    You need a :manual:`text index </core/index-text/>` on your collection to
    perform a text search. See the server manual documentation for more
diff --git a/source/fundamentals/crud/read-operations/text.txt b/source/fundamentals/crud/read-operations/text.txt
@@ -209,7 +209,7 @@ builder method.
 None of the documents returned from the search contain the excluded term
 in your text index field. 
 
-.. note::
+.. important::
 
    You must have at least one text search term if you want to
    exclude terms from your search. 
diff --git a/source/fundamentals/crud/write-operations/bulk.txt b/source/fundamentals/crud/write-operations/bulk.txt
@@ -68,7 +68,7 @@ where the ``_id`` values are "3" and "4":
    :start-after: begin insertDocumentsExample
    :end-before: end insertDocumentsExample
 
-.. note::
+.. important::
 
    When performing a ``bulkWrite()``, the ``InsertOneModel`` cannot
    insert a document with an ``_id`` that already exists in the
@@ -108,7 +108,7 @@ To perform a replace operation, create a ``ReplaceOneModel`` specifying
 a query filter for the document you want to replace with the replacement
 document. 
 
-.. note::
+.. important::
 
    When performing a ``bulkWrite()``, the ``ReplaceOneModel`` cannot
    make changes to a document that violate unique index constraints on
@@ -145,7 +145,7 @@ The ``UpdateOneModel`` updates the first document that matches your query
 filter and the ``UpdateManyModel`` updates all the documents that
 match your query filter. 
 
-.. note::
+.. important::
 
    When performing a ``bulkWrite()``, the ``UpdateOneModel`` and
    ``UpdateManyModel`` cannot make changes to a document that violate
@@ -183,7 +183,7 @@ The ``DeleteOneModel`` deletes the first document that matches your query
 filter and the ``DeleteManyModel`` deletes all the documents that
 match your query filter. 
 
-.. note::
+.. important::
 
    When performing a ``bulkWrite()``, the ``DeleteOneModel`` and
    ``DeleteManyModel`` do not delete any documents if there are no matches
diff --git a/source/fundamentals/crud/write-operations/change-a-document.txt b/source/fundamentals/crud/write-operations/change-a-document.txt
@@ -120,7 +120,7 @@ our :doc:`upsert guide </fundamentals/crud/write-operations/upsert>` to
 learn how to insert a new document instead of updating one if no
 documents match. 
 
-.. note::
+.. important::
 
     The ``updateOne()`` and ``updateMany()`` methods cannot make changes
     to a document that violate unique index constraints on the
@@ -198,7 +198,7 @@ documents match.
 If multiple documents match the query filter specified in
 the ``replaceOne()`` method, it replaces the first result. 
 
-.. note::
+.. important::
 
     The ``replaceOne()`` method cannot make changes to a document that
     violate unique index constraints on the collection. See the MongoDB
diff --git a/source/fundamentals/crud/write-operations/insert.txt b/source/fundamentals/crud/write-operations/insert.txt
@@ -109,7 +109,7 @@ If you attempt to insert these documents, a ``WriteError`` occurs at the
 third document and the documents prior to the error get inserted into
 your collection. 
 
-.. note::
+.. tip::
 
    Use a try-catch block to get an acknowledgment for successfully
    processed documents before the error occurs:
diff --git a/source/fundamentals/data-formats/documents.txt b/source/fundamentals/data-formats/documents.txt
@@ -153,7 +153,7 @@ data from the collection using the following code:
            });
    }
 
-.. note::
+.. tip::
 
    The preceding code sample uses helper methods that check the returned type
    and throw an exception if it is unable to cast the field value.
@@ -268,7 +268,7 @@ data from the collection using the following code:
        });
    }
 
-.. note::
+.. tip::
 
    The preceding code sample uses helper methods that check the returned type
    and throw a ``BsonInvalidOperationException`` if it is unable to cast
@@ -359,7 +359,7 @@ The output should look something like this:
 
    query result in extended json format: {"_id": {"$oid": "6035210f35bd203721c3eab8"}, "name": "Gabriel García Márquez", "dateOfDeath": {"$date": "2014-04-17T04:00:00Z"}, "novels": [{"title": "One Hundred Years of Solitude", "yearPublished": 1967}, {"title": "Chronicle of a Death Foretold", "yearPublished": 1981}, {"title": "Love in the Time of Cholera", "yearPublished": 1985}]}
 
-.. example::
+.. tip::
    
    If you would like to work with other formats of JSON strings
    in your application, you can use the ``JsonObjectCodec`` class
@@ -484,7 +484,7 @@ data from the collection using the following code:
        }
    }
 
-.. note::
+.. tip::
 
    The preceding code sample uses helper methods that check the returned type
    and throw an exception if it is unable to cast the field value.
diff --git a/source/fundamentals/data-formats/pojo-customization.txt b/source/fundamentals/data-formats/pojo-customization.txt
@@ -335,7 +335,7 @@ the preceding annotations.
 
 .. _bson-annotation-convention:
 
-.. note::
+.. tip::
 
    When using annotations, remember to specify the
    ``Conventions.ANNOTATION_CONVENTION`` in your ``ClassModelBuilder``
diff --git a/source/fundamentals/databases-collections.txt b/source/fundamentals/databases-collections.txt
@@ -62,7 +62,7 @@ a ``MongoDatabase``:
    MongoDatabase database = mongoClient.getDatabase("testDatabase");
    MongoCollection<Document> collection = database.getCollection("testCollection");
 
-.. note::
+.. tip::
 
    If the provided collection name does not already exist in the database,
    MongoDB implicitly creates the collection when you first insert data
@@ -171,7 +171,7 @@ normally inherit:
 
 - :java-docs:`MongoCollection.withWriteConcern() <apidocs/mongodb-driver-sync/com/mongodb/client/MongoCollection.html#withWriteConcern(com.mongodb.WriteConcern)>`
 
-.. note::
+.. tip::
 
    The ``withReadConcern()``, ``withReadPreference()``, and
    ``withWriteConcern`` methods create a new instance of a
diff --git a/source/fundamentals/enterprise-auth.txt b/source/fundamentals/enterprise-auth.txt
@@ -47,6 +47,7 @@ allows the user to authenticate to a Kerberos service using the user's
 principal name.
 
 .. note::
+
    The method refers to the ``GSSAPI`` authentication mechanism instead
    of ``Kerberos`` because the driver authenticates using the
    `GSSAPI RFC-4652 <https://tools.ietf.org/html/rfc4752>`_  SASL
@@ -120,7 +121,7 @@ You may need to specify one or more of the following additional
    .. tab::
       :tabid: Connection String
 
-      .. note::
+      .. important::
 
          You can only specify the following GSSAPI properties using the
          ``MongoCredential``:
@@ -214,7 +215,8 @@ LDAP (PLAIN)
 You can authenticate to a Lightweight Directory Access Protocol (LDAP)
 server using your directory server username and password.
 
-.. note::
+.. tip::
+
    The authentication mechanism is named ``PLAIN`` instead of ``LDAP`` since it
    authenticates using the `PLAIN Simple Authentication and Security Layer
    (SASL) defined in RFC-4616 <https://tools.ietf.org/html/rfc4616>`_.
diff --git a/source/fundamentals/indexes.txt b/source/fundamentals/indexes.txt
@@ -332,7 +332,7 @@ database is a GeoJSON Point object that describes the coordinates of the theater
 
 The following example creates a ``2dsphere`` index on the ``location.geo`` field:
 
-.. warning::
+.. important::
 
    Attempting to create a geospatial index on a field that is covered by a geospatial index will result in an error.
 
@@ -380,7 +380,7 @@ The following example creates a unique, descending index on the ``theaterId`` fi
    :start-after: begin unique index
    :end-before: end unique index
 
-.. warning::
+.. important::
 
    If you perform a write operation that stores a duplicate value that violates the unique index, the MongoDB
    Java driver will raise a ``DuplicateKeyException``, and MongoDB will throw an error resembling the following:
diff --git a/source/fundamentals/logging.txt b/source/fundamentals/logging.txt
@@ -85,7 +85,7 @@ Example - Set Up
 This example shows how to set up your logger. Click the
 tab corresponding to the logging framework you would like to use in your project.
 
-.. note:: Dependency Versions
+.. tip:: Dependency Versions
 
    The following versions listed are illustrative rather than a
    source of truth. You should check the official documentation for SLF4J and
diff --git a/source/fundamentals/monitoring.txt b/source/fundamentals/monitoring.txt
@@ -89,7 +89,7 @@ For more information on MongoDB database commands, see the
    commands related to connection establishment (such as the initial ``hello``
    command).
 
-.. note:: Redacted Output
+.. important:: Redacted Output
 
    As a security measure, the driver redacts the contents of some command events. This
    protects the sensitive information contained in these command events. For a
@@ -341,7 +341,7 @@ This example shows how you can monitor the driver's connection pools using JMX
 and **JConsole**. JConsole is a JMX compliant GUI monitoring tool that comes with
 the Java Platform.
 
-.. note:: Consult the Official JMX and JConsole Documentation
+.. tip:: Consult the Official JMX and JConsole Documentation
 
    The descriptions of JMX and JConsole in this example are illustrative
    rather than a source of truth. For guaranteed up to date information, consult
diff --git a/source/includes/connect-guide-note.rst b/source/includes/connect-guide-note.rst
@@ -1,4 +1,5 @@
 .. note::
+
     This example connects to an instance of MongoDB using a connection string.
     To learn more about connecting to your MongoDB instance, see the
     `connection guide </fundamentals/connection>`_.
diff --git a/source/includes/legacy-redirect.rst b/source/includes/legacy-redirect.rst
@@ -1,4 +1,4 @@
-.. note:: Legacy API
+.. tip:: Legacy API
 
    If you are using the legacy API, 
    :ref:`see our FAQ page <faq-legacy-connection>`
diff --git a/source/includes/quick-start/jdk-tls-issue.rst b/source/includes/quick-start/jdk-tls-issue.rst
@@ -1,4 +1,4 @@
-.. note:: Known connection issue when using TLS v1.3
+.. important:: Known connection issue when using TLS v1.3
 
    If you encounter an error connecting to your MongoDB instance or cluster
    that resembles the following while running your application, you may need
diff --git a/source/quick-start.txt b/source/quick-start.txt
@@ -48,6 +48,7 @@ project which may require running your dependency manager and refreshing
 the project in your IDE.
 
 .. note::
+
    You may need to configure the JDK version in your IDE and dependency
    file. Refer to the documentation provided by maintainers of your IDE
    and dependency management system.
diff --git a/source/usage-examples/bulkWrite.txt b/source/usage-examples/bulkWrite.txt
@@ -39,7 +39,7 @@ The ``bulkWrite()`` method accepts the following parameters:
    write operations unless they include one or more instances of 
    ``UpdateManyModel`` or ``DeleteManyModel``.
 
-.. note::
+.. tip::
 
   By default, MongoDB executes bulk write operations one-by-one in the
   specified order (i.e. serially). During an ordered bulk write, if
diff --git a/source/usage-examples/command.txt b/source/usage-examples/command.txt

Original file line number	Diff line number	Diff line change
`@@ -101,7 +101,7 @@ Connect to a MongoDB Deployment`
`101`	`101`	`}`
`102`	`102`	`}`
`103`	`103`
`104`		`-.. tip::`
	`104`	`+.. seealso::`
`105`	`105`
`106`	`106`	For information on connecting to MongoDB, see the :ref:`Connection Guide <mongoclient>`
`107`	`107`
`@@ -133,7 +133,7 @@ In the following example, the aggregation pipeline:`
`133`	`133`	- Uses a :manual:`$group </reference/operator/aggregation/group/>` stage to group the matching documents by the ``stars``
`134`	`134`	field, accumulating a count of documents for each distinct value of ``stars``.
`135`	`135`
`136`		`-.. note::`
	`136`	`+.. seealso::`
`137`	`137`
`138`	`138`	You can build the expressions used in this example using the :ref:`aggregation builders <aggregates-builders>`.
`139`	`139`