getting started: tweak examples and links

Author: kay-kim

primer/source/aggregation.txt

@@ -21,20 +21,4 @@ Prerequisites
 Additional Information
 ----------------------
 
-For more information on the aggregation method, see the following
-documentation in the MongoDB Manual:
-
-- :manual:`Aggregation Quick Reference
-  </meta/aggregation-quick-reference>`.
-
-- :manual:`SQL to Aggregation Mapping Chart
-  </reference/sql-aggregation-comparison>`.
-
-- :manual:`Aggregation documentation </core/aggregation-introduction>` for more
-  information on aggregation in MongoDB, including other aggregation
-  methods.
-
-- :manual:`Zip Code Aggregation Tutorial
-  </tutorial/aggregation-zip-code-data-set>` and the :manual:`User
-  Preference Aggregation Tutorial
-  </tutorial/aggregation-with-user-preference-data>`.
+.. include:: /includes/extracts/aggregation-additional-info.rst

primer/source/includes/client-shell.rst

@@ -14,7 +14,7 @@ Start ``mongo``
 
 Once you have :doc:`installed and have started </installation>`
 MongoDB, connect the :program:`mongo` shell to your running MongoDB
-instance. Ensure MongoDB is running before attempting to launch the
+instance. Ensure that MongoDB is running before attempting to launch the
 :program:`mongo` shell.
 
 On the same system where the MongoDB is running, open a terminal window

primer/source/includes/examples-insert.yaml

@@ -184,8 +184,7 @@ ref: java-insert-a-document
 edition: java
 operation:
   - pre: |
-       To specify a document, use the `org.bson.Document
-       <http://api.mongodb.org/java/3.0/org/bson/Document.html>`_ class.
+       To specify a document, use the org.bson.Document_ class.
   - literalinclude: includes/example-java-insert-a-document.java
     language: java
   - post: |

primer/source/includes/examples-query-sort.yaml

@@ -144,7 +144,7 @@ operation:
   - literalinclude: includes/example-java-sort-pre2.java
     language: java
 replacement:
-  sortMethod: "`sort() <http://api.mongodb.org/java/3.0/com/mongodb/async/client/FindIterable.html#sort(org.bson.conversions.Bson)>`_"
+  sortMethod: "`sort() <http://api.mongodb.org/java/3.0/com/mongodb/async/client/FindIterable.html#sort-org.bson.conversions.Bson->`_"
   ascKey: "``1``"
   descKey: "``-1``"
 ...

primer/source/includes/examples-remove.yaml

@@ -10,11 +10,11 @@ edition:
   - java
 ref: example-collection
 ---
+edition: shell
 source:
   file: examples-remove-base.yaml
   ref: _remove-matching-documents
 ref: remove-matching-documents
-edition: shell
 operation:
   language: javascript
   code: |
@@ -24,11 +24,11 @@ post: |
   contains the status of the operation. :data:`~WriteResult.nRemoved`
   field specifies the number of documents removed.
 ---
+edition: shell
 source:
   file: examples-remove-base.yaml
   ref: _remove-justOne
 ref: remove-justOne
-edition: shell
 operation:
   - language: javascript
     code: |
@@ -44,11 +44,11 @@ final: |
 replacement:
   removeMethod: :method:`~db.collection.remove()`
 ---
+edition: shell
 source:
   file: examples-remove-base.yaml
   ref: _remove-all-documents
 ref: remove-all-documents
-edition: shell
 operation:
   language: javascript
   code: |
@@ -60,11 +60,11 @@ post: |
 replacement:
   removeMethod: :method:`~db.collection.remove()`
 ---
+edition: shell
 source:
   file: examples-remove-base.yaml
   ref: _drop-collection
 ref: drop-collection
-edition: shell
 operation:
   language: javascript
   code: |
@@ -80,11 +80,11 @@ final: |
 replacement:
   dropMethod: :method:`~db.collection.drop()`
 ---
+edition: python
 source:
   file: examples-remove-base.yaml
   ref: _remove-matching-documents
 ref: remove-matching-documents
-edition: python
 operation:
   - language: python
     code: |
@@ -111,11 +111,11 @@ operation:
 replacement:
   removeMethod: :py:meth:`~pymongo.collection.Collection.delete_many`
 ---
+edition: python
 source:
   file: examples-remove-base.yaml
   ref: _remove-all-documents
 ref: remove-all-documents
