Skip to content

Commit a35b140

Browse files
schmallisokay-kim
authored andcommitted
DOCSP-2355: Copy reviews and wordsmithing and single-sourcing (oh my) (#65)
* DOCSP-2355: wordsmithing and tidying up * DOCSP-2355: clarify embedded docs language, cleanup
1 parent bf8e4f9 commit a35b140

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+591
-373
lines changed

conf.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,8 @@
7070
'csharp-api': ('https://mongodb.github.io/mongo-csharp-driver/2.5/apidocs/html/%s.htm', ''),
7171
'csharp-docs': ('https://mongodb.github.io/mongo-csharp-driver/2.5/reference/%s', ''),
7272
'java-async-docs': ('http://mongodb.github.io/mongo-java-driver/3.7/%s', ''),
73-
'java-async-api': ('http://mongodb.github.io/mongo-java-driver/3.7/javadoc/%s', '')
73+
'java-async-api': ('http://mongodb.github.io/mongo-java-driver/3.7/javadoc/%s', ''),
74+
'java-sync-api': ('http://mongodb.github.io/mongo-java-driver/3.7/javadoc/%s', ''),
7475
}
7576

7677
intersphinx_mapping = {}

config/build_conf.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ system:
2727
- 'integration.yaml'
2828
- 'sphinx_local.yaml'
2929

30-
3130
assets:
3231
- branch: master
3332
path: build/docs-tools

config/intersphinx.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,6 @@ name: mongodb
22
url: https://docs.mongodb.com/manual/
33
path: mongodb.inv
44
---
5-
name: python
6-
url: https://docs.python.org/2/
7-
path: python2.inv
8-
---
95
name: pymongo
106
url: https://api.mongodb.com/python/current/
117
path: pymongo.inv
@@ -17,4 +13,8 @@ path: motor.inv
1713
name: phplib
1814
url: https://docs.mongodb.com/php-library/master/
1915
path: phplib.inv
16+
---
17+
name: compass
18+
url: https://docs.mongodb.com/compass/current/
19+
path: objects.inv
2020
...

source/guides/server/delete.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,12 @@
1818
In this guide, you will delete documents from a MongoDB database.
1919
time: 10
2020
prerequisites:
21-
.. include:: /includes/prereqs_read_CRUD.rst
21+
- .. include:: /includes/prereqs_read_CRUD.rst
2222

2323
- Complete the :doc:`/guides/server/import` guide so that there
2424
is data in your database to delete.
2525
check_your_environment:
26-
NA.
26+
.. include:: /includes/check_for_drivers_install.rst
2727
procedure:
2828
.. include:: /includes/steps/delete_server.rst
2929
summary:

source/guides/server/drivers.txt

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -14,21 +14,18 @@
1414

1515
product_version: 3.6
1616
result_description:
17-
18-
There are several ways to connect to your MongoDB instances. This
19-
guide steps you through the installation of the MongoDB shell, compass, and
20-
various MongoDB drivers.
21-
17+
There are several ways to connect to your MongoDB instances. The
18+
following guide steps you through installing the
19+
:binary:`~bin.mongo` shell, MongoDB Compass, and the MongoDB
20+
drivers, and shows you how to connect your client to a MongoDB
21+
deployment.
2222
time: 15
2323
prerequisites:
24-
25-
.. include:: /includes/prereqs_drivers_install.rst
26-
24+
.. include:: /includes/steps/prereqs_mtools.rst
2725
check_your_environment:
28-
29-
- Ensure that your client platform is compatible with MongoDB. See MongoDB
30-
:ref:`Supported Platforms <mongodb-supported-platforms>`.
31-
26+
- Ensure that your client platform is compatible with MongoDB.
27+
Refer to the :ref:`Supported Platforms <mongodb-supported-platforms>`
28+
table for more information.
3229
procedure:
3330

3431
.. include:: /includes/steps/drivers_install_gs.rst

source/guides/server/import.txt

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,27 @@
11
.. guide::
2-
title: Importing Data Into MongoDB
2+
title: Import Data into MongoDB
33
author: assorted
44
type: Getting Started
55
level: beginner
66
product_version: 3.6
77
result_description:
8-
You can bulk import data into MongoDB using the :binary:`~bin.mongoimport` binary distributed with the server.
8+
In this guide, you will use the
9+
:binary:`~bin.mongoimport` tool distributed with MongoDB
10+
to bulk import data into your MongoDB instance.
911
time: 15
1012
prerequisites:
1113
.. include:: /includes/steps/prereqs_mtools.rst
1214
check_your_environment:
15+
.. include:: /includes/check_for_drivers_install.rst
1316
procedure:
1417
.. include:: /includes/steps/import.rst
1518
summary:
16-
If you have successfully completed this guide, you have imported your first MongoDB data.
17-
Now in the next guide, you will retrieve the information you just imported.
19+
If you have successfully completed this guide, you have imported
20+
your first MongoDB data. In the next guide, you will retrieve
21+
the documents that you just imported.
1822
whats_next:
19-
In this guide, you will read all documents from a collection in the MongoDB database.
20-
23+
In this guide, you will retrieve all of the documents in a
24+
collection in your MongoDB database.
2125
* :doc:`Read Data From MongoDB </guides/server/read_queries>`
2226
seealso:
2327
For CRUD guides:

source/guides/server/insert.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
.. guide::
2-
title: Insert Data Into MongoDB
2+
title: Insert Data into MongoDB
33
author: MongoDB
44
type: Getting Started
55
level: beginner

source/guides/server/install.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@
99
This guide describes how to install MongoDB.
1010
time: 10
1111
prerequisites:
12-
- MongoDB supports a variety of 64-bit platforms. Refer to the
13-
:ref:`Supported Platforms <mongodb-supported-platforms>` table to
14-
verify that MongoDB is supported on the platform to which you
15-
wish to install it.
12+
MongoDB supports a variety of 64-bit platforms. Refer to the
13+
:ref:`Supported Platforms <mongodb-supported-platforms>` table to
14+
verify that MongoDB is supported on the platform to which you wish
15+
to install it.
1616
procedure:
1717
Install MongoDB
1818
~~~~~~~~~~~~~~~

source/guides/server/read.txt

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,10 @@
2222
procedure:
2323
.. include:: /includes/steps/read_server.rst
2424
summary:
25-
If you have successfully completed this guide, you have retrieved data from MongoDB.
26-
Now in the next guide, you will find data in your database table that matches certain
27-
criteria using queries.
25+
If you have successfully completed this guide, you have retrieved
26+
data from MongoDB. Now in the next guide, you will use queries to
27+
find data in your :term:`collection` that matches specified
28+
criteria.
2829
whats_next:
2930
In the next guide, you'll learn how to retrieve data from MongoDB using criteria.
3031

source/guides/server/update.txt

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,17 @@
1212
motor
1313
nodejs
1414
java-sync
15-
java-async
1615
csharp
1716
result_description:
1817
In this guide, you will update documents in a MongoDB database.
1918
time: 10
2019
prerequisites:
21-
.. include:: /includes/prereqs_read_CRUD.rst
22-
20+
- .. include:: /includes/prereqs_read_CRUD.rst
21+
2322
- Complete the :doc:`/guides/server/import` guide so that there
2423
is data in your database to update.
25-
check_your_environment:
26-
NA.
24+
check_you_environment:
25+
.. include:: /includes/check_for_drivers_install.rst
2726
procedure:
2827
.. include:: /includes/steps/update_server.rst
2928
summary:

0 commit comments

Comments
 (0)