Skip to content

Commit 067d0c1

Browse files
committed
DOCSP-8465: toctree (part1)
1 parent b9dd4d8 commit 067d0c1

11 files changed

+166
-15
lines changed

source/administration/upgrade-community-to-enterprise.txt

+20
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,28 @@ MongoDB Community Edition to MongoDB Enterprise Edition.
1919

2020
.. include:: /includes/extracts/enterprise-upgrade-edition-only.rst
2121

22+
.. list-table::
23+
:header-rows: 1
24+
25+
* - Deployment
26+
27+
- Tutorial
28+
29+
* - Standlone
30+
31+
- :doc:`/tutorial/upgrade-to-enterprise-standalone`
32+
33+
* - Replica Set
34+
35+
- :doc:`/tutorial/upgrade-to-enterprise-replica-set`
36+
37+
* - Sharded Cluster
38+
39+
- :doc:`/tutorial/upgrade-to-enterprise-sharded-cluster`
40+
2241
.. toctree::
2342
:titlesonly:
43+
:hidden:
2444

2545
/tutorial/upgrade-to-enterprise-standalone
2646
/tutorial/upgrade-to-enterprise-replica-set

source/appendix/security.txt

+5
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,14 @@ Appendix
44

55
.. default-domain:: mongodb
66

7+
- :doc:`/appendix/security/appendixA-openssl-ca`
8+
- :doc:`/appendix/security/appendixB-openssl-server`
9+
- :doc:`/appendix/security/appendixC-openssl-client`
10+
711

812
.. toctree::
913
:titlesonly:
14+
:hidden:
1015

1116
/appendix/security/appendixA-openssl-ca
1217
/appendix/security/appendixB-openssl-server

source/contents.txt

+26-1
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,33 @@ MongoDB Manual Contents
55
See :doc:`/about` for more information about the MongoDB Documentation
66
project, this Manual and additional editions of this text.
77

8+
.. COMMENT to DOCS team
9+
.. For now, adding the list since in order to hide the toctree
10+
.. But not actually sure that we shouldn't just include the toctree in the index.txt page and get rid of this page wholesale
11+
12+
- :doc:`/introduction`
13+
- :doc:`/installation`
14+
- :doc:`/mongo`
15+
- :doc:`/crud`
16+
- :doc:`/aggregation`
17+
- :doc:`/data-modeling`
18+
- :doc:`/core/transactions`
19+
- :doc:`/indexes`
20+
- :doc:`/security`
21+
- :doc:`/changeStreams`
22+
- :doc:`/replication`
23+
- :doc:`/sharding`
24+
- :doc:`/administration`
25+
- :doc:`/storage`
26+
- :doc:`/faq`
27+
- :doc:`/reference`
28+
- :doc:`/release-notes`
29+
- :doc:`/support`
30+
31+
832
.. toctree::
9-
:titlesonly:
33+
:maxdepth: 1
34+
:hidden:
1035

1136
Introduction </introduction>
1237
Installation </installation>

source/core/index-wildcard.txt

+1
Original file line numberDiff line numberDiff line change
@@ -356,5 +356,6 @@ For details, see :ref:`wildcard-index-restrictions-query-aggregation`.
356356

357357
.. toctree::
358358
:titlesonly:
359+
:hidden:
359360

360361
/reference/index-wildcard-restrictions

source/core/security-encryption-at-rest.txt

+4
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ Encryption at Rest
1010
:depth: 1
1111
:class: singlecol
1212

13+
.. role:: red(strong)
14+
:class: text-danger
15+
1316
Encryption at rest, when used in conjunction with transport encryption
1417
and good security policies that protect relevant accounts, passwords,
1518
and encryption keys, can help ensure compliance with security and
@@ -149,6 +152,7 @@ routines or use a commercial solution.
149152

150153
.. toctree::
151154
:titlesonly:
155+
:hidden:
152156

153157
/tutorial/configure-encryption
154158
/tutorial/rotate-encryption-key

source/core/security-users.txt

