Skip to content

Commit a1e22d6

Browse files
author
Mohammad Hunan Chughtai
authored
(DOCPS-8441): node index page (#45)
* (DOCSP-8441): initial push * Removed placeholder txt * added rough draft verbiage * updated verbiage * added contents dire * (DOCPS-8441): added note for the old v of node docs * updated link to the manual * update verbiage for link * Removed compatability from index and added it to the root * readded toc tree * added compatability to toc * update links * updated links * update wording * fixed typos in Compatibility and fixed grammar * fixed typo * update header names * update grammar * fixed verbiage * updated verbiage * updated verbiage * fixed the verbiage to address PR comments * update verbiage
1 parent 26fdc89 commit a1e22d6

File tree

2 files changed

+69
-14
lines changed

2 files changed

+69
-14
lines changed

source/compatibility.txt

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Compatibility
2+
-------------
3+
4+
MongoDB Compatibility
5+
~~~~~~~~~~~~~~~~~~~~~
6+
7+
.. include:: /includes/mongodb-compatibility-table-node.rst
8+
9+
Language Compatibility
10+
~~~~~~~~~~~~~~~~~~~~~~
11+
12+
.. include:: /includes/language-compatibility-table-node.rst

source/index.txt

Lines changed: 57 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,6 @@ MongoDB Node Driver
66

77
.. include:: /includes/unicode-checkmark.rst
88

9-
The MongoDB Node driver documentation contains documentation specific to
10-
the Node driver. For the main MongoDB documentation, see the
11-
:manual:`MongoDB Manual </>`.
12-
13-
The Node driver documentation is organized as follows:
14-
159
.. toctree::
1610
:titlesonly:
1711
:maxdepth: 1
@@ -22,16 +16,65 @@ The Node driver documentation is organized as follows:
2216
/api-documentation
2317
/faq
2418
/issues-and-help
19+
/compatibility
2520

26-
Compatibility
27-
-------------
2821

29-
MongoDB Compatibility
30-
~~~~~~~~~~~~~~~~~~~~~
22+
Introduction
23+
------------
24+
The official MongoDB Node.js driver allows Node.js applications to
25+
connect to MongoDB and work with data.
26+
27+
.. note::
28+
29+
These docs are for version 3.5 of the MongoDB Node.js driver. If
30+
you're looking for an older version of the MongoDB Node.js driver
31+
docs, `see the Legacy Node.js driver documentation
32+
<https://mongodb.github.io/node-mongodb-native/>`_. For the main
33+
MongoDB documentation, see the :manual:`MongoDB Manual </>`.
34+
35+
Quick Start
36+
-----------
37+
Jump right in with the `Quick Start </quick-start/>`_ to learn how to
38+
establish a connection to MongoDB Atlas and begin to work with data
39+
40+
Fundamentals
41+
------------
42+
Whether you're a brand new MongoDB developer, or just want to brush up
43+
on the core concepts then check out the `Fundamentals </fundamentals>`_
44+
section that defines the following core concepts:
3145

32-
.. include:: /includes/mongodb-compatibility-table-node.rst
46+
* CRUD: Learn how to read and write data to MongoDB using Node.js
47+
* Authentication: Learn how to configure authentication and log a user
48+
in using the MongoDB Node.js driver
49+
* Logs: Learn how MongoDB logs operations and how to work with them
50+
* Monitoring: Learn how to monitor MongoDB server events
3351

34-
Language Compatibility
35-
~~~~~~~~~~~~~~~~~~~~~~
52+
Usage Examples
53+
--------------
54+
The `Usage Examples </usage-examples/overview>`_ section provides
55+
runnable code snippets and explanation for the common methods, best
56+
suited for new users to the MongoDB Node.js driver who want to implement
57+
common driver methods
3658

37-
.. include:: /includes/language-compatibility-table-node.rst
59+
API
60+
---
61+
See the `API </api-documentation/>`_ section if you are looking for
62+
technical information about classes, methods, and configuration objects
63+
within the MongoDB Node.js driver.
64+
65+
66+
FAQ
67+
---
68+
The `Frequently Asked Questions (FAQ) </faq>`_ section provides answers
69+
to the most commonly asked questions about the MongoDB Node.js Driver.
70+
71+
Issues & Help
72+
-------------
73+
The `Issues & Help </issues-and-help>`_ Section explains how to report
74+
bugs, contribute to the driver, and find additional resources for asking
75+
questions and receiving help.
76+
77+
Compatibility
78+
-------------
79+
The `Compatibility </compatibility>`_ section shows compatibility charts
80+
with the Node.js language and the MongoDB server versions.

0 commit comments

Comments
 (0)