Skip to content

Commit 2a55367

Browse files
authored
(DOCSP-19933) Improve and standardize intro text for drivers (#788)
1 parent 8b75dd0 commit 2a55367

File tree

12 files changed

+93
-62
lines changed

12 files changed

+93
-62
lines changed

source/c.txt

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,11 @@ MongoDB C Driver
1717
Introduction
1818
------------
1919

20-
The MongoDB C Driver, also known as “libmongoc”, is the official client library
21-
for C applications, and provides a base for MongoDB drivers in higher-level
22-
languages.
23-
24-
The library is compatible with all major platforms. It depends on libbson
25-
to create and parse BSON data.
20+
Welcome to the documentation site for the official MongoDB C driver.
21+
You can add the driver to your application to work with MongoDB in C.
22+
Download the required libraries, ``libmongoc`` and ``libbson``, from
23+
`mongoc.org <https://mongoc.org/libmongoc/current/installing.html>`__
24+
or set up a runnable project by following our tutorial.
2625

2726
- `Tutorial <http://mongoc.org/libmongoc/current/tutorial.html>`__
2827

source/csharp.txt

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,10 @@ MongoDB C#/.NET Driver
1717
Introduction
1818
------------
1919

20-
The official MongoDB C#/.NET Driver provides asynchronous interaction
21-
with MongoDB.
20+
Welcome to the documentation site for the official MongoDB C#/.NET
21+
driver. You can add the driver to your application to work with MongoDB
22+
in C#/.NET. Download it using `NuGet <https://www.nuget.org/>`__ or
23+
set up a runnable project by following our Getting Started guide.
2224

2325
- `Getting Started <{+csharp-docs-versioned+}/getting_started/>`__
2426

source/cxx.txt

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,11 @@ MongoDB C++ Driver
1717
Introduction
1818
------------
1919

20-
The MongoDB C++ Driver is the official client library for C++ applications
21-
using the C++11 (or later) standard.
20+
Welcome to the documentation site for the official MongoDB C++ driver.
21+
You can add the driver to your application to work with MongoDB using
22+
the C++11 or later standard. Download the library, ``mongocxx``,
23+
from `mongocxx.org <http://mongocxx.org/mongocxx-v3/installation/>`__
24+
or set up a runnable project by following our tutorial.
2225

2326
- `Tutorial <http://mongocxx.org/mongocxx-v3/tutorial/>`__
2427

source/java-drivers.txt

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,16 @@ Java MongoDB Drivers
2020
Introduction
2121
------------
2222

23-
`Java Driver <https://docs.mongodb.com/drivers/java/sync/current>`__ is the recommended MongoDB Java Driver.
24-
25-
For asynchronous stream processing and reactive streams interoperability,
26-
the :doc:`Reactive Streams Driver </reactive-streams>` is the
27-
recommended MongoDB Java Driver.
23+
Welcome to the documentation site for the official MongoDB Java
24+
drivers. You can add one of the following drivers to your application
25+
to work with MongoDB in Java:
26+
27+
- Use the
28+
`Java Driver <https://docs.mongodb.com/drivers/java/sync/current>`__
29+
for synchronous Java applications.
30+
31+
- Use the :doc:`Reactive Streams Driver </reactive-streams>` to use the
32+
Reactive Streams API for asynchronous stream processing.
2833

2934
Take the free online course taught by MongoDB
3035
---------------------------------------------

source/motor.txt

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,16 @@ Motor (Async Driver)
1717
Introduction
1818
------------
1919

20-
**Motor** is the recommended asynchronous Python driver for MongoDB.
21-
It is compatible with `Tornado <http://www.tornadoweb.org/>`__ and
22-
`asyncio <https://docs.python.org/3/library/asyncio.html>`__. We recommend
23-
that you use this driver if you need to run asynchronous operations. If
24-
you do not need to access MongoDB in a non-blocking manner or from
25-
co-routines, we recommend that you use the :doc:`PyMongo </pymongo>`
26-
driver instead.
27-
28-
Follow the links below to learn more about how to use the Motor driver:
20+
Welcome to the documentation site for Motor, the official MongoDB
21+
driver for asynchronous Python applications. Download it using
22+
`pip <https://pypi.python.org/pypi/pip>`__
23+
or set up a runnable project by following our tutorials.
24+
25+
.. tip::
26+
27+
If you do not need to access MongoDB in a non-blocking manner or from
28+
co-routines, we recommend that you use the :doc:`PyMongo </pymongo>`
29+
driver instead.
2930

3031
- `Tutorial on using Motor with Tornado <http://motor.readthedocs.org/en/stable/tutorial-tornado.html>`__
3132

source/php.txt

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,23 @@ MongoDB PHP Driver
2323
Introduction
2424
------------
2525

26-
The PHP driver consists of two components, the MongoDB `extension <https://github.com/mongodb/mongo-php-driver>`_
27-
and `library <https://docs.mongodb.com/php-library/current>`_.
28-
29-
The extension provides a low-level API and mainly serves to integrate
30-
`libmongoc and libbson <https://docs.mongodb.com/drivers/c/>`_ with PHP.
31-
32-
While it is possible to use the extension alone, users are strongly encouraged
33-
to use the extension and library together. The library provides a high-level API
34-
consistent with other MongoDB language drivers.
26+
Welcome to the documentation site for the official MongoDB PHP driver.
27+
You can add the driver to your application to work with MongoDB in PHP.
28+
The MongoDB PHP Driver consists of the two following components:
29+
30+
- The `extension <https://github.com/mongodb/mongo-php-driver>`_, which
31+
provides a low-level API and mainly serves to integrate
32+
`libmongoc and libbson <https://docs.mongodb.com/drivers/c/>`_ with
33+
PHP.
34+
35+
- The `library <https://docs.mongodb.com/php-library/current>`_, which
36+
provides a high-level API for working with MongoDB
37+
databases consistent with other MongoDB language drivers.
38+
39+
While it is possible to use the extension alone, MongoDB recommends
40+
using both the extension and the library together. Download the
41+
components you need or set up a runnable project by following our
42+
tutorials.
3543

3644
- `Tutorials <https://docs.mongodb.com/php-library/current/tutorial>`__
3745

source/pymongo.txt

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,19 @@ PyMongo
1515
Introduction
1616
------------
1717

18-
**PyMongo** is the official MongoDB Python driver for MongoDB. We
19-
recommend you use this driver to work with MongoDB from Python. If you
20-
need to access MongoDB in a non-blocking manner or from co-routines, we
21-
recommend that you use the :doc:`Motor </motor>` driver instead.
18+
Welcome to the documentation site for PyMongo, the official MongoDB
19+
driver for synchronous Python applications. Download it using
20+
`pip <https://pypi.python.org/pypi/pip>`__
21+
or set up a runnable project by following our tutorial.
2222

23-
Follow the links below to learn more about how to use the PyMongo driver:
23+
.. tip::
2424

25-
- `Tutorial <https://pymongo.readthedocs.io/en/stable/tutorial.html>`__ on
26-
how to connect to MongoDB and run common operations.
25+
If you need to access MongoDB in a non-blocking manner or from
26+
co-routines, we recommend that you use the :doc:`Motor </motor>`
27+
driver instead.
28+
29+
- `Tutorial <https://pymongo.readthedocs.io/en/stable/tutorial.html>`__
30+
on how to connect to MongoDB and run common operations.
2731

2832
- `API Reference <https://pymongo.readthedocs.io/en/stable/api/index.html>`__
2933

@@ -36,12 +40,12 @@ Follow the links below to learn more about how to use the PyMongo driver:
3640
Installation
3741
------------
3842

39-
You must install the PyMongo driver module to make it available to your Python
40-
application. We recommend using `pip <http://pypi.python.org/pypi/pip>`__
41-
to install PyMongo.
43+
You must install the PyMongo driver module to make it available to your
44+
Python application. We recommend using
45+
`pip <http://pypi.python.org/pypi/pip>`__ to install PyMongo.
4246

43-
The following command demonstrates how you can install the latest version of
44-
the module using the command line:
47+
The following command demonstrates how you can install the latest
48+
version of the module using the command line:
4549

4650
.. code-block:: sh
4751

source/python.txt

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,12 @@ MongoDB Python Drivers
2323
Introduction
2424
------------
2525

26-
You can access MongoDB from your Python application using one of our
27-
official MongoDB Python drivers. Follow the links below to get started
28-
with each driver:
26+
Welcome to the documentation site for the official MongoDB Python
27+
drivers. You can add one of the following drivers to your application
28+
to work with MongoDB in Python:
2929

30-
- :doc:`PyMongo </pymongo>` is the recommended driver to work with MongoDB
31-
using Python.
32-
- :doc:`Motor </motor>` is the recommended driver for when you need
33-
non-blocking access to MongoDB using Python.
30+
- Use :doc:`PyMongo </pymongo>` for synchronous Python applications.
3431

35-
.. include:: /includes/university-m220p.rst
32+
- Use :doc:`Motor </motor>` for asynchronous Python applications.
3633

34+
.. include:: /includes/university-m220p.rst

source/reactive-streams.txt

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,11 @@ MongoDB Java Reactive Streams
1515
Introduction
1616
------------
1717

18-
**Java Reactive Streams** is an official Java driver for MongoDB and is the
19-
recommended driver for working with reactive streams in the JVM ecosystem.
18+
Welcome to the documentation site for the Reactive Streams Driver, the
19+
official MongoDB driver for asynchronous Java applications. Download
20+
it by following the
21+
:java-docs:`Installation Guide <driver-reactive/getting-started/installation/>`
22+
or set up a runnable project by following our tutorials.
2023

2124
- :java-docs:`Reference Documentation <driver-reactive/>`
2225

source/rust.txt

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,10 @@ MongoDB Rust Driver
1717
Introduction
1818
------------
1919

20-
This is the official MongoDB Rust Driver.
20+
Welcome to the documentation site for the official MongoDB Rust driver.
21+
You can add the driver to your application to work with MongoDB in
22+
Rust. Download it from `crates.io <https://crates.io/crates/mongodb>`__
23+
or set up a runnable project with examples from our Usage Guide.
2124

2225
- `Usage Guide <https://github.com/mongodb/mongo-rust-driver#example-usage>`__
2326

0 commit comments

Comments
 (0)