Skip to content

Commit 734fdf6

Browse files
schmallisoandf-mongodb
schmalliso
authored and
andf-mongodb
committed
set up docs-commandline-tools repo to build on snooty 🎉
fix installation in toc_landing_pages also fix that note issue with the colons
1 parent bc8f4f7 commit 734fdf6

15 files changed

+211
-180
lines changed

‎snooty.toml

Lines changed: 46 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
1-
name = "docs-commandline-tools"
1+
name = "database-tools"
22
title = "MongoDB Database Tools"
33

4-
intersphinx = [ "https://docs.mongodb.com/manual/objects.inv" , "https://docs.python.org/2/objects.inv", "https://docs.python.org/2/objects.inv", "https://docs.python.org/3/objects.inv", "https://docs.atlas.mongodb.com/objects.inv", "https://docs.mongodb.com/compass/current/objects.inv"]
4+
intersphinx = [ "https://docs.mongodb.com/manual/objects.inv",
5+
"https://docs.atlas.mongodb.com/objects.inv",
6+
"https://docs.mongodb.com/compass/current/objects.inv"]
57

6-
toc_landing_pages = ["/"]
8+
toc_landing_pages = ["/installation/installation"]
79

810
[constants]
911
dbtools = "MongoDB Database Tools"
1012
dbtools-short = "Database Tools"
1113
dbtools-pkg = "mongodb-database-tools"
1214
package-name-org = "mongodb-org"
1315
package-name-enterprise = "mongodb-enterprise"
14-
version = "{+version+}"
16+
version = "100.2.1"
1517
release = "{+version+}"
1618
pgp-version = "{+version+}"
1719
pgp-fingerprint = "E162F504A20CDF15827F718D4B7C549A058F8B6B"
@@ -20,3 +22,43 @@ pgp-fingerprint-fmt = "E162 F504 A20C DF15 827F 718D 4B7C 549A 058F 8B6B"
2022
windows-sha256 = "AF5AF79EFE540DCDDC2825A396C71FCFC4FEB463BC9CADDCCDE20AD126321CCC"
2123
pgp-short-fingerprint = "0x4B7C549A058F8B6B"
2224
source-available = "`source available and free to use <https://github.com/mongodb/mongo/>`_"
25+
26+
[manpages.bsondump]
27+
file = "bsondump.txt"
28+
title = "bsondump"
29+
section = 1
30+
31+
[manpages.mongodump]
32+
file = "mongodump.txt"
33+
title = "mongodump"
34+
section = 1
35+
36+
[manpages.mongoexport]
37+
file = "mongoexport.txt"
38+
title = "mongoexport"
39+
section = 1
40+
41+
[manpages.mongofiles]
42+
file = "mongofiles.txt"
43+
title = "mongofiles"
44+
section = 1
45+
46+
[manpages.mongoimport]
47+
file = "mongoimport.txt"
48+
title = "mongoimport"
49+
section = 1
50+
51+
[manpages.mongorestore]
52+
file = "mongorestore.txt"
53+
title = "mongorestore"
54+
section = 1
55+
56+
[manpages.mongostat]
57+
file = "mongostat.txt"
58+
title = "mongostat"
59+
section = 1
60+
61+
[manpages.mongotop]
62+
file = "mongotop.txt"
63+
title = "mongotop"
64+
section = 1

‎source/bsondump.txt

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,9 @@ The :binary:`~bin.bsondump` converts :term:`BSON` files into human-readable
2626
formats, including :term:`JSON`. For example, :binary:`~bin.bsondump` is useful
2727
for reading the output files generated by :binary:`~bin.mongodump`.
2828

29-
.. important:: :binary:`~bin.bsondump` is a diagnostic tool for inspecting
29+
.. important::
30+
31+
:binary:`~bin.bsondump` is a diagnostic tool for inspecting
3032
BSON files, not a tool for data ingestion or other application use.
3133

