Skip to content

Commit

Permalink
Merge branch 'v1.10' of ssh://github.com/mongodb/docs-golang into v1.10
Browse files Browse the repository at this point in the history
  • Loading branch information
norareidy committed Oct 5, 2023
2 parents c08a707 + f7b94ee commit 3bd3d47
Show file tree
Hide file tree
Showing 9 changed files with 51 additions and 12 deletions.
4 changes: 3 additions & 1 deletion source/compatibility.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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. <about-driver-compatibility>`
:ref:`MongoDB Compatibility Tables. <about-driver-compatibility>`
19 changes: 17 additions & 2 deletions source/fundamentals/connection.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ Connection Guide

.. default-domain:: mongodb

.. facet::
:name: genre
:values: tutorial

.. contents:: On this page
:local:
:backlinks: none
Expand All @@ -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
--------------
Expand Down Expand Up @@ -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
Expand All @@ -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
<golang-stable-api>`.

Expand Down
5 changes: 3 additions & 2 deletions source/fundamentals/crud/read-operations.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand All @@ -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
Expand Down
3 changes: 2 additions & 1 deletion source/fundamentals/crud/write-operations.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
1 change: 0 additions & 1 deletion source/fundamentals/crud/write-read-pref.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
7 changes: 7 additions & 0 deletions source/includes/fact-environments.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
- `MongoDB Atlas
<https://www.mongodb.com/docs/atlas>`__: The fully
managed service for MongoDB deployments in the cloud
- :ref:`MongoDB Enterprise <install-mdb-enterprise>`: The
subscription-based, self-managed version of MongoDB
- :ref:`MongoDB Community <install-mdb-community-edition>`: The
source-available, free-to-use, and self-managed version of MongoDB
18 changes: 15 additions & 3 deletions source/index.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@

.. default-domain:: mongodb

.. facet::
:name: genre
:values: reference

.. toctree::
:titlesonly:
:maxdepth: 1
Expand All @@ -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 <https://pkg.go.dev/cmd/go/internal/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 <https://pkg.go.dev/cmd/go/internal/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
-----------

Expand Down
3 changes: 2 additions & 1 deletion source/usage-examples/find-operations.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
3 changes: 2 additions & 1 deletion source/usage-examples/write-operations.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down

0 comments on commit 3bd3d47

Please sign in to comment.