Skip to content

Commit

Permalink
update headings and styles
Browse files Browse the repository at this point in the history
  • Loading branch information
stephmarie17 committed Jan 29, 2025
1 parent 4421603 commit 740235a
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 20 deletions.
2 changes: 1 addition & 1 deletion source/includes/quick-start/atlas-setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ into your cluster.
.. _golang-connect-to-your-cluster:

Connect to your Cluster
-----------------------
~~~~~~~~~~~~~~~~~~~~~~~

You can connect to your MongoDB deployment by providing a
**connection URI**, also called a *connection string*, which
Expand Down
41 changes: 22 additions & 19 deletions source/quick-start.txt
Original file line number Diff line number Diff line change
Expand Up @@ -25,44 +25,47 @@ Set Up Your Project
Use Go Mod to Initialize a Project
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Create a new directory and initialize your project using ``go mod``.
.. procedure::
:style: connected

.. code-block:: shell
.. step:: Create and initialize your project

mkdir go-quickstart
cd go-quickstart
go mod init go-quickstart
Create a new directory and initialize your project using ``go mod``.

.. code-block:: shell

mkdir go-quickstart
cd go-quickstart
go mod init go-quickstart

.. _golang-add-mongodb-dependency:

Add MongoDB as a Dependency
~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. step:: Add the Go driver as a dependency

Use ``go get`` to add the Go driver as a dependency.
Use ``go get`` to add the Go driver as a dependency.

.. code-block:: shell
.. code-block:: shell

go get go.mongodb.org/mongo-driver/v2/mongo
go get go.mongodb.org/mongo-driver/v2/mongo

Add Other Dependencies
~~~~~~~~~~~~~~~~~~~~~~
.. step:: Add other dependencies

Use ``go get`` to add any additional dependencies. This Quick Start
uses the ``godotenv`` package to read a MongoDB connection string
from an environment variable to avoid embedding credentials within
source code.
Use ``go get`` to add any additional dependencies. This Quick Start

Check failure on line 53 in source/quick-start.txt

View workflow job for this annotation

GitHub Actions / TDBX Vale rules

[vale] reported by reviewdog 🐶 [MongoDB.ConciseTerms] 'more' is preferred over 'additional'. Raw Output: {"message": "[MongoDB.ConciseTerms] 'more' is preferred over 'additional'.", "location": {"path": "source/quick-start.txt", "range": {"start": {"line": 53, "column": 30}}}, "severity": "ERROR"}
uses the ``godotenv`` package to read a MongoDB connection string
from an environment variable to avoid embedding credentials within
source code.

.. code-block:: shell
.. code-block:: shell

go get github.com/joho/godotenv
go get github.com/joho/godotenv

Create a MongoDB Cluster
------------------------

.. include:: /includes/quick-start/atlas-setup.rst

Query Your MongoDB Cluster from Your Application
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
------------------------------------------------

Next, create a file to contain your application called ``main.go``
in the base directory of your project. Use the following sample
Expand Down

0 comments on commit 740235a

Please sign in to comment.