Skip to content

Commit d166bb2

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 5915d89 commit d166bb2

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
@@ -102,6 +102,7 @@ toc_landing_pages = [
102102
"/indexes",
103103
"/introduction",
104104
"/mongo",
105+
"/reference",
105106
"/reference/aggregation",
106107
"/reference/bson-types",
107108
"/reference/change-events",

source/reference.txt

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

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

19-
:doc:`/reference/command`
28+
:ref:`database-commands`
2029
Documentation of all MongoDB :term:`database commands <database
2130
command>` operations, syntax, and use.
2231

23-
:doc:`/reference/method`
24-
Documentation of JavaScript methods and helpers in
25-
:binary:`~bin.mongosh`.
32+
:ref:`default-mongodb-port`
33+
List of default ports used by MongoDB.
2634

27-
:doc:`/reference/mongo`
28-
Documentation of JavaScript methods and helpers in
29-
the legacy :binary:`~bin.mongo` shell.
35+
:ref:`default-mongodb-read-write-concerns`
36+
List of default read and write concerns.
3037

31-
:doc:`/reference/program`
32-
Documentation of :binary:`~bin.mongod` and :binary:`~bin.mongos`
33-
and all other tools distributed with MongoDB.
38+
:ref:`server-exit-codes`
39+
Details the codes and statuses that MongoDB returns when exiting.
3440

35-
:doc:`/reference/configuration-options`
36-
Full documentation of the configuration file and available
37-
run-time operations.
41+
:ref:`explain-results`
42+
Documentation on information returned from explain operations.
3843

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

45-
:doc:`/reference/cluster-parameters`
50+
:ref:`cluster-parameters`
4651
Documentation of all :binary:`~bin.mongod` and
4752
:binary:`~bin.mongos` parameters that are available in the
4853
:dbcommand:`setClusterParameter`.
4954

50-
:doc:`/reference/limits`
55+
:ref:`server-limits-thresholds`
5156
A list of important limits and thresholds imposed by MongoDB.
5257

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

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

68-
:doc:`/reference/mongodb-wire-protocol`
68+
:ref:`mongodb-wire-protocol`
6969
Description of the MongoDB Wire Protocol.
7070

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

77-
:doc:`/reference/glossary`
78-
A glossary of common terms and concepts specific to MongoDB.
72+
:ref:`js-administrative-methods`
73+
Documentation of JavaScript methods and helpers in
74+
:binary:`~bin.mongosh`.
7975

80-
:doc:`/reference/default-mongodb-port`
81-
List of default ports used by MongoDB.
76+
:ref:`operator-ref-landing`
77+
Documentation of query, update, projection, and aggregation
78+
framework operators.
8279

83-
:doc:`/reference/mongodb-defaults`
84-
List of default read and write concerns.
80+
:ref:`stable-api`
81+
Describes the Stable API.
8582

86-
:doc:`/reference/server-sessions`
83+
:ref:`server-sessions`
8784
Describes server sessions.
8885

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

9293
.. seealso::
9394

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

99102
.. toctree::
100103
:titlesonly:
101104
:hidden:
102105

103-
/reference/operator
104-
/reference/command
105-
/reference/method
106-
/reference/mongo
107-
/reference/program
106+
/reference/collation
108107
/reference/configuration-options
109-
/reference/parameters
110-
/reference/cluster-parameters
111-
/reference/limits
112-
/reference/explain-results
113-
/reference/system-collections
114108
/reference/connection-string
115-
/reference/collation
116-
/reference/mongodb-wire-protocol
117-
/reference/log-messages
118-
/reference/exit-codes
119-
/reference/glossary
109+
/reference/command
120110
/reference/default-mongodb-port
121111
/reference/mongodb-defaults
122-
/reference/server-sessions
112+
/reference/exit-codes
113+
/reference/explain-results
114+
/reference/glossary
115+
/reference/log-messages
116+
/reference/cluster-parameters
117+
/reference/limits
118+
/reference/program
119+
/reference/parameters
120+
/reference/mongodb-wire-protocol
121+
/reference/method
122+
/reference/operator
123123
/reference/stable-api
124+
/reference/server-sessions
125+
/reference/system-collections
126+
/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)