diff --git a/source/compatibility.txt b/source/compatibility.txt index f2981c99..a39444ac 100644 --- a/source/compatibility.txt +++ b/source/compatibility.txt @@ -18,6 +18,8 @@ The following compatibility table specifies the recommended version of the The first column lists the driver version. +.. sharedinclude:: dbx/lifecycle-schedule-callout.rst + .. sharedinclude:: dbx/compatibility-table-legend.rst .. sharedinclude:: dbx/mongodb-compatibility-table-go.rst @@ -28,4 +30,4 @@ Language Compatibility .. sharedinclude:: dbx/language-compatibility-table-go.rst For more information on how to read the compatibility tables, see our guide on -:ref:`MongoDB Compatibility Tables. ` \ No newline at end of file +:ref:`MongoDB Compatibility Tables. ` diff --git a/source/fundamentals/connection.txt b/source/fundamentals/connection.txt index c9731761..1507ae12 100644 --- a/source/fundamentals/connection.txt +++ b/source/fundamentals/connection.txt @@ -6,6 +6,10 @@ Connection Guide .. default-domain:: mongodb +.. facet:: + :name: genre + :values: tutorial + .. contents:: On this page :local: :backlinks: none @@ -15,6 +19,17 @@ Connection Guide This guide shows you how to connect to a MongoDB instance or replica set deployment using the Go Driver. +------------- +Compatibility +------------- + +You can use the {+driver-short+} to connect to deployments hosted in the +following environments: + +.. include:: /includes/fact-environments.rst + +.. _golang-connection-uri: + -------------- Connection URI -------------- @@ -61,7 +76,7 @@ To connect to MongoDB, you need to create a client. A client manages your connections and runs database commands. .. tip:: Reuse Your Client - + We recommend that you reuse your client across sessions and operations. You can use the same ``Client`` instance to perform multiple tasks, instead of creating a new one each time. The ``Client`` type is safe for @@ -83,7 +98,7 @@ more about creating a client, see the API documentation for `Client <{+api+}/mongo#Client>`__ and `Connect() <{+api+}/mongo#Connect>`__. You can set the {+stable-api+} version as an option to avoid -breaking changes when you upgrade to a new server version. To +breaking changes when you upgrade to a new server version. To learn more about the {+stable-api+} feature, see the :ref:`{+stable-api+} page `. diff --git a/source/fundamentals/crud/read-operations.txt b/source/fundamentals/crud/read-operations.txt index 673bdce5..ee2b97d5 100644 --- a/source/fundamentals/crud/read-operations.txt +++ b/source/fundamentals/crud/read-operations.txt @@ -4,7 +4,8 @@ Read Operations =============== -.. default-domain:: mongodb +.. meta:: + :description: Learn about the commands for running MongoDB read operations by using the {+driver-long+}. - :ref:`golang-query-document` - :ref:`golang-count-documents` @@ -20,7 +21,7 @@ Read Operations .. toctree:: :caption: Read Operations - + /fundamentals/crud/read-operations/query-document /fundamentals/crud/read-operations/count /fundamentals/crud/read-operations/retrieve diff --git a/source/fundamentals/crud/write-operations.txt b/source/fundamentals/crud/write-operations.txt index d75bedc5..79a58ab4 100644 --- a/source/fundamentals/crud/write-operations.txt +++ b/source/fundamentals/crud/write-operations.txt @@ -4,7 +4,8 @@ Write Operations ================ -.. default-domain:: mongodb +.. meta:: + :description: Learn about the commands for running MongoDB write operations by using the {+driver-long+}. - :ref:`golang-insert-guide` - :ref:`golang-delete-guide` diff --git a/source/fundamentals/crud/write-read-pref.txt b/source/fundamentals/crud/write-read-pref.txt index 27153b5c..1610d276 100644 --- a/source/fundamentals/crud/write-read-pref.txt +++ b/source/fundamentals/crud/write-read-pref.txt @@ -29,7 +29,6 @@ the following levels: - Transaction level - Database level - Collection level -- Query level You should read this guide if you need to customize the consistency and availability of the data in your replica sets. diff --git a/source/includes/fact-environments.rst b/source/includes/fact-environments.rst new file mode 100644 index 00000000..0cae4338 --- /dev/null +++ b/source/includes/fact-environments.rst @@ -0,0 +1,7 @@ +- `MongoDB Atlas + `__: The fully + managed service for MongoDB deployments in the cloud +- :ref:`MongoDB Enterprise `: The + subscription-based, self-managed version of MongoDB +- :ref:`MongoDB Community `: The + source-available, free-to-use, and self-managed version of MongoDB diff --git a/source/index.txt b/source/index.txt index e544b06f..533b94fc 100644 --- a/source/index.txt +++ b/source/index.txt @@ -4,6 +4,10 @@ .. default-domain:: mongodb +.. facet:: + :name: genre + :values: reference + .. toctree:: :titlesonly: :maxdepth: 1 @@ -25,11 +29,19 @@ Introduction ------------ -Welcome to the documentation site for the official {+driver-long+}. -You can add the driver to your application to work with MongoDB in Go. -Download it using `go get `__ +Welcome to the documentation site for the official {+driver-long+}. +You can add the driver to your application to work with MongoDB in Go. +Download it using `go get `__ or set up a runnable project by following our Quick Start guide. +Compatibility +------------- + +You can use the {+driver-short+} to connect to deployments hosted in the +following environments: + +.. include:: /includes/fact-environments.rst + Quick Start ----------- diff --git a/source/usage-examples/find-operations.txt b/source/usage-examples/find-operations.txt index e390ae35..b6a9b9e9 100644 --- a/source/usage-examples/find-operations.txt +++ b/source/usage-examples/find-operations.txt @@ -2,7 +2,8 @@ Find Operations =============== -.. default-domain:: mongodb +.. meta:: + :description: Learn by example: how to create queries and retrieve data by using the {+driver-long+}. - :ref:`golang-find-one` - :ref:`golang-find-multiple` diff --git a/source/usage-examples/write-operations.txt b/source/usage-examples/write-operations.txt index 2ca3f721..adf758f5 100644 --- a/source/usage-examples/write-operations.txt +++ b/source/usage-examples/write-operations.txt @@ -2,7 +2,8 @@ Write Operations ================ -.. default-domain:: mongodb +.. meta:: + :description: Learn by example: how to insert, update, and delete data by using the {+driver-long+}. - :ref:`golang-insert-one` - :ref:`golang-insert-many`