-edition: python
 operation:
   - language: python
     code: |
@@ -142,23 +142,23 @@ operation:
 replacement:
   removeMethod: :py:meth:`~pymongo.collection.Collection.delete_many`
 ---
+edition: python
 source:
   file: examples-remove-base.yaml
   ref: _drop-collection
 ref: drop-collection
-edition: python
 operation:
   language: python
   code: |
      db.restaurants.drop()
 replacement:
   dropMethod: :py:meth:`~pymongo.collection.Collection.drop`
 ---
+edition: node
 source:
   file: examples-remove-base.yaml
   ref: _remove-matching-documents
 ref: remove-matching-documents
-edition: node
 operation:
   - pre: |
       Define a ``removeRestaurants`` function as follows:
@@ -189,12 +189,12 @@ post: |
 replacement:
   removeMethod: "deleteMany_"
 ---
+edition: node
 source:
   file: examples-remove-base.yaml
   ref: _remove-justOne
 ref: remove-justOne
 title: "Remove just one document."
-edition: node
 operation:
   - pre: |
       Define a ``removeRestaurants`` function as follows:
@@ -225,11 +225,11 @@ post: |
 replacement:
   removeMethod: "deleteOne_"
 ---
+edition: node
 source:
   file: examples-remove-base.yaml
   ref: _remove-all-documents
 ref: remove-all-documents
-edition: node
 operation:
   - pre: |
       Define a ``removeRestaurants`` function as follows:
@@ -257,11 +257,11 @@ post: |
 replacement:
   removeMethod: "deleteMany_"
 ---
+edition: node
 source:
   file: examples-remove-base.yaml
   ref: _drop-collection
 ref: drop-collection
-edition: node
 operation:
   - pre: |
       Define a ``dropRestaurants`` function as follows:
@@ -334,6 +334,7 @@ operation:
   language: cpp
 replacement:
   dropMethod: "drop_"
+---
 source:
   file: examples-remove-base.yaml
   ref: _remove-matching-documents
@@ -353,10 +354,10 @@ source:
 ref: remove-all-documents
 edition: java
 operation:
-  - literalinclude: includes/example-java-remove-matching-documents.java
+  - literalinclude: includes/example-java-remove-all-documents.java
     language: java
   - post: |
-      .. include:: includes/example-java-remove-matching-documents-post.rst
+      .. include:: includes/example-java-remove-all-documents-post.rst
 replacement:
   removeMethod: "deleteMany_"
 ---

primer/source/includes/extracts-aggregation-additional-info-base.yaml

@@ -0,0 +1,9 @@
+ref: _aggregation-additional-info
+content: |
+  In the {{driver}}, see {{aggregate}}.
+
+  In the MongoDB Manual, see also :manual:`Aggregation Quick Reference
+  </meta/aggregation-quick-reference>`, the :manual:`SQL to Aggregation
+  Mapping Chart </reference/sql-aggregation-comparison>`, and
+  :manual:`Aggregation Introduction </core/aggregation-introduction>`.
+...

primer/source/includes/extracts-aggregation-additional-info.yaml

@@ -0,0 +1,50 @@
+edition: shell
+ref: aggregation-additional-info
+inherit:
+  ref: _aggregation-additional-info
+  file: extracts-aggregation-additional-info-base.yaml
+replacement:
+  driver: MongoDB Manual
+  aggregate: :method:`~db.collection.aggregate()`
+---
+edition: python
+ref: aggregation-additional-info
+inherit:
+  ref: _aggregation-additional-info
+  file: extracts-aggregation-additional-info-base.yaml
+replacement:
+  driver: PyMongo documentation
+  aggregate: :py:meth:`~pymongo.collection.Collection.aggregate()`
+---
+edition: node
+ref: aggregation-additional-info
+inherit:
+  ref: _aggregation-additional-info
+  file: extracts-aggregation-additional-info-base.yaml
+replacement:
+  driver: Node.js documentation
+  aggregate: "aggregate_"
+post: |
+  .. _aggregate: http://mongodb.github.io/node-mongodb-native/2.0/api/Collection.html#aggregate
+---
+edition: cpp
+ref: aggregation-additional-info
+inherit:
+  ref: _aggregation-additional-info
+  file: extracts-aggregation-additional-info-base.yaml
+replacement:
+  driver: C++ Driver documentation
+  aggregate: "aggregate_ and pipeline_"
+---
+edition: java
+ref: aggregation-additional-info
+inherit:
+  ref: _aggregation-additional-info
+  file: extracts-aggregation-additional-info-base.yaml
+replacement:
+  driver: Java Driver documentation
+  aggregate: "aggregate_, AggregateIterable_, Block_"
+post: |
+  .. _Block: http://api.mongodb.org/java/3.0/com/mongodb/Block.html
+  .. _AggregateIterable: http://api.mongodb.org/java/3.0/com/mongodb/client/AggregateIterable.html
+...

