Skip to content

Commit 46f1722

Browse files
(DOCSP-26780): Make reference a landing page and alphabetize subpages (#2371)
* (DOCSP-26780): Make reference a landing page and alphabetize subpages * (DOCSP-26760): improvements * fix refs
1 parent 7758399 commit 46f1722

File tree

10 files changed

+92
-73
lines changed

10 files changed

+92
-73
lines changed

snooty.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,7 @@ toc_landing_pages = [
103103
"/installation",
104104
"/introduction",
105105
"/mongo",
106+
"/reference",
106107
"/reference/aggregation",
107108
"/reference/bson-types",
108109
"/reference/change-events",

source/reference.txt

Lines changed: 74 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -10,112 +10,115 @@ Reference
1010
:depth: 1
1111
:class: singlecol
1212

13-
:doc:`/reference/operator`
14-
Documentation of query, update, projection, and aggregation
15-
framework operators.
13+
:ref:`collation`
14+
Description of collation fields as well as supported languages and
15+
associated locales for collation.
16+
17+
:ref:`configuration-options`
18+
Full documentation of the configuration file and available
19+
run-time operations.
20+
21+
:ref:`mongodb-uri`
22+
The complete specification of the MongoDB connection string format
23+
that the drivers use to describe connections to MongoDB
24+
deployments.
1625

17-
:doc:`/reference/command`
26+
:ref:`database-commands`
1827
Documentation of all MongoDB :term:`database commands <database
1928
command>` operations, syntax, and use.
2029

21-
:doc:`/reference/method`
22-
Documentation of JavaScript methods and helpers in
23-
:binary:`~bin.mongosh`.
30+
:ref:`default-mongodb-port`
31+
List of default ports used by MongoDB.
2432

25-
:doc:`/reference/mongo`
26-
Documentation of JavaScript methods and helpers in
27-
the legacy :binary:`~bin.mongo` shell.
33+
:ref:`default-mongodb-read-write-concerns`
34+
List of default read and write concerns.
2835

29-
:doc:`/reference/program`
30-
Documentation of :binary:`~bin.mongod` and :binary:`~bin.mongos`
31-
and all other tools distributed with MongoDB.
36+
:ref:`server-exit-codes`
37+
Details the codes and statuses that MongoDB returns when exiting.
3238

33-
:doc:`/reference/configuration-options`
34-
Full documentation of the configuration file and available
35-
run-time operations.
39+
:ref:`explain-results`
40+
Documentation on information returned from explain operations.
3641

37-
:doc:`/reference/parameters`
38-
Documentation of all :binary:`~bin.mongod` and
39-
:binary:`~bin.mongos` parameters that are available in the
40-
:dbcommand:`setParameter` (command) and :setting:`setParameter`
41-
run-time interface.
42+
:ref:`glossary`
43+
A glossary of common terms and concepts specific to MongoDB.
44+
45+
:ref:`log-messages-ref`
46+
Describes the components of log messages.
4247

43-
:doc:`/reference/cluster-parameters`
48+
:ref:`cluster-parameters`
4449
Documentation of all :binary:`~bin.mongod` and
4550
:binary:`~bin.mongos` parameters that are available in the
4651
:dbcommand:`setClusterParameter`.
4752

48-
:doc:`/reference/limits`
53+
:ref:`server-limits-thresholds`
4954
A list of important limits and thresholds imposed by MongoDB.
5055

51-
:doc:`/reference/explain-results`
52-
Documentation on information returned from explain operations.
53-
54-
:doc:`/reference/system-collections`
55-
Describes the collections that MongoDB reserves for internal use.
56-
57-
:doc:`/reference/connection-string`
58-
The complete specification of the MongoDB connection string format
59-
that the drivers use to describe connections to MongoDB
60-
deployments.
56+
:ref:`mongodb-package-components`
57+
Documentation of :binary:`~bin.mongod` and :binary:`~bin.mongos`
58+
and all other tools distributed with MongoDB.
6159

62-
:doc:`/reference/collation`
63-
Description of collation fields as well as supported languages and
64-
associated locales for collation.
60+
:ref:`server-parameters`
61+
Documentation of all :binary:`~bin.mongod` and
62+
:binary:`~bin.mongos` parameters that are available in the
63+
:dbcommand:`setParameter` (command) and :setting:`setParameter`
64+
run-time interface.
6565

66-
:doc:`/reference/mongodb-wire-protocol`
66+
:ref:`mongodb-wire-protocol`
6767
Description of the MongoDB Wire Protocol.
6868

69-
:doc:`/reference/log-messages`
70-
Describes the components of log messages.
71-
72-
:doc:`/reference/exit-codes`
73-
Details the codes and statuses that MongoDB returns when exiting.
7469

75-
:doc:`/reference/glossary`
76-
A glossary of common terms and concepts specific to MongoDB.
70+
:ref:`js-administrative-methods`
71+
Documentation of JavaScript methods and helpers in
72+
:binary:`~bin.mongosh`.
7773

78-
:doc:`/reference/default-mongodb-port`
79-
List of default ports used by MongoDB.
74+
:ref:`operator-ref-landing`
75+
Documentation of query, update, projection, and aggregation
76+
framework operators.
8077

81-
:doc:`/reference/mongodb-defaults`
82-
List of default read and write concerns.
78+
:ref:`stable-api`
79+
Describes the Stable API.
8380

84-
:doc:`/reference/server-sessions`
81+
:ref:`server-sessions`
8582
Describes server sessions.
8683

87-
:doc:`/reference/stable-api`
88-
Describes the Stable API.
84+
:ref:`metadata-system-collections`
85+
Describes the collections that MongoDB reserves for internal use.
86+
87+
:ref:`mongo`
88+
Documentation of JavaScript methods and helpers in
89+
the legacy :binary:`~bin.mongo` shell.
8990

9091
.. seealso::
9192

92-
The
93-
:doc:`/reference/data-models`, :doc:`/reference/sharding`,
94-
:doc:`/reference/replication`, and :doc:`/reference/security`
95-
contain additional reference material.
93+
The following pages contain additional reference material:
94+
95+
- :ref:`data-modeling-patterns`
96+
- :ref:`sharding-reference`
97+
- :ref:`replication-toc`
98+
- :ref:`security-reference`
9699

97100
.. toctree::
98101
:titlesonly:
99102
:hidden:
100103

101-
/reference/operator
102-
/reference/command
103-
/reference/method
104-
/reference/mongo
105-
/reference/program
104+
/reference/collation
106105
/reference/configuration-options
107-
/reference/parameters
108-
/reference/cluster-parameters
109-
/reference/limits
110-
/reference/explain-results
111-
/reference/system-collections
112106
/reference/connection-string
113-
/reference/collation
114-
/reference/mongodb-wire-protocol
115-
/reference/log-messages
116-
/reference/exit-codes
117-
/reference/glossary
107+
/reference/command
118108
/reference/default-mongodb-port
119109
/reference/mongodb-defaults
120-
/reference/server-sessions
110+
/reference/exit-codes
111+
/reference/explain-results
112+
/reference/glossary
113+
/reference/log-messages
114+
/reference/cluster-parameters
115+
/reference/limits
116+
/reference/program
117+
/reference/parameters
118+
/reference/mongodb-wire-protocol
119+
/reference/method
120+
/reference/operator
121121
/reference/stable-api
122+
/reference/server-sessions
123+
/reference/system-collections
124+
/reference/mongo

source/reference/default-mongodb-port.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _default-mongodb-port:
2+
13
====================
24
Default MongoDB Port
35
====================
@@ -44,4 +46,4 @@ The following table lists the default TCP ports used by MongoDB:
4446
messages. ``mongocryptd`` is installed with `MongoDB Enterprise
4547
Server (version 4.2 and later)
4648
<https://www.mongodb.com/download-center/enterprise>`__ and
47-
supports automatic encryption operations.
49+
supports automatic encryption operations.

source/reference/exit-codes.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _server-exit-codes:
2+
13
=======================
24
Exit Codes and Statuses
35
=======================

source/reference/limits.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _server-limits-thresholds:
2+
13
=============================
24
MongoDB Limits and Thresholds
35
=============================

source/reference/parameters.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _server-parameters:
2+
13
=========================
24
MongoDB Server Parameters
35
=========================

source/reference/program.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _mongodb-package-components:
2+
13
==========================
24
MongoDB Package Components
35
==========================

source/reference/security.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _security-reference:
2+
13
==================
24
Security Reference
35
==================
@@ -178,4 +180,3 @@ Security Reference Documentation
178180
/reference/system-users-collection
179181
/reference/resource-document
180182
/reference/privilege-actions
181-

source/reference/server-sessions.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _server-sessions:
2+
13
===============
24
Server Sessions
35
===============

source/reference/sharding.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _sharding-reference:
2+
13
==================
24
Sharding Reference
35
==================

0 commit comments

Comments
 (0)