Skip to content

Commit 03ce438

Browse files
DOCSP-19090 landing page update (#73)
* made landing page task oriented
1 parent 97bd1cc commit 03ce438

File tree

3 files changed

+41
-46
lines changed

3 files changed

+41
-46
lines changed

source/fundamentals.txt

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,4 @@ Fundamentals
2727
/fundamentals/logging
2828
/fundamentals/monitoring
2929

30-
The Fundamentals section explains how to perform the following tasks
31-
using the Go driver:
32-
33-
- :doc:`Connect to MongoDB </fundamentals/connection>`
34-
- :doc:`How the Driver Uses Context </fundamentals/context>`
35-
- :doc:`Authenticate with MongoDB </fundamentals/auth>`
36-
- :doc:`Read from and Write to MongoDB </fundamentals/crud>`
37-
- :doc:`Work with BSON </fundamentals/bson>`
30+
.. include:: /includes/fundamentals-sections.rst
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
Learn how to perform the following tasks using the Go driver in the
2+
Fundamentals section:
3+
4+
- :doc:`Connect to MongoDB </fundamentals/connection>`
5+
- :doc:`How the Driver Uses Context </fundamentals/context>`
6+
- :doc:`Authenticate with MongoDB </fundamentals/auth>`
7+
- :doc:`Read from and Write to MongoDB </fundamentals/crud>`
8+
- :doc:`Work with BSON </fundamentals/bson>`
9+
10+
.. - :doc:`Specify an API Version </fundamentals/versioned-api>`
11+
.. - :doc:`Use the Driver's Data Formats </fundamentals/data-formats>`
12+
.. - :doc:`Perform Aggregations </fundamentals/aggregation>`
13+
.. - :doc:`Construct Indexes </fundamentals/indexes>`
14+
.. - :doc:`Specify Collations </fundamentals/collations>`
15+
.. - :doc:`Record Events in the Driver </fundamentals/logging>`
16+
.. - :doc:`Use Driver Events in your Code </fundamentals/monitoring>`
17+
.. - :doc:`Store and Retrieve Files in MongoDB </fundamentals/gridfs>`

source/index.txt

Lines changed: 23 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -22,76 +22,61 @@ Introduction
2222

2323
Welcome to the MongoDB Go driver documentation.
2424

25-
The official MongoDB Go driver lets you connect your Go applications
26-
to MongoDB and work with your data. On this page, you can find descriptions of
27-
each section of the driver documentation and where to go to learn more
28-
about the Go driver.
25+
Connect your Go applications to MongoDB and work with your data using
26+
the official Go driver. On this page, you can find descriptions of each
27+
section of the driver documentation and how to learn more about the Go
28+
driver.
2929

3030
Quick Start
3131
-----------
3232

33-
The :doc:`Quick Start </quick-start>` section is where you can
34-
establish a connection to MongoDB Atlas and begin working with data.
33+
Learn how to establish a connection to MongoDB Atlas and begin
34+
working with data in the :doc:`Quick Start </quick-start>` section.
3535

3636
Usage Examples
3737
--------------
3838

39-
The :doc:`Usage Examples </usage-examples>` section is where you can
40-
find runnable code snippets and high-level explanations for common
41-
methods.
39+
For fully runnable code snippets and explanations for common
40+
methods, see the :doc:`Usage Examples </usage-examples>` section.
4241

4342
Fundamentals
4443
------------
4544

46-
The Fundamentals section explains how to perform the following tasks
47-
using the Go driver:
48-
49-
- :doc:`Connect to MongoDB </fundamentals/connection>`
50-
- :doc:`How the Driver Uses Context </fundamentals/context>`
51-
- :doc:`Authenticate with MongoDB </fundamentals/auth>`
52-
- :doc:`Read from and Write to MongoDB </fundamentals/crud>`
53-
- :doc:`Work with BSON </fundamentals/bson>`
54-
55-
.. - :doc:`Specify an API Version </fundamentals/versioned-api>`
56-
.. - :doc:`Use the Driver's Data Formats </fundamentals/data-formats>`
57-
.. - :doc:`Perform Aggregations </fundamentals/aggregation>`
58-
.. - :doc:`Construct Indexes </fundamentals/indexes>`
59-
.. - :doc:`Specify Collations </fundamentals/collations>`
60-
.. - :doc:`Record Events in the Driver </fundamentals/logging>`
61-
.. - :doc:`Use Driver Events in your Code </fundamentals/monitoring>`
62-
.. - :doc:`Store and Retrieve Files in MongoDB </fundamentals/gridfs>`
45+
.. include:: /includes/fundamentals-sections.rst
6346

6447
API
6548
---
6649

67-
The `MongoDB Go driver API documentation <{+api+}/mongo>`__ contains
68-
detailed information about types and functions in the MongoDB Go driver.
50+
For detailed information about types and functions in the MongoDB
51+
Go driver, see the `MongoDB Go driver API documentation
52+
<{+api+}/mongo>`__.
6953

7054
.. FAQ
7155
.. ---
7256

73-
.. The :doc:`Frequently Asked Questions (FAQ) </faq>` section provides answers
74-
.. to commonly asked questions about the MongoDB Go Driver.
57+
.. For answers to commonly asked questions about the MongoDB
58+
.. Go Driver, see the :doc:`Frequently Asked Questions (FAQ) </faq>`
59+
.. section.
7560

7661
Issues & Help
7762
-------------
7863

79-
The :doc:`Issues & Help </issues-and-help>` section explains how to report
80-
bugs, contribute to the driver, and find additional resources for asking
81-
questions and receiving help.
64+
Learn how to report bugs, contribute to the driver, and find
65+
additional resources for asking questions in the :doc:`Issues & Help
66+
</issues-and-help>` section.
8267

8368
Compatibility
8469
-------------
8570

86-
The :doc:`Compatibility </compatibility>` section contains compatibility
87-
charts that show the recommended Go Driver version for each MongoDB
88-
Server version.
71+
For the compatibility charts that show the recommended Go Driver version
72+
for each MongoDB Server version, see the :doc:`Compatibility
73+
</compatibility>` section.
8974

9075
.. What's New
9176
.. ----------
9277

93-
.. The :doc:`What's New </whats-new>` section lists new features and
94-
.. changes in each version.
78+
.. For a list of new features and changes in each version, see the
79+
.. :doc:`What's New </whats-new>` section.
9580

9681
Learn
9782
------

0 commit comments

Comments
 (0)