primer/source/includes/extracts-aggregation-overview.yaml

@@ -1,50 +1,49 @@
+edition: shell
 ref: aggregation-overview
 replacement:
   aggregate: :method:`~db.collection.aggregate()`
 inherit:
   ref: _aggregation-overview
   file: extracts-aggregation-overview-base.yaml
-edition: shell
 post: |
 
   .. code-block:: javascript
 
      db.collection.aggregate( [ <stage1>, <stage2>, ... ] )
 ---
+edition: python
 ref: aggregation-overview
 replacement:
   aggregate: :py:meth:`~pymongo.collection.Collection.aggregate()`
 inherit:
   ref: _aggregation-overview
   file: extracts-aggregation-overview-base.yaml
-edition: python
-
 post: |
 
   .. code-block:: python
 
      db.collection.aggregate([<stage1>, <stage2>, ...])
 
 ---
+edition: node
 ref: aggregation-overview
 replacement:
   aggregate: "`aggregate <http://mongodb.github.io/node-mongodb-native/2.0/api/Collection.html#aggregate>`_"
 inherit:
   ref: _aggregation-overview
   file: extracts-aggregation-overview-base.yaml
-edition: node
 post: |
 
   .. code-block:: javascript
 
      db.collection.aggregate( [ <stage1>, <stage2>, ... ] )
 
 ---
+edition: cpp
 ref: aggregation-overview
 inherit:
   ref: _aggregation-overview
   file: extracts-aggregation-overview-base.yaml
-edition: cpp
 content: |
   MongoDB can perform aggregation operations, such as grouping by a
   specified key and evaluating a total or a count for each distinct group.
@@ -61,13 +60,13 @@ content: |
 replacement:
   aggregate: "aggregate_"
 ---
+edition: java
 ref: aggregation-overview
 inherit:
   ref: _aggregation-overview
   file: extracts-aggregation-overview-base.yaml
-edition: java
 post: |
-  .. _aggregate: http://api.mongodb.org/java/3.0/com/mongodb/client/MongoCollection.html#aggregate(java.util.List,%20java.lang.Class)
+  .. _aggregate: http://api.mongodb.org/java/3.0/com/mongodb/client/MongoCollection.html#aggregate-java.util.List-
 replacement:
   aggregate: "aggregate_"
 ...

primer/source/includes/extracts-connect.yaml

@@ -16,8 +16,7 @@ content: |
 ref: java-connect
 edition: java
 content: |
-  The variable ``db`` in the example(s) below refers to the ``test``
-  database of the connected MongoDB. See :ref:`Connect to MongoDB
-  <java-download-connect>` to connect to a running MongoDB instance and
-  access the ``test`` database.
+  Follow the :ref:`Connect to MongoDB <java-download-connect>` step to
+  connect to a running MongoDB instance and declare and define the
+  variable ``db`` as to access the ``test`` database.
 ...

primer/source/includes/extracts-indexes-additional-info-base.yaml

@@ -1,11 +1,11 @@
 ref: _indexes-additional-info
 content: |
-  MongoDB provides several different index types to support different
-  kinds of queries and data sets. See the :manual:`Index Introduction
-  </core/indexes-introduction>` in the Mongodb Manual for the different
-  index types supported in MongoDB.
+  You can specify various properties for indexes, such as a
+  :manual:`unique constraint </core/index-unique>`. In the {{driver}},
+  see {{index}} for the available options.
 
-  You can also specify various properties for indexes, such as a
-  :manual:`unique constraint </core/index-unique>`. For the options
-  available, refer to {{index}} API.
+  MongoDB provides different index types to support different
+  kinds of queries and datasets. In the MongoDB Manual, see the
+  :manual:`Index Introduction </core/indexes-introduction>` for the
+  different index types supported in MongoDB.
 ...