3234
:binary:`~bin.bsondump` uses :manual:`Extended JSON v2.0
@@ -40,8 +42,7 @@ Versioning
4042

4143
.. include:: /includes/extracts/dbtools-version-single.rst
4244

43-
.. admonition:: Quick links to older documentation
44-
:class: note
45+
.. note:: Quick links to older documentation
4546

4647
- `MongoDB 4.2 bsondump <https://docs.mongodb.com/v4.2/reference/program/bsondump>`__
4748
- `MongoDB 4.0 bsondump <https://docs.mongodb.com/v4.0/reference/program/bsondump>`__
@@ -110,9 +111,9 @@ Options
110111
.. option:: --objcheck
111112

112113
Validates each :term:`BSON` object before outputting it in :term:`JSON`
113-
format. By default, :program:`bsondump` enables :option:`--objcheck`.
114+
format. By default, :program:`bsondump` enables :option:`--objcheck <bsondump --objcheck>`.
114115
For objects with a high degree of sub-document nesting,
115-
:option:`--objcheck` can have a small impact on performance.
116+
:option:`--objcheck <bsondump --objcheck>` can have a small impact on performance.
116117

117118

118119
.. option:: --type=<json|debug>
@@ -130,7 +131,7 @@ Options
130131
.. option:: --bsonFile
131132

132133
Specifies a path to a :term:`BSON` file to dump to JSON. :option:`--bsonFile` is
133-
an alternative to the positional :option:`<bsonFilename>` option.
134+
an alternative to the positional ``<bsonFilename>`` option.
134135

135136
By default, :program:`bsondump` reads from standard input.
136137

‎source/includes/changelogs/releases/100.0.0.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,11 @@ This release contains bugfixes, some new command-line options, and
1414
quality of life improvements. A full list can be found below, but here
1515
are some highlights:
1616

17-
- There are no longer restrictions on using ``--uri`` with other
17+
- There are no longer restrictions on using ``--uri>`` with other
1818
connection options such as ``--port`` and ``--password`` as long as
1919
the URI and the explicit option don't provide conflicting information.
2020
Connection strings can now be specified as a positional argument
21-
without the ``--uri`` option.
21+
without the ``--uri>`` option.
2222

2323
- The new :option:`--useArrayIndexFields
2424
<mongoimport --useArrayIndexFields>` flag for :binary:`mongoimport`

