Skip to content

Reorg 999 #571

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 18, 2013
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
220 changes: 76 additions & 144 deletions source/index.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,155 +6,87 @@ The MongoDB Manual

.. default-domain:: mongodb

Welcome to the MongoDB Manual! The Manual begins by introducing
MongoDB and continues to describe the query language, operational
considerations and procedures, administration, among other topics in
addition to a thorough reference.

This manual is under constant development, and will soon replace the
existing :ref:`MongoDB Uncyclo <mongodb-wiki>`. See the ":doc:`/about`"
page for an overview of the MongoDB Documentation project. For now,
documentation resources coexist and link to one another. As you
explore the manual, expect to move between documentation sites.

Getting Started
---------------

MongoDB is an open-source, document-oriented database designed for
ease of development and scalability, with particular emphasis on
Internet applications and infrastructure. If you're new to
MongoDB, begin with the following resources:

- :doc:`Installing MongoDB </installation>`
- :doc:`The MongoDB Tutorial </tutorial/getting-started>`
- :doc:`Frequently Asked Questions </faq/fundamentals>`

If you're familiar with database systems that use SQL, consider the
following documents, which compare common MongoDB conventions and
operations with their SQL equivalents:

- :doc:`/reference/sql-comparison`
- :doc:`/reference/sql-aggregation-comparison`
Welcome to the MongoDB Manual! MongoDB is an open-source,
document-oriented database designed for ease of development and
scalability.The Manual begins by introducing MongoDB and continues to
describe the query language, operational considerations and procedures,
administration, among other topics in addition to a thorough reference.
This manual is under constant development. See the :doc:`/about` for
more information on the MongoDB Documentation project.

MongoDB has an :wiki:`active community <community>`. You'll get a
quick response to any question posted to the `MongoDB User Mailing List`_.
.. list-table::
:header-rows: 1
:class: index-table

.. _`MongoDB User Mailing List`: https://groups.google.com/forum/?fromgroups#!forum/mongodb-user
* - Getting Started
- Developers
- Administrators
- Reference

* - :doc:`/installation`

MongoDB...
----------
:doc:`First Steps </tutorial/getting-started>`

:doc:`MongoDB Shell </mongo>`

:doc:`Tutorials </tutorial>`

.. hlist::
:columns: 2
- :doc:`Database Operations</crud>`

- **For Developers**
:doc:`Aggregation </applications/aggregation>`

If you're new to MongoDB, consider the :doc:`/installation`
document, the :doc:`/faq` section and particularly the
:doc:`developer FAQs
<faq/developers>`. The :doc:`/applications/drivers` page lists the
client libraries which all provide basic introductory
tutorials. Nevertheless, MongoDB users should have a basic
understanding several core concepts, including:

- :doc:`/core/document`
- :doc:`/core/read-operations`
- :doc:`/core/write-operations`

Once you have selected a programming :doc:`language and driver
<applications/drivers>`, become familiar with the core
:doc:`/crud` and :doc:`/applications` documents, in particular:

- :doc:`/applications/create`,
- :doc:`/applications/read`,
- :doc:`/applications/update`, and
- :doc:`/applications/delete`.

As you use MongoDB more you should also be learn about
:doc:`Indexing </indexes>`. Many users will also find MongoDB's
:doc:`data aggregation </aggregation>` useful. Finally, the
:doc:`use case </use-cases>` and :doc:`tutorials </tutorial>`
documents provide examples and outline common processes and
practices.

- **For Administrators**

If you're administering MongoDB, you'll need to know at least the
basics of :doc:`querying </applications/read>` MongoDB and :wiki:`using
the shell <Overview+-+The+MongoDB+Interactive+Shell>`. You can
then the Manual's :doc:`administration </administration>`
section, beginning with the :doc:`configuration
</administration/configuration>` document.

Most deployments consist of a single replica set. Scaling the
database horizontally on existing hardware usually involves
sharding, consider the documentation of these deployment options:

- :doc:`Replication </replication>`
- :doc:`Sharding </sharding>`

As you begin deploying MongoDB in production environments,
familiarize yourself with the :ref:`Administration Tutorials
<tutorials-administration>` section and the following topics:

- :doc:`Security </security>`
- :doc:`Backups </administration/backups>`
- :doc:`Monitoring </administration/monitoring>`
- :doc:`Hardware and System Settings </administration/production-notes>`

Reference
---------

This manual features a detailed reference, including: a JavaScript
method reference, detailed documentation of all operators in the
MongoDB query language, manual pages for all MongoDB tools and
binaries, a reference of all database commands, and full glossary and
topic index.

- :doc:`/reference/javascript`
- :doc:`/reference/operators`
- :ref:`MongoDB Manual Pages <man-pages>`
- :doc:`/reference/commands`
- :doc:`/reference/glossary`
- :ref:`MongoDB Manual Topic Index <genindex>`

Also consider the full :doc:`outline of the MongoDB Manual
<contents>`, and an index of all :doc:`MongoDB tutorials <tutorial>`.

.. _mongodb-wiki:

MongoDB Uncyclo
------------

This manual will eventually replace the :wiki:`MongoDB Uncyclo <>`. Until
then, you'll have to use both to get the best information on
MongoDB. The following pages from the wiki are especially useful:

.. hlist::
:columns: 1
:doc:`/indexes`

- **Getting Started**

.. hlist::
:columns: 1

- :wiki:`Introduction`
- :wiki:`Developer Introduction <Developer+Zone>`
- `Downloads <http://www.mongodb.org/downloads>`_

- :wiki:`Community` and :wiki:`Ecosystem <MongoDB+Ecosystem>`

.. hlist::
:columns: 2

- `10gen <http://www.10gen.com>`_
- `MongoDB Events <http://www.10gen.com/events/>`_
- `Planet MongoDB <http://planet.mongodb.org/>`_
- :wiki:`MongoDB Masters <MongoDB+Masters>`
- `Slides and Video <http://www.10gen.com/presentations/>`_
- :wiki:`Hosting Center <Hosting+Center>`
- :wiki:`Windows`
- `MongoDB Monitoring Service <http://www.10gen.com/products/mms/>`_ (`docs <http://mms.10gen.com/help/>`_)
- :wiki:`Administrative Interfaces <Admin+UIs>`
- :wiki:`International Documentation <International+Docs>`
- `MongoDB Books <http://www.10gen.com/books/>`_
:doc:`Develop with MongoDB</applications>`

- :doc:`Operations </administration>`

:doc:`Replica Sets </replication>`

:doc:`Sharded Clusters</sharding>`

:doc:`MongoDB Security </security>`

- :doc:`Shell Methods </reference/javascript>`

:doc:`Query Operators </reference/operators>`

:doc:`Database Commands </reference/commands>`

:doc:`/reference/glossary`

* -
-
-
-

If you're new to MongoDB, also consider the following resources:

.. toctree::
:maxdepth: 1

reference/sql-comparison
/faq
Complete Reference Section </reference>

Community
~~~~~~~~~

MongoDB has an :wiki:`active community <community>`. You'll get a quick
response to MongoDB questions (i.e. questions tagged ``mongodb``) posted
to `Stack Overflow`_.

.. _`Stack Overflow`: http://stackoverflow.com/questions/tagged/mongodb

Additional Resources
~~~~~~~~~~~~~~~~~~~~

The following resources provide additional information:

- `10gen <http://10gen.com>`_
- `MongoDB Events <http://www.mongodb.org/events/>`_
- `Planet MongoDB <http://planet.mongodb.org/>`_
- `Slides and Video <http://www.10gen.com/presentations/>`_
- `MongoDB Monitoring Service <http://mms.10gen.com/>`_ (`MMS Help docs <http://mms.10gen.com/help/>`_)
- `MongoDB Books <http://10gen.com/books/>`_
39 changes: 38 additions & 1 deletion themes/mongodb/static/mongodb-docs.css_t
Original file line number Diff line number Diff line change
Expand Up @@ -320,13 +320,50 @@ div td pre {
}

table.docutils td { padding: 8px; }

table.docutils>thead th.head {
padding-top: 5px;
padding-bottom: 5px;
background-color: #F3F4EB;
}

table.index-table td {
text-align: center;
border-bottom: none;
border-right: 4px solid white;
padding-left: 15px;
padding-right: 15px;
padding-bottom: 0px;
padding-top: 5px;
}

table.index-table tr.row-even td p {
line-height: 1.3em;
}


table.index-table tr.row-odd td {
text-align: center;
border-bottom: none;
border-right: none;
padding-left: 15px;
padding-right: 15px;
max-height:5px;
padding-top: 0px;
}

table.index-table {
margin: auto;
background-color: #F3F4EB;
}

table.index-table th.head {
text-align: center;
padding-top:10px;
padding-left: 15px;
padding-right: 15px;
border-bottom: none;
}

div#mongodb ul {
list-style: none;
padding-left:0px;
Expand Down