Skip to content

Commit db9f513

Browse files
author
Bob Grabar
committed
DOCS-390 fixed links in 2.0 release notes
1 parent a8913e4 commit db9f513

File tree

1 file changed

+75
-79
lines changed

1 file changed

+75
-79
lines changed

draft/release-notes/2.0.txt

Lines changed: 75 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -20,26 +20,24 @@ replacement for MongoDB 1.8.
2020
Preparation
2121
~~~~~~~~~~~
2222

23-
There are a few changes you must be aware of before attempting to
24-
upgrade. Read through all release notes before upgrading, and ensure
25-
that no changes will affect your deployment.
23+
Read through all release notes before upgrading, and ensure that no
24+
changes will affect your deployment.
2625

27-
If you create new indexes in 2.0, then downgrading to 1.8
28-
:wiki:`is possible <mongo+-+Index+Versions>`
29-
but reindexing the new collections will be required.
26+
If you create new indexes in 2.0, then downgrading to 1.8 is possible
27+
but you must reindex the new collections. For more information on 2.0
28+
indexes and on rollback, see :wiki:`Index Versions`.
3029

3130
``mongoimport`` and ``mongoexport`` now correctly adhere to the CSV spec
3231
for handling CSV input/output. This may break existing import/export
33-
workflows if they relied on the broken behavior. For more information
34-
see the related `JIRA case <https://jira.mongodb.org/browse/SERVER-1097>`_.
32+
workflows that relied on the previous behavior. For more information see
33+
:issue:`SERVER-1097`.
3534

36-
`Journaling <http://api.mongodb.org/wiki/current/Journaling.html>`_ is
37-
**enabled by default** in 2.0 for 64-bit builds. If you still prefer to
38-
run without journaling, start :program:`mongod` with the ``--nojournal``
39-
option. Otherwise, the journal files will be created on startup. The
40-
first time you start :program:`mongod` with journaling, you will see a
41-
delay while the new files are being created. In addition, you may see
42-
reduced write throughput.
35+
:wiki:`Journaling` is **enabled by default** in 2.0 for 64-bit builds.
36+
If you still prefer to run without journaling, start :program:`mongod`
37+
with the ``--nojournal`` option. Otherwise, the journal files are
38+
created on startup. The first time you start :program:`mongod` with
39+
journaling, you will see a delay while the new files are created.
40+
In addition, you may see reduced write throughput.
4341

4442
2.0 processes can talk to 1.8 processes and vice versa, so you can
4543
upgrade various parts of a cluster in any order.
@@ -67,11 +65,11 @@ Upgrading a Replica Set
6765

6866
#. To avoid losing the last few updates on failover you can
6967
temporarily halt your application (failover should take less than 10
70-
seconds) or change your application code to
71-
`confirm that each update reaches multiple servers <http://api.mongodb.org/wiki/current/Verifying%20Propagation%20of%20Writes%20with%20getLastError.html>`_.
68+
seconds), or you can set :ref:`write concern <write-concern>` in your application
69+
code to confirm that each update reaches multiple servers.
7270

7371
#. Use the :method:`rs.stepDown()` to step down the primary to allow
74-
the normal :ref:`failover <mongo+-+replica-set-failover>` procedure.
72+
the normal :ref:`failover <replica-set-failover>` procedure.
7573

7674
:method:`rs.stepDown()` and :dbcommand:`replSetStepDown` provide for
7775
shorter and more consistent failover procedures than simply
@@ -108,7 +106,8 @@ Concurrency Improvements
108106
When going to disk, the server will yield the write lock if the data
109107
being acted upon isn't likely to be in memory. The initial
110108
implementation of this feature now exists:
111-
`(SERVER-2563) <https://jira.mongodb.org/browse/SERVER-2563>`_
109+
110+
See :issue:`SERVER-2563` for more information.
112111

113112
The specific operations yield in 2.0 are:
114113

@@ -131,7 +130,8 @@ system setting or 1MB.
131130
Index Performance Enhancements
132131
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
133132

134-
v2.0 includes `significant improvements to the index structures <http://api.mongodb.org/wiki/current/Index%20Versions.html>`_.
133+
v2.0 includes significant improvements to the
134+
:wiki:`index structures <Index Versions>`.
135135
Indexes are often 25% smaller and 25% faster (depends on the use case).
136136
When upgrading from previous versions, the benefits of the new index
137137
type are realized only if you create a new index or re-index an old one.
@@ -145,22 +145,22 @@ re-index of any indexes created using 2.0.
145145
Sharding Authentication
146146
~~~~~~~~~~~~~~~~~~~~~~~
147147

148-
Authentication can now be used with :term:`sharded clusters <shard cluster>`.
148+
Authentication can now be used with :term:`shard clusters <shard cluster>`.
149149

150150
Replica Sets
151151
~~~~~~~~~~~~
152152

153153
Priorities
154154
``````````
155155

156-
Each :term:`replica set` member can now have a priority value consisting of a
157-
floating-point from 0 to 1000, inclusive. Priorities let you control
158-
which member of the set you prefer to have as :term:`primary`: the member with
159-
the highest priority that can see a majority of the set will be elected
160-
primary.
156+
Each :term:`replica set` member can now have a priority value consisting
157+
of a floating-point from 0 to 1000, inclusive. Priorities let you
158+
control which member of the set you prefer to have as :term:`primary`:
159+
the member with the highest priority that can see a majority of the set
160+
will be elected primary.
161161

162-
For example, suppose we have a replica set with three members, ``A``, ``B``, and
163-
``C``, and that their priorities are set as follows:
162+
For example, suppose you have a replica set with three members, ``A``, ``B``, and
163+
``C``, and suppose that their priorities are set as follows:
164164

165165
- ``A``'s priority is ``2``.
166166

@@ -171,15 +171,15 @@ For example, suppose we have a replica set with three members, ``A``, ``B``, and
171171
During normal operation, ``B`` will always be chosen as primary. If ``B`` goes
172172
down, ``A`` will be elected primary.
173173

174-
See the :ref:`Node Priority` documentation for more information.
174+
For more information, see the :ref:`Node Priority` documentation.
175175

176-
Data-center awareness
176+
Data-Center Awareness
177177
``````````````````````
178178

179179
You can now "tag" :term:`replica set` members to indicate their
180-
location. You can use these tags to design custom :term:`write rules <write concern>`
181-
across data centers, racks, specific servers, or any other
182-
architecture choice.
180+
location. You can use these tags to design custom :ref:`write rules <write-concern>`
181+
across data centers, racks, specific servers, or any other architecture
182+
choice.
183183

184184
For example, a DBA could define rules such as "very important write" or
185185
"customerData" or "audit-trail" to be replicated to certain servers,
@@ -193,14 +193,13 @@ would say:
193193
which would succeed if it fulfilled the conditions the DBA defined for
194194
"very important write".
195195

196-
For more information, see the
197-
`tagging documentation <http://api.mongodb.org/wiki/current/Data%20Center%20Awareness.html#DataCenterAwareness-Tagging%28version2.0%29>`_.
196+
For more information, see
197+
:wiki:`Tagging <Data+Center+Awareness#DataCenterAwareness-Tagging%28version2.0%29>`.
198198

199199
Your driver may also support tag-aware reads. Instead of simply
200-
specifying ``slaveOk``, you specify ``slaveOk`` with tags indicating which
201-
data-centers you want to read from. See your
202-
`driver <http://docs.mongodb.org/manual/applications/drivers/>`_
203-
for details.
200+
specifying ``slaveOk``, you specify ``slaveOk`` with tags indicating
201+
which data-centers to read from. For details, see the
202+
:doc:`/applications/drivers` documentation.
204203

205204
``w`` : ``majority``
206205
````````````````````
@@ -212,26 +211,25 @@ from the set.
212211

213212
For more information, see :ref:`replica-set-write-concern`.
214213

215-
Reconfiguration with a minority up
214+
Reconfiguration with a Minority Up
216215
``````````````````````````````````
217216

218217
If the majority of servers in a set has been permanently lost, you can
219218
now force a reconfiguration of the set to bring it back online.
220219

221-
See more information on :ref:`Reconfiguring a replica set when members are down <mongo+-+http://www.mongodb.org/display/DOCS/Reconfiguring+a+replica+set+when+members+are+down>`.
220+
See more information see :wiki:`Reconfiguring a replica set when members are down <Reconfiguring+a+replica+set+when+members+are+down>`.
222221

223-
Primary checks for a caught up secondary before stepping down
222+
Primary Checks for a Caught up Secondary before Stepping Down
224223
`````````````````````````````````````````````````````````````
225224

226225
To minimize time without a :term:`primary`, the :method:`rs.stepDown()`
227226
method will now fail if the primary does not see a :term:`secondary`
228227
within 10 seconds of its latest optime. You can force the primary to
229228
step down anyway, but by default it will return an error message.
230229

231-
See also
232-
:ref:`Forcing a Member to be Primary <mongo+-+http://www.mongodb.org/display/DOCS/Forcing+a+Member+to+be+Primary>`.
230+
See also :wiki:`Forcing a Member to be Primary <Forcing+a+Member+to+be+Primary>`.
233231

234-
Extended shutdown on the primary to minimize interruption
232+
Extended Shutdown on the Primary to Minimize Interruption
235233
`````````````````````````````````````````````````````````
236234

237235
When you call the :dbcommand:`shutdown` command, the :term:`primary`
@@ -250,76 +248,75 @@ secondary available.
250248
Maintenance Mode
251249
````````````````
252250

253-
When ``repair`` or ``compact`` is run on a :term:`secondary`, the
251+
When :dbcommand:`repair` or :dbcommand:`compact` is run on a :term:`secondary`, the
254252
secondary will automatically drop into "recovering" mode until the
255253
operation is finished. This prevents clients from trying to read from it
256254
while it's busy.
257255

258256
Geospatial Features
259257
~~~~~~~~~~~~~~~~~~~
260258

261-
Multi-location documents
259+
Multi-Location Documents
262260
````````````````````````
263261

264262
Indexing is now supported on documents which have multiple location
265263
objects, embedded either inline or in nested sub-documents. Additional
266264
command options are also supported, allowing results to be returned with
267265
not only distance but the location used to generate the distance.
268266

269-
For more information, see the :ref:`Geospatial documentation <mongo+-+http://www.mongodb.org/display/DOCS/Geospatial+Indexing#GeospatialIndexing-MultilocationDocuments>`.
267+
For more information, see :wiki:`Multi-location Documents <Geospatial+Indexing#GeospatialIndexing-MultilocationDocuments>`.
270268

271269
Polygon searches
272270
````````````````
273271

274-
Polygonal ``$within`` queries are also now supported for simple polygon
272+
Polygonal :operator:`$within` queries are also now supported for simple polygon
275273
shapes. For details, see the :operator:`$within` operator documentation.
276274

277-
Journaling enhancements
275+
Journaling Enhancements
278276
~~~~~~~~~~~~~~~~~~~~~~~
279277

280278
- Journaling is now enabled by default for 64-bit platforms. Use the
281279
``--nojournal`` command line option to disable it.
282280

283281
- The journal is now compressed for faster commits to disk.
284282

285-
- A new :option:`--journalCommitInterval` command line option exists for
283+
- A new :option:`--journalCommitInterval <mongod --journalCommitInterval>` run-time option exists for
286284
specifying your own group commit interval. 100ms is the default (same as
287285
in 1.8).
288286

289-
- A new :dbcommand:`getLastError{j: true} <getLastError>` option is
287+
- A new :dbcommand:`{ getLastError: { j: true } }<getLastError>` option is
290288
available to wait for the group commit. The group commit will happen
291289
sooner when a client is waiting on ``{j: true}``. If journaling is
292290
disabled, ``{j: true}`` is a no-op.
293291

294-
New ``ContinueOnError`` option for bulk insert
292+
New ``ContinueOnError`` Option for Bulk Insert
295293
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
296294

297-
When this flag is set (see your
298-
`driver <http://docs.mongodb.org/manual/applications/drivers/>`_
299-
on how to set it), bulk insert will continue to insert any remaining
300-
documents even if an insert fails (due, for example, to a duplicate
301-
key). The :dbcommand:`getLastError` command will report whether any
302-
doc inserts have failed (not just last one). If multiple errors occur,
303-
only the most recent will be reported by :dbcommand:`getLastError`.
295+
When this flag is set (to set it, see your
296+
:doc:`/applications/drivers` documentation),
297+
bulk insert will continue to insert any remaining documents even if an
298+
insert fails (due, for example, to a duplicate key). The
299+
:dbcommand:`getLastError` command will report whether any doc inserts
300+
have failed (not just the last one). If multiple errors occur, only the
301+
most recent will be reported by :dbcommand:`getLastError`.
304302

305-
See :ref:`OP_INSERT <mongo+-+http://www.mongodb.org/display/DOCS/Mongo+Wire+Protocol#MongoWireProtocol-OPINSERT>`.
303+
See :wiki:`OP_INSERT <Mongo+Wire+Protocol#MongoWireProtocol-OPINSERT>`.
306304

307305
Map Reduce
308306
~~~~~~~~~~
309307

310-
Output to a sharded collection
308+
Output to a Sharded Collection
311309
``````````````````````````````
312310

313-
Using the new flag ``sharded`` it is possible to send the result of a
311+
Using the new ``sharded`` flag, it is possible to send the result of a
314312
map/reduce to a sharded collection. Combined with the ``reduce`` or
315313
``merge`` flags, it is possible to keep adding data to very large
316314
collections from map/reduce jobs.
317315

318-
For more information, see the
319-
:ref:`output options <mongo+-+http://www.mongodb.org/display/DOCS/MapReduce#MapReduce-Outputoptions>`.
320-
documentation.
316+
For more information, see :wiki:`MapReduce Output Options <MapReduce#MapReduce-Outputoptions>`
317+
and :doc:`/reference/command/mapReduce`.
321318

322-
Performance improvements
319+
Performance Improvements
323320
````````````````````````
324321

325322
Map/reduce performance will benefit from the following:
@@ -330,7 +327,7 @@ Map/reduce performance will benefit from the following:
330327
- Larger javascript heap size, allowing for larger objects
331328
and less GC
332329

333-
- Supports pure JS execution with the jsMode flag. See :doc:`mapReduce`.
330+
- Supports pure JavaScript execution with the ``jsMode`` flag. See :doc:`/reference/command/mapReduce`.
334331

335332
New Querying Features
336333
~~~~~~~~~~~~~~~~~~~~~
@@ -340,48 +337,47 @@ Additional regex options: ``s``
340337

341338
Allows the dot (.) to match all characters including new lines. This is
342339
in addition to the currently supported ``i``, ``m`` and ``x``. See
343-
:ref:`Using regular expressions in queries <mongo+-+http://www.mongodb.org/display/DOCS/Advanced+Queries#AdvancedQueries-RegularExpressions>`.
340+
:wiki:`Regular Expressions <Advanced+Queries#AdvancedQueries-RegularExpressions>` and :operator:`$regex`.
344341

345342
$and
346343
````
347344

348345
A special boolean :operator:`$and` query operator is now available.
349346

350-
Command output changes
347+
Command Output Changes
351348
~~~~~~~~~~~~~~~~~~~~~~
352349

353350
The output of the :dbcommand:`validate` command and the documents in the
354351
``system.profile`` collection have both been enhanced to return
355352
information as BSON objects with keys for each value rather than as
356353
free-form strings.
357354

358-
Shell features
355+
Shell Features
359356
~~~~~~~~~~~~~~
360357

361-
Custom prompt
358+
Custom Prompt
362359
`````````````
363360

364361
You can define a custom prompt for the :program:`mongo` shell. You can
365362
change the prompt at any time by setting the prompt variable to a string
366-
or a custom JavaScript function returning a string. For examples, see the
367-
documentation on
368-
:ref:`Custom Prompt <mongo+-+http://www.mongodb.org/display/DOCS/Overview+-+The+MongoDB+Interactive+Shell#Overview-TheMongoDBInteractiveShell-CustomPrompt>`.
363+
or a custom JavaScript function returning a string. For examples, see
364+
:wiki:`Custom Prompt <Overview+-+The+MongoDB+Interactive+Shell#Overview-TheMongoDBInteractiveShell-CustomPrompt>`.
369365

370-
Default shell init script
366+
Default Shell Init Script
371367
`````````````````````````
372368

373369
On startup, the shell will check for a ``.mongorc.js`` file in the
374370
user's home directory. The shell will execute this file after connecting
375371
to the database and before displaying the prompt.
376372

377373
If you would like the shell not to run the ``.mongorc.js`` file
378-
automatically, start the shell with ``--norc``.
374+
automatically, start the shell with :option:`--norc <mongod --norc>`.
379375

380-
For more information, see :doc:`mongo`.
376+
For more information, see :doc:`/reference/mongo`.
381377

382378
Resources
383379
---------
384380

385381
- `MongoDB Downloads <http://mongodb.org/downloads>`_
386382
- `All JIRA Issues resolved in 2.0 <https://jira.mongodb.org/secure/IssueNavigator.jspa?mode=hide&requestId=11002>`_
387-
- `All Backward Incompatible Changes <https://jira.mongodb.org/secure/IssueNavigator.jspa?requestId=11023>_`
383+
- `All Backward Incompatible Changes <https://jira.mongodb.org/secure/IssueNavigator.jspa?requestId=11023>`_

0 commit comments

Comments
 (0)