Skip to content

Commit 133dd62

Browse files
DOCSP-13826 landing page (#17)
* added index landing page
1 parent ff591c5 commit 133dd62

File tree

1 file changed

+57
-19
lines changed

1 file changed

+57
-19
lines changed

source/index.txt

Lines changed: 57 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -19,46 +19,84 @@ MongoDB Go Driver
1919
Introduction
2020
------------
2121

22-
The official MongoDB Go Driver enables Go applications to connect to
23-
MongoDB and work with data.
22+
The official MongoDB Go Driver enables Go applications to connect to and
23+
work with data in MongoDB. This page describes each section of the
24+
driver documentation.
25+
26+
Developer Hub
27+
~~~~~~~~~~~~~
28+
29+
Visit the Developer Hub for content, resources, community, and social
30+
engagement for developers related to the Go driver:
31+
32+
- To view articles on Go, see the `How To's and Articles page <https://www.mongodb.com/developer/learn/?content=Articles&text=Go>`__.
33+
- To view the Go forum, see the `forums page <https://www.mongodb.com/community/forums/tag/golang>`__.
34+
35+
Quick Start
36+
-----------
37+
38+
To get up and running quickly, take a look at the :doc:`Quick Start
39+
</quick-start>` to learn how to establish a connection to MongoDB Atlas
40+
and begin to work with data.
2441

2542
Usage Examples
2643
--------------
44+
2745
The :doc:`Usage Examples </usage-examples>` section provides
2846
runnable code snippets and explanations for common methods. We recommend
2947
this section for users that are new to the MongoDB Go Driver.
3048

3149
Fundamentals
3250
------------
33-
Whether you are new to MongoDB or you just want to brush up on the core
34-
concepts, you can check out the **Fundamentals** section which contains
35-
learning material on using the Go driver for the following:
3651

37-
* TODO
52+
Whether you are new to MongoDB or want to brush up on core concepts, you
53+
can check out the **Fundamentals** section which covers the following
54+
material in the Go driver:
55+
56+
- :doc:`Connect to MongoDB </fundamentals/connection>`
57+
- :doc:`Context Usage in MongoDB </fundamentals/context>`
58+
- :doc:`Authenticate with MongoDB </fundamentals/auth>`
59+
60+
.. - :doc:`Specify an API Version </fundamentals/versioned-api>`
61+
.. - :doc:`Use the Driver's Data Formats </fundamentals/data-formats>`
62+
.. - :doc:`Perform CRUD Operations </fundamentals/crud>`
63+
.. - :doc:`Perform Aggregations </fundamentals/aggregation>`
64+
.. - :doc:`Construct Indexes </fundamentals/indexes>`
65+
.. - :doc:`Specify Collations </fundamentals/collations>`
66+
.. - :doc:`Record Events in the Driver </fundamentals/logging>`
67+
.. - :doc:`Use Driver Events in your Code </fundamentals/monitoring>`
68+
.. - :doc:`Store and Retrieve Files in MongoDB </fundamentals/gridfs>`
3869

3970
API
4071
---
41-
See the `API Documentation <https://pkg.go.dev/go.mongodb.org/mongo-driver/mongo>`_ link to api docs if you are looking
42-
for technical information about classes, methods, and configuration objects
43-
within the MongoDB Go Driver.
4472

45-
FAQ
46-
---
47-
The :doc:`Frequently Asked Questions (FAQ) </faq>` section provides answers
48-
to commonly asked questions about the MongoDB Go Driver.
73+
See the `API Documentation
74+
<https://pkg.go.dev/go.mongodb.org/mongo-driver/mongo>`__ if you are
75+
looking for technical information about types, functions, and
76+
configuration objects within the MongoDB Go Driver.
77+
78+
.. FAQ
79+
.. ---
80+
81+
.. The :doc:`Frequently Asked Questions (FAQ) </faq>` section provides answers
82+
.. to commonly asked questions about the MongoDB Go Driver.
4983

5084
Issues & Help
5185
-------------
86+
5287
The :doc:`Issues & Help </issues-and-help>` section explains how to report
5388
bugs, contribute to the driver, and find additional resources for asking
5489
questions and receiving help.
5590

5691
Compatibility
5792
-------------
58-
The :doc:`Compatibility </compatibility>` section shows compatibility charts
59-
with Golang and MongoDB server versions.
6093

61-
What's New
62-
----------
63-
The :doc:`What's New </whats-new>` section shows new features and
64-
changes in each version.
94+
The :doc:`Compatibility </compatibility>` section contains compatibility
95+
charts that show the recommended Go Driver version for each MongoDB
96+
Server version.
97+
98+
.. What's New
99+
.. ----------
100+
101+
.. The :doc:`What's New </whats-new>` section shows new features and
102+
.. changes in each version.

0 commit comments

Comments
 (0)