‎source/includes/extracts-clone-copy-db-examples.yaml

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,35 +4,34 @@ content: |
44
running on the default port 27017 to the ``examples`` database on the
55
same instance, you can:
66
7-
.. container::
87
9-
#. Use :binary:`~bin.mongodump` to dump the ``test`` database to
10-
an archive ``mongodump-test-db``:
11-
12-
.. code-block:: sh
8+
#. Use :binary:`~bin.mongodump` to dump the ``test`` database to
9+
an archive ``mongodump-test-db``:
10+
11+
.. code-block:: sh
1312
14-
mongodump --archive="mongodump-test-db" --db=test
13+
mongodump --archive="mongodump-test-db" --db=test
1514
16-
#. Use :binary:`~bin.mongorestore` with :option:`--nsFrom
17-
<mongorestore --nsFrom>` and :option:`--nsTo <mongorestore
18-
--nsFrom>` to restore (with database name change) from the
19-
archive:
15+
#. Use :binary:`~bin.mongorestore` with :option:`--nsFrom
16+
<mongorestore --nsFrom>` and :option:`--nsTo <mongorestore
17+
--nsFrom>` to restore (with database name change) from the
18+
archive:
2019
21-
.. code-block:: sh
20+
.. code-block:: sh
2221
23-
mongorestore --archive="mongodump-test-db" --nsFrom='test.*' --nsTo='examples.*'
22+
mongorestore --archive="mongodump-test-db" --nsFrom='test.*' --nsTo='examples.*'
2423
25-
.. tip::
24+
.. tip::
2625
27-
Include additional options as necessary, such as to specify
28-
the uri or host, username, password and authentication
29-
database.
26+
Include additional options as necessary, such as to specify
27+
the uri or host, username, password and authentication
28+
database.
3029
31-
Alternatively, instead of using an archive file, you can
32-
:binary:`~bin.mongodump` the ``test`` database to the standard
33-
output stream and pipe into :binary:`~bin.mongorestore`:
30+
Alternatively, instead of using an archive file, you can
31+
:binary:`~bin.mongodump` the ``test`` database to the standard
32+
output stream and pipe into :binary:`~bin.mongorestore`:
3433
35-
.. code-block:: sh
34+
.. code-block:: sh
3635
37-
mongodump --archive --db=test | mongorestore --archive --nsFrom='test.*' --nsTo='examples.*'
36+
mongodump --archive --db=test | mongorestore --archive --nsFrom='test.*' --nsTo='examples.*'
3837
...

‎source/includes/extracts-uri-positional.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ ref: _uri-positional
22
content: |
33
Starting with version ``100.0`` of |tool-binary|, the connection
44
string may alternatively be provided as a positional parameter,
5-
without using the :option:`--uri` option:
5+
without using the :option:`--uri <{{binaryname}} --uri>` option:
66
77
.. code-block:: none
88
@@ -17,7 +17,7 @@ content: |
1717
{{binaryname}} --username joe --password secret1 mongodb://mongodb0.example.com:27017 --ssl
1818
1919
Only one connection string can be provided. Attempting to
20-
include more than one, whether using the :option:`--uri` option or as
20+
include more than one, whether using the :option:`--uri <{{binaryname}} --uri>` option or as
2121
a positional argument, will result in an error.
2222
2323
---

‎source/includes/extracts-version.yaml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,7 @@ content: |
1010
tools, reference the :manual:`MongoDB Server Documentation
1111
</reference/program>` for that version of the tool:
1212
13-
.. admonition:: Quick links to older documentation
14-
:class: note
13+
.. note:: Quick links to older documentation
1514
1615
- `MongoDB 4.2 Tools <https://docs.mongodb.com/v4.2/reference/program/>`__
1716
- `MongoDB 4.0 Tools <https://docs.mongodb.com/v4.0/reference/program/>`__

‎source/includes/fact-see-install-guide.rst

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
11
The |tool-binary| tool is part of the *{+dbtools+}* package:
22

3-
.. container::
4-
5-
|arrow| Follow the :doc:`{+dbtools-short+} Installation Guide
6-
</installation/installation>` to install |tool-binary|.
3+
|arrow| Follow the :doc:`{+dbtools-short+} Installation Guide
4+
</installation/installation>` to install |tool-binary|.

‎source/index.txt

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -106,20 +106,18 @@ For information on MongoDB licensing, see `MongoDB Licensing
106106
Further Reading
107107
~~~~~~~~~~~~~~~
108108

109-
.. class:: toc
109+
`MongoDB, Inc.`_
110+
The company behind MongoDB.
110111

111-
`MongoDB, Inc.`_
112-
The company behind MongoDB.
112+
`MongoDB Manual <https://docs.mongodb.com/manual?tck=docs_databasetools>`__
113+
The MongoDB server documentation.
113114

114-
`MongoDB Manual <https://docs.mongodb.com/manual?tck=docs_databasetools>`__
115-
The MongoDB server documentation.
115+
`MongoDB Atlas <https://www.mongodb.com/cloud?tck=docs_databasetools>`__
116+
Database as a service.
116117

117-
`MongoDB Atlas <https://www.mongodb.com/cloud?tck=docs_databasetools>`__
118-
Database as a service.
119-
120-
`MongoDB Ecosystem <https://docs.mongodb.com/ecosystem/?tck=docs_databasetools>`__
121-
The documentation available for the drivers, frameworks,
122-
and services for use with MongoDB.
118+
`MongoDB Ecosystem <https://docs.mongodb.com/ecosystem/?tck=docs_databasetools>`__
119+
The documentation available for the drivers, frameworks,
120+
and services for use with MongoDB.
123121

124122
.. _`MongoDB, Inc.`: https://www.mongodb.com?tck=docs_databasetools
125123