+3
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@ A user is uniquely identified by the user's name and associated
3838
authentication database. Starting in MongoDB 4.0.9, a users managed by
3939
MongoDB are assigned a unique ``userId``. [#userid]_
4040

41+
.. seealso:: :doc:`/tutorial/create-users`
42+
4143
.. _authentication-database:
4244
.. _user-authentication-database:
4345

@@ -164,5 +166,6 @@ of the following steps for each shard in your cluster:
164166

165167
.. toctree::
166168
:titlesonly:
169+
:hidden:
167170

168171
/tutorial/create-users

source/core/transactions.txt

+6
Original file line numberDiff line numberDiff line change
@@ -726,8 +726,14 @@ Storage Engines
726726
Additional Transactions Topics
727727
------------------------------
728728

729+
- :doc:`/core/transactions-in-applications`
730+
- :doc:`/core/transactions-production-consideration`
731+
- :doc:`/core/transactions-sharded-clusters`
732+
- :doc:`/core/transactions-operations`
733+
729734
.. toctree::
730735
:titlesonly:
736+
:hidden:
731737

732738
/core/transactions-in-applications
733739
/core/transactions-production-consideration

source/faq.txt

+14-1
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,21 @@
22
Frequently Asked Questions
33
==========================
44

5+
.. COMMENT Could actually leave as a blank page as it's an expansion page (i.e. the page doesn't really load if you click on the NAV)
6+
7+
FAQ pages in this section:
8+
9+
- :doc:`/faq/fundamentals`
10+
- :doc:`/faq/indexes`
11+
- :doc:`/faq/concurrency`
12+
- :doc:`/faq/sharding`
13+
- :doc:`/faq/replica-sets`
14+
- :doc:`/faq/storage`
15+
- :doc:`/faq/diagnostics`
16+
17+
518
.. toctree::
6-
:maxdepth: 2
19+
:hidden:
720

821
/faq/fundamentals
922
/faq/indexes

source/reference/program.txt

+42-5
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,25 @@ MongoDB Package Components
1313
Core Processes
1414
--------------
1515

16-
The core components in the MongoDB package are: :binary:`~bin.mongod`,
17-
the core database process; :binary:`~bin.mongos` the controller and query
18-
router for :term:`sharded clusters <sharded cluster>`; and
19-
:binary:`~bin.mongo` the interactive MongoDB Shell.
16+
The core components in the MongoDB package are:
2017

18+
.. list-table::
19+
20+
* - :binary:`~bin.mongod`,
21+
22+
- the core database process
23+
24+
* - :binary:`~bin.mongos`
25+
26+
- the controller and query router for :term:`sharded clusters
27+
<sharded cluster>`
28+
29+
* - :binary:`~bin.mongo`
30+
- the interactive MongoDB Shell.
31+
2132
.. toctree::
2233
:maxdepth: 1
34+
:hidden:
2335

2436
/reference/program/mongod
2537
/reference/program/mongos
@@ -34,8 +46,12 @@ Service. The :binary:`~bin.mongod.exe` and :binary:`~bin.mongos.exe` binaries
3446
provide a superset of the :binary:`~bin.mongod` and :binary:`~bin.mongos`
3547
options.
3648

49+
- :doc:`/reference/program/mongod.exe`
50+
- :doc:`/reference/program/mongos.exe`
51+
3752
.. toctree::
3853
:maxdepth: 1
54+
:hidden:
3955

4056
/reference/program/mongod.exe
4157
/reference/program/mongos.exe
@@ -49,8 +65,13 @@ dump files from the :binary:`~bin.mongod` instances, while
4965
dumps. :binary:`~bin.bsondump` converts BSON dump files into
5066
:term:`JSON`.
5167

68+
- :doc:`/reference/program/mongodump`
69+
- :doc:`/reference/program/mongorestore`
70+
- :doc:`/reference/program/bsondump`
71+
5272
.. toctree::
5373
:maxdepth: 1
74+
:hidden:
5475

5576
/reference/program/mongodump
5677
/reference/program/mongorestore
@@ -69,9 +90,13 @@ a :binary:`~bin.mongod` instance into JSON, CSV, or TSV.
6990
The conversion between BSON and other formats lacks full
7091
type fidelity. Therefore you cannot use :binary:`~bin.mongoimport` and
7192
:binary:`~bin.mongoexport` for round-trip import and export operations.
72-
93+
94+
- :doc:`/reference/program/mongoimport`
95+
- :doc:`/reference/program/mongoexport`
96+
7397
.. toctree::
7498
:maxdepth: 1
99+
:hidden:
75100

76101
/reference/program/mongoimport
77102
/reference/program/mongoexport
@@ -97,8 +122,14 @@ later time. :binary:`~bin.mongoreplay` is available for Linux and macOS.
97122
MongoDB 3.4 provides :binary:`~bin.mongoldap` for testing native operating system
98123
LDAP configuration options against a running LDAP server or set of servers.
99124

125+
- :doc:`/reference/program/mongostat`
126+
- :doc:`/reference/program/mongotop`
127+
- :doc:`/reference/program/mongoreplay`
128+
- :doc:`/reference/program/mongoldap`
129+
100130
.. toctree::
101131
:maxdepth: 1
132+
:hidden:
102133

103134
/reference/program/mongostat
104135
/reference/program/mongotop
@@ -111,8 +142,11 @@ GridFS
111142
:binary:`~bin.mongofiles` provides a command-line interact to a MongoDB
112143
:term:`GridFS` storage system.
113144

145+
- :doc:`/reference/program/mongofiles`
146+
114147
.. toctree::
115148
:maxdepth: 1
149+
:hidden:
116150

117151
/reference/program/mongofiles
118152

@@ -125,7 +159,10 @@ MongoDB Compass
125159
is a platform-specific installer for
126160
:ref:`MongoDB Compass Community Edition <compass-index>`.
127161

162+
- :doc:`/reference/program/install_compass`
163+
128164
.. toctree::
129165
:maxdepth: 1
166+
:hidden:
130167

131168
/reference/program/install_compass

source/reference/read-concern.txt

+13-8
Original file line numberDiff line numberDiff line change
@@ -205,14 +205,11 @@ The following read concern levels are available:
205205

206206
For more information on each read concern level, see:
207207

208-
.. toctree::
209-
:titlesonly:
210-
211-
/reference/read-concern-local
212-
/reference/read-concern-available
213-
/reference/read-concern-majority
214-
/reference/read-concern-linearizable
215-
/reference/read-concern-snapshot
208+
- :doc:`/reference/read-concern-local`
209+
- :doc:`/reference/read-concern-available`
210+
- :doc:`/reference/read-concern-majority`
211+
- :doc:`/reference/read-concern-linearizable`
212+
- :doc:`/reference/read-concern-snapshot`
216213

217214
``readConcern`` Support
218215
-----------------------
@@ -544,4 +541,12 @@ For read operations not associated with causally consistent sessions,
544541

545542
.. include:: /includes/unicode-checkmark.rst
546543

544+
.. toctree::
545+
:titlesonly:
546+
:hidden:
547547

548+
/reference/read-concern-local
549+
/reference/read-concern-available
550+
/reference/read-concern-majority
551+
/reference/read-concern-linearizable
552+
/reference/read-concern-snapshot

source/release-notes.txt

+32
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,11 @@ versions. Release notes also include instructions for upgrade.
1313
Upcoming Development Release
1414
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1515

16+
:doc:`/release-notes/4.4`
17+
1618
.. toctree::
1719
:maxdepth: 1
20+
:hidden:
1821

1922
/release-notes/4.4
2023

@@ -23,16 +26,42 @@ Current Stable Release
2326

2427
(*4.2-series*)
2528

29+
:doc:`/release-notes/4.2`
30+
2631
.. toctree::
2732
:maxdepth: 1
33+
:hidden:
2834

2935
/release-notes/4.2
3036

3137
Previous Stable Releases
3238
~~~~~~~~~~~~~~~~~~~~~~~~
3339

40+
- :doc:`/release-notes/4.0`
41+
- :doc:`/release-notes/3.6`
42+
- :doc:`/release-notes/3.4`
43+
44+
EOL'ed Releases
45+
~~~~~~~~~~~~~~~
46+
47+
.. hlist::
48+
:columns: 2
49+
50+
- :doc:`/release-notes/3.2`
51+
- :doc:`/release-notes/3.0`
52+
- :doc:`/release-notes/2.6`
53+
- :doc:`/release-notes/2.4`
54+
- :doc:`/release-notes/2.2`
55+
- :doc:`/release-notes/2.0`
56+
- :doc:`/release-notes/1.8`
57+
- :doc:`/release-notes/1.6`
58+
- :doc:`/release-notes/1.4`
59+
- :doc:`/release-notes/1.2`
60+
61+
3462
.. toctree::
3563
:maxdepth: 1
64+
:hidden:
3665

3766
/release-notes/4.0
3867
/release-notes/3.6
@@ -55,8 +84,11 @@ Previous Stable Releases
5584
Additional Information
5685
~~~~~~~~~~~~~~~~~~~~~~
5786

87+
See also: :doc:`/reference/versioning`
88+
5889
.. toctree::
5990
:maxdepth: 1
91+
:hidden:
6092

6193
/reference/versioning
6294

0 commit comments

Comments
 (0)