Skip to content

Commit 8f09ebe

Browse files
author
Sam Kleinman
committed
ux: shortening the index page
1 parent 012338d commit 8f09ebe

File tree

2 files changed

+29
-38
lines changed

2 files changed

+29
-38
lines changed

source/index.txt

Lines changed: 27 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -6,44 +6,34 @@ The MongoDB Manual
66

77
.. default-domain:: mongodb
88

9-
Welcome to the MongoDB Manual! This resource starts with the basics of
10-
MongoDB and goes on to describe the query language, advanced
11-
clustering configurations, administration, and more. It also includes
12-
a thorough glossary and command reference.
9+
Welcome to the MongoDB Manual! The Manual begins by introducing
10+
MongoDB continues to describe the query language, operational
11+
considerations and procedures, administration, among other topics in
12+
addition to a thorough reference.
1313

14-
This manual is under heavy development, and the ":doc:`/about`" page
15-
provides links and a more through overview of MongoDB and the Document
16-
project.
17-
18-
The MongoDB Manual will eventually replace the existing :ref:`MongoDB
19-
Wiki <mongodb-wiki>`. For the moment, both sets of documentation will
20-
coexist and link to one another. So, as you explore the manual, you
21-
may have to move between documentation sites.
14+
This manual is under constant development, and will soon replace the
15+
existing :ref:`MongoDB Wiki <mongodb-wiki>`. See the ":doc:`/about`"
16+
page for an overview of the MongoDB Documentation project. For now,
17+
documentation resources coexist and link to one another. As you
18+
explore the manual, expect to move between documentation sites.
2219

2320
Getting Started
2421
---------------
2522

2623
MongoDB is an open-source, document-oriented database designed for
2724
ease of development and scalability, with particular emphasis on
28-
Internet applications and infrastructure. If you're brand new to
29-
MongoDB, this is the place to start.
25+
Internet applications and infrastructure. If you're new to
26+
MongoDB, begin with the following resources:
3027

31-
1. :doc:`Installing MongoDB <installation>`
32-
2. :wiki:`The MongoDB Tutorial <Tutorial>`
33-
3. :doc:`Frequently Asked Questions </faq/fundamentals>`
28+
- :doc:`Installing MongoDB <installation>`
29+
- :wiki:`The MongoDB Tutorial <Tutorial>`
30+
- :doc:`Frequently Asked Questions </faq/fundamentals>`
3431

3532
MongoDB has an :wiki:`active community <community>`. You'll get a
3633
quick response to any question posted to the `MongoDB User Mailing List`_
3734

3835
.. _`MongoDB User Mailing List`: https://groups.google.com/forum/?fromgroups#!forum/mongodb-user
3936

40-
..
41-
For Developers
42-
--------------
43-
44-
For Administrators
45-
------------------
46-
4737
MongoDB...
4838
----------
4939

@@ -110,19 +100,21 @@ MongoDB...
110100
Reference
111101
---------
112102

113-
This manual features a detailed reference, including a glossary of
114-
terms, a command reference, a query operator reference, and a man page
115-
for all of the tools bundled with MongoDB.
116-
117-
.. toctree::
118-
:maxdepth: 3
103+
This manual features a detailed reference, including: a JavaScript
104+
method reference, detailed documentation of all operators in the
105+
MongoDB query language, manual pages for all MongoDB tools and
106+
binaries, a reference of all database commands, and full glossary and
107+
topic index.
119108

120-
reference
109+
- :doc:`/reference/javascript`
110+
- :doc:`/reference/operators`
111+
- :ref:`MongoDB Manual Pages <man-pages>`
112+
- :doc:`/reference/commands`
113+
- :doc:`/reference/glossary`
114+
- :ref:`MongoDB Manual Topic Index <genindex>`
121115

122-
- :ref:`genindex`
123-
- :doc:`Outline <contents>`
124-
- :ref:`search`
125-
- :doc:`Tutorial Index <tutorial>`
116+
Also consider the full :doc:`outline of the MongoDB Manual
117+
<contents>`, and an index of all :doc:`MongoDB tutorials <tutorial>`.
126118

127119
.. _mongodb-wiki:
128120

@@ -156,7 +148,6 @@ MongoDB. The following pages from the wiki are especially useful:
156148
- :wiki:`Collections`
157149
- :wiki:`Documents`
158150
- :wiki:`GridFS`
159-
- :wiki:`Indexes`
160151
- :wiki:`Querying`
161152
- :wiki:`Aggregation`
162153
- :wiki:`Optimization`
@@ -173,8 +164,6 @@ MongoDB. The following pages from the wiki are especially useful:
173164
- :wiki:`Components`
174165
- :wiki:`Journaling`
175166
- :wiki:`Production Notes <Production+Notes>`
176-
- :wiki:`Replication`
177-
- :wiki:`Sharding`
178167
- :wiki:`Monitoring and Diagnostics <Monitoring+and+Diagnostics>`
179168
- :wiki:`Backups`
180169
- :wiki:`Durability and Repair <Durability+and+Repair>`

source/reference.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ MongoDB Interface
2424
reference/command
2525
reference/method
2626

27+
.. _man-pages:
28+
2729
Manual Pages
2830
------------
2931

0 commit comments

Comments
 (0)