‎source/mongodump.txt

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,7 @@
1010
``mongodump``
1111
=============
1212

13-
.. role:: red(strong)
14-
:class: text-danger
13+
.. default-domain:: mongodb
1514

1615
.. contents:: On this page
1716
:local:
@@ -48,8 +47,7 @@ Versioning
4847

4948
.. include:: /includes/extracts/dbtools-version-single.rst
5049

51-
.. admonition:: Quick links to older documentation
52-
:class: note
50+
.. note:: Quick links to older documentation
5351

5452
- `MongoDB 4.2 mongodump <https://docs.mongodb.com/v4.2/reference/program/mongodump>`__
5553
- `MongoDB 4.0 mongodump <https://docs.mongodb.com/v4.0/reference/program/mongodump>`__
@@ -551,8 +549,8 @@ Options
551549
.. option:: --username=<username>, -u=<username>
552550

553551
Specifies a username with which to authenticate to a MongoDB database
554-
that uses authentication. Use in conjunction with the :option:`--password` and
555-
:option:`--authenticationDatabase` options.
552+
that uses authentication. Use in conjunction with the :option:`--password <mongodump --password>` and
553+
:option:`--authenticationDatabase <mongodump --authenticationDatabase>` options.
556554

557555
.. include:: /includes/extracts/uri-used-with-username.rst
558556

@@ -562,12 +560,13 @@ Options
562560
.. option:: --password=<password>, -p=<password>
563561

564562
Specifies a password with which to authenticate to a MongoDB database
565-
that uses authentication. Use in conjunction with the :option:`--username` and
566-
:option:`--authenticationDatabase` options.
563+
that uses authentication. Use in conjunction with the
564+
:option:`--username <mongodump --username>` and
565+
:option:`--authenticationDatabase <mongodump --authenticationDatabase>` options.
567566

568-
To prompt the user for the password, pass the :option:`--username`
569-
option without :option:`--password` or specify an empty string as the
570-
:option:`--password` value, as in ``--password ""`` .
567+
To prompt the user for the password, pass the :option:`--username <mongodump --username>`
568+
option without :option:`--password <mongodump --password>` or specify an empty string as the
569+
:option:`--password <mongodump --password>` value, as in ``--password ""`` .
571570

572571
.. include:: /includes/extracts/uri-used-with-password.rst
573572

@@ -580,7 +579,7 @@ Options
580579

581580
.. option:: --authenticationDatabase=<dbname>
582581

583-
Specifies the authentication database where the specified :option:`--username` has been created.
582+
Specifies the authentication database where the specified :option:`--username <mongodump --username>` has been created.
584583
See :ref:`user-authentication-database`.
585584

586585
If you do not specify an authentication database, :program:`mongodump`
@@ -671,7 +670,6 @@ Options
671670
mongodump -d=test -c=records -q='{ "a": { "$gte": 3 }, "date": { "$lt": { "$date": "2016-01-01T00:00:00.000Z" } } }'
672671

673672

674-
675673
.. option:: --queryFile=<path>
676674

677675
Specifies the path to a file containing a JSON document as a query
@@ -832,7 +830,9 @@ Options
832830
- :option:`--db`
833831
- :option:`--collection`
834832

835-
.. seealso:: :option:`mongorestore --oplogReplay`
833+
.. seealso::
834+
835+
:option:`mongorestore --oplogReplay`
836836

837837

838838
.. option:: --dumpDbUsersAndRoles
@@ -1030,7 +1030,8 @@ as well, provide it with the ``AWS_SESSION_TOKEN``
10301030

10311031
Alternatively, the AWS access key ID, secret access key, and optionally
10321032
session token can each be provided outside of the connection string
1033-
using the :option:`--username`, :option:`--password`, and
1033+
using the :option:`--username <mongodump --username>`,
1034+
:option:`--password <mongodump --password>`, and
10341035
:option:`--awsSessionToken` options instead, like so:
10351036

10361037
.. code-block:: none

0 commit comments

Comments
 (0)