Skip to content

Commit f9c08e5

Browse files
author
Sam Kleinman
committed
DOCS-144: glossary changes editing and refactoring
1 parent b52fdaf commit f9c08e5

File tree

10 files changed

+47
-43
lines changed

10 files changed

+47
-43
lines changed

source/administration/configuration.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ following explanation:
9999
- :setting:`journal` is ``true``, which enables
100100
:doc:`journaling </core/journaling>` which ensures single instance
101101
write-durability. 64-bit builds of :program:`mongod` enable
102-
:term:`journaling` by default. Thus, this setting may be redundant.
102+
:term:`journaling <journal>` by default. Thus, this setting may be redundant.
103103

104104
Given the default configuration, some of these values may be
105105
redundant. However, in many situations explicitly stating the

source/core/replication.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -435,7 +435,7 @@ the existing members.
435435

436436
.. note::
437437

438-
:term:`Journaling`, provides single-instance
438+
:term:`Journaling <journal>`, provides single-instance
439439
write durability. The journaling greatly improves the reliability
440440
and durability of a database. Unless MongoDB runs with journaling, when a
441441
MongoDB instance terminates ungracefully, the database can loose up to 60 seconds of data,

source/reference/commands.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -328,8 +328,8 @@ Aggregation
328328
329329
:func:`group()` does not work in :term:`shard environments
330330
<shard cluster>`. Use the :term:`aggregation framework` or
331-
:term:`map/reduce` (i.e. :db;command:`mapReduce` in
332-
:term:`sharded environments <sharding>`.
331+
:term:`map-reduce` (i.e. :command:`mapReduce` in :term:`sharded
332+
environments <sharding>`.
333333
334334
.. read-lock
335335
@@ -1331,7 +1331,7 @@ Administration
13311331
13321332
.. note::
13331333
1334-
When using :term:`journaling`, there is almost never any need to
1334+
When using :term:`journaling <journal>`, there is almost never any need to
13351335
run :dbcommand:`repairDatabase`. In the event of an unclean
13361336
shutdown, the server will be able restore the data files to a
13371337
pristine state automatically.
@@ -1837,7 +1837,6 @@ Diagnostics
18371837
.. versionadded:: 2.1.1
18381838
18391839
Returns the local server time for the current system.
1840-
18411840
18421841
.. dbcommand:: ping
18431842

source/reference/glossary.rst

Lines changed: 33 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,19 @@ Glossary
1010
BSON
1111
A serialization format used to store documents and make remote
1212
procedure calls in MongoDB. "BSON" is a a portmanteau of the words
13-
"binary" and "JSON". BSON can be thought of as a binary representation
13+
"binary" and "JSON". Think of BSON as a binary representation
1414
of JSON (JavaScript Object Notation) documents. For a detailed spec,
1515
see `bsonspec.org <http://bsonspec.org/>`_.
1616

1717
database command
1818
Any MongoDB operation other than an insert, update, remove,
1919
or query. MongoDB exposes commands as queries
20-
query against the special ":term:`$cmd`" collection. For example,
21-
``count`` is run as a command.
20+
query against the special ":term:`$cmd`" collection. For
21+
example, the implementation of :dbcommand:`count` for MongoDB is
22+
a command.
2223

23-
.. seealso:: ":doc:`/reference/commands`" for a
24+
.. seealso:: ":doc:`/reference/commands`" for a full list of
25+
database commands in MongoDB
2426

2527
operator
2628
A keyword beginning with a ``$`` used to express a complex
@@ -36,13 +38,13 @@ Glossary
3638

3739
document
3840
A record in a MongoDB collection, and the basic unit of data
39-
in MongoDB. Documents are analogous to JSON object, but are
40-
stored in a more type-rich format known as BSON.
41+
in MongoDB. Documents are analogous to JSON object, but exist in
42+
the Database in a more type-rich format known as :term:`BSON`.
4143

4244
field
4345
A name-value pair in a term:`document`. Documents have zero
44-
or more fields. Fields are analogous to
45-
columns in relational databases.
46+
or more fields. Fields are analogous to columns in relational
47+
databases.
4648

4749
database
4850
A physical container for :term:`collections <collection>`.
@@ -66,15 +68,18 @@ Glossary
6668

6769
JSON
6870
JavaScript Object Notation. A human-readable, plain text format
69-
for expressing structured data.
71+
for expressing structured data with support in many programming
72+
languages.
7073

7174
JSON document
72-
A :term:`JSON` documents are collections of fields and values in a
73-
structured format. The following is a sample JSON document with
74-
two fields::
75+
A :term:`JSON` document is a collection of fields and values in a
76+
structured format. The following is a sample :term:`JSON
77+
document` with two fields:
78+
79+
.. code-block:: javascript
7580
76-
{ name: "MongoDB",
77-
type: "database" }
81+
{ name: "MongoDB",
82+
type: "database" }
7883
7984
admin database
8085
A privileged database named "``admin``". Users must have access
@@ -114,7 +119,7 @@ Glossary
114119
shard cluster
115120
The set of nodes comprising a :term:`sharded <sharding>` MongoDB deployment. A shard cluster
116121
consists of three config processes, one or more replica sets, and one or more
117-
``mongos`` routing processes.
122+
:program:`mongos` routing processes.
118123

119124
.. seealso:: ":doc:`/core/sharding`."
120125

@@ -180,10 +185,10 @@ Glossary
180185

181186
capped collection
182187
A fixed-sized :term:`collection <collection>`. Once they reach
183-
their fixed size, capped collections
184-
automatically overwrite their oldest entries. These collections
185-
are used to implement replication, but they may also be created
186-
by application developers.
188+
their fixed size, capped collections automatically overwrite
189+
their oldest entries. MongoDB's replication mechanism depends on
190+
capped collections, but developers may also use them in their
191+
applications.
187192

188193
.. seealso:: ":doc:`/core/capped-collections`."
189194

@@ -216,16 +221,16 @@ Glossary
216221

217222
master
218223
In conventional master/:term:`slave` replication, the master
219-
database receives all writes. The
220-
:term:`slave` instances replicate from the master instance
221-
in real time.
224+
database receives all writes. The :term:`slave` instances
225+
replicate from the master instance in real time.
222226

223227
slave
224-
In conventional :term:`master`/slave replication, the `slave`s
228+
In conventional :term:`master`/slave replication, slaves
225229
are read-only instances that replicate operations from the
226230
:term:`master` database. Data read from slave instances may
227-
not be completely consistent with the master. Therefore, applications
228-
requiring consistent reads must read from the master database instance.
231+
not be completely consistent with the master. Therefore,
232+
applications requiring consistent reads must read from the
233+
master database instance.
229234

230235
primary
231236
In a :term:`replica set`, the primary member is the current
@@ -260,8 +265,8 @@ Glossary
260265

261266
write-lock
262267
A lock on the database for a given writer.
263-
When a process writes to the database, it takes an exlcusive write-lock
264-
to prevent other processes from writing or reading.
268+
When a process writes to the database, it takes an exclusive
269+
write-lock to prevent other processes from writing or reading.
265270

266271
index
267272
A data structure that optimizes queries.
@@ -275,7 +280,7 @@ Glossary
275280

276281
btree
277282
A data structure used by most database management systems
278-
for to store indexes. MongoDB also uses b-trees for its indexes.
283+
for to store indexes. MongoDB uses b-trees for its indexes.
279284

280285
ISODate
281286
The international date format used by the MongoDB JavaScript shell

source/reference/javascript.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -409,7 +409,7 @@ Data Aggregation
409409

410410
:func:`group()` does not work in :term:`shard environments
411411
<shard cluster>`. Use the :term:`aggregation framework` or
412-
:term:`map/reduce` in :term:`sharded environments <sharding>`.
412+
:term:`map-reduce` in :term:`sharded environments <sharding>`.
413413

414414
.. note::
415415

source/reference/mongodump.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ Options
108108
.. option:: --journal
109109

110110
Allows :program:`mongodump` operations to use the durability
111-
:term:`journal <journaling>` to ensure that the export is in a
111+
:term:`journal` to ensure that the export is in a
112112
consistent state. This option is only relevant when specifying the
113113
:option:`--dbpath` option.
114114

@@ -190,7 +190,7 @@ functionality.
190190
The following command, creates a dump file that contains only the
191191
collection named "``collection``" in the database named "``test``". In
192192
this case the database is running on the local interface on port
193-
27017:
193+
``27017``:
194194

195195
.. code-block:: sh
196196

source/reference/mongoexport.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ Options
112112
.. option:: --journal
113113

114114
Allows :program:`mongoexport` operations to access the durability
115-
:term:`journal <journaling>` to ensure that the export is in a
115+
:term:`journal` to ensure that the export is in a
116116
consistent state. This option is only relevant when specifying the
117117
:option:`--dbpath` option.
118118

source/reference/mongofiles.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ Options
164164
.. option:: --journal
165165

166166
Allows :program:`mongofiles` operations to use the durability
167-
:term:`journal <journaling>` when running with :option:`--dbpath`
167+
:term:`journal` when running with :option:`--dbpath`
168168
to ensure that the database maintains a recoverable state. This
169169
forces :program:`mongofiles` to record all data on disk regularly.
170170

source/reference/mongooplog.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ Options
141141
.. option:: --journal
142142

143143
Allows :program:`mongooplog` operations to use the durability
144-
:term:`journal <journaling>` to ensure that the data files will
144+
:term:`journal` to ensure that the data files will
145145
remain in a consistent state during the writing process. This
146146
option is only relevant when specifying the :option:`--dbpath`
147147
option.

source/reference/server-status.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ mem
197197
significantly (i.e. gigabytes) larger than :status:`mem.mapped`,
198198
this could indicate a memory leak.
199199

200-
With :term:`journaling` enabled the value of :status:`mem.virtual`
200+
With :term:`journaling <journal>` enabled, the value of :status:`mem.virtual`
201201
is twice the value of :status:`mem.mapped`.
202202

203203
.. status:: mem.supported
@@ -603,7 +603,7 @@ dur
603603
Durability
604604
~~~~~~~~~~
605605

606-
Durability refers to :term:`journaling`.
606+
Durability refers to :term:`journaling <journal>`.
607607

608608
.. status:: dur
609609

@@ -650,7 +650,7 @@ Durability refers to :term:`journaling`.
650650
.. versionadded:: 2.0
651651

652652
The :status:`dur.compression` represents the compression ratio of
653-
the :term:`journal <journaling>`.
653+
:term:`journal`.
654654

655655
.. status:: dur.commitsInWriteLock
656656

0 commit comments

Comments
 (0)