Skip to content

Commit

Permalink
reorg: minor tweaks to pages and tables of contents
Browse files Browse the repository at this point in the history
  • Loading branch information
Sam Kleinman committed Apr 4, 2013
1 parent c3aa3cb commit 286680f
Show file tree
Hide file tree
Showing 10 changed files with 84 additions and 86 deletions.
28 changes: 5 additions & 23 deletions source/administration.txt
Original file line number Diff line number Diff line change
Expand Up @@ -24,31 +24,13 @@ documentation in other sections including: :doc:`/sharding`,
/administration/production-notes
/tutorial

.. seealso::
.. seealso::

- :doc:`/administration/replica-sets`
- :doc:`/core/replica-set-architectures`
- :doc:`/tutorial/configure-replica-set-secondary-sync-target`
- :doc:`/tutorial/configure-a-delayed-replica-set-member`
- :doc:`/tutorial/configure-a-hidden-replica-set-member`
- :doc:`/tutorial/configure-a-non-voting-replica-set-member`
- :doc:`/tutorial/configure-secondary-only-replica-set-member`
- :doc:`/tutorial/manage-chained-replication`
- :doc:`/tutorial/expand-replica-set`
- :doc:`/tutorial/remove-replica-set-member`
- :doc:`/tutorial/add-replica-set-arbiter`
- :doc:`/tutorial/replace-replica-set-member`
- :doc:`/tutorial/adjust-replica-set-member-priority`
- :doc:`/tutorial/resync-replica-set-member`
- :doc:`/tutorial/recover-data-following-unexpected-shutdown`
- :doc:`/tutorial/troubleshoot-replica-sets`
- :doc:`/administration/sharded-clusters`
- :doc:`/core/sharded-cluster-architectures`
- :doc:`/core/tag-aware-sharding`
- :doc:`/core/indexes`
- :doc:`/administration/indexes`

Additionally, Consider the :doc:`/tutorial` page that contains a
full index of all tutorials available in the MongoDB manual. These
documents provide pragmatic instructions for common operational
practices and administrative tasks.
Additionally, Consider the :doc:`/tutorial` page that
contains a full index of all tutorials available in the MongoDB
manual. These documents provide pragmatic instructions for common
operational practices and administrative tasks.
13 changes: 3 additions & 10 deletions source/aggregation.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,21 +11,14 @@ In version 2.2, MongoDB introduced the :doc:`aggregation framework
of tools to use for many data aggregation tasks. If you're familiar with data aggregation in SQL, consider the
:doc:`/reference/sql-aggregation-comparison` document as an introduction to
some of the basic concepts in the aggregation framework. Consider the
full documentation of the aggregation framework here:
full documentation of the aggregation framework and other data
aggregation tools for MongoDB here:

.. toctree::
:maxdepth: 2
:titlesonly:

core/aggregation
tutorial/aggregation-examples
reference/aggregation
core/map-reduce

In addition to the aggregation framework, MongoDB provides simple
:doc:`aggregation methods and commands </reference/simple-aggregation>`,
that you may find useful for some classes of tasks:

.. toctree::
:maxdepth: 2

reference/simple-aggregation
1 change: 1 addition & 0 deletions source/contents.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ MongoDB Manual Contents
administration
security
crud
data-modeling
aggregation
indexes
replication
Expand Down
43 changes: 11 additions & 32 deletions source/crud.txt
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ deployments. The :doc:`/core/document` provides an overview of
.. toctree::
:maxdepth: 1

core/read-operations
core/write-operations
/core/read-operations
/core/write-operations

Fundamental Concepts for Document Databases
-------------------------------------------
Expand All @@ -35,12 +35,11 @@ Fundamental Concepts for Document Databases
.. toctree::
:maxdepth: 1

core/data-modeling
core/document
reference/object-id
core/gridfs
reference/gridfs
reference/database-references
/core/document
/reference/object-id
/core/gridfs
/reference/gridfs
/reference/database-references

.. _crud-documents:
.. _crud-operations:
Expand All @@ -54,27 +53,7 @@ operations, i.e. CRUD, in MongoDB.
.. toctree::
:maxdepth: 1

core/create
core/read
core/update
core/delete

Data Modeling Patterns
----------------------

See :doc:`/core/data-modeling` for background on data modeling
practices in MongoDB.

.. toctree::
:maxdepth: 1

tutorial/model-embedded-one-to-one-relationships-between-documents
tutorial/model-embedded-one-to-many-relationships-between-documents
tutorial/model-referenced-one-to-many-relationships-between-documents
tutorial/model-data-for-atomic-operations
tutorial/model-tree-structures-with-parent-references
tutorial/model-tree-structures-with-child-references
tutorial/model-tree-structures-with-ancestors-array
tutorial/model-tree-structures-with-materialized-paths
tutorial/model-tree-structures-with-nested-sets
tutorial/model-data-for-keyword-search
/core/create
/core/read
/core/update
/core/delete
42 changes: 42 additions & 0 deletions source/data-modeling.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
=============
Data Modeling
=============

Data in MongoDB has a *flexible schema*. :term:`Collections
<collection>` do not enforce :term:`document` structure. Although you
may be able to use different structures for a single data set in
MongoDB, different data models may have significant impacts on MongoDB
and applications performance. Consider :doc:`/core/data-modeling` for
a conceptual overview of data modeling problems in MongoDB, and the
:ref:`data-modeling-patterns` documents for exaples of different
approaches to data models.

.. seealso:: :doc:`/use-cases` for overviews of application design,
including data models, with MongoDB.

Background
----------

.. toctree::
:titlesonly:

/core/data-modeling

.. _data-modeling-patterns:

Data Modeling Patterns
----------------------

.. toctree::
:titlesonly:

/tutorial/model-embedded-one-to-one-relationships-between-documents
/tutorial/model-embedded-one-to-many-relationships-between-documents
/tutorial/model-referenced-one-to-many-relationships-between-documents
/tutorial/model-data-for-atomic-operations
/tutorial/model-tree-structures-with-parent-references
/tutorial/model-tree-structures-with-child-references
/tutorial/model-tree-structures-with-ancestors-array
/tutorial/model-tree-structures-with-materialized-paths
/tutorial/model-tree-structures-with-nested-sets
/tutorial/model-data-for-keyword-search
2 changes: 1 addition & 1 deletion source/reference/components.txt
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ See :doc:`/tutorial/manage-mongodb-processes` for an introduction to
running :program:`mongod` instances.

.. toctree::
:hidden:
:maxdepth: 1

/tutorial/manage-mongodb-processes
/tutorial/rotate-log-files
6 changes: 3 additions & 3 deletions source/reference/gridfs.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. index:: GridFS

======
GridFS
======
================
GridFS Reference
================

.. default-domain:: mongodb

Expand Down
21 changes: 11 additions & 10 deletions source/replication.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,21 +11,21 @@ Replica Set Use and Operation
Consider these higher level introductions to replica sets:

.. toctree::
:maxdepth: 1
:titlesonly:

core/replication
core/replica-set-architectures
applications/replication
core/replication-internals
/core/replication
/core/replica-set-architectures
/applications/replication
/core/replication-internals

The following document describes master-slave replication, which is
deprecated. Use replica sets instead of master-slave in all new
deployments.

.. toctree::
:maxdepth: 1
:titlesonly:

core/master-slave
/core/master-slave

For documentation of MongoDB's operational segregation capabilities for
replica set deployments see the :doc:`/data-center-awareness`
Expand All @@ -40,7 +40,7 @@ The following tutorials describe a number of common replica set
maintenance and operational practices in greater detail.

.. toctree::
:maxdepth: 3
:titlesonly:

/administration/replica-sets

Expand All @@ -62,7 +62,8 @@ Finally, consider the following quick references of the commands and
operations available for replica set administration and use:

.. toctree::
:titlesonly:
:maxdepth: 1

reference/replica-commands
release-notes/replica-set-features
/reference/replica-commands
/release-notes/replica-set-features
6 changes: 3 additions & 3 deletions source/security.txt
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,15 @@ Strategies and Practices
------------------------

.. toctree::
:maxdepth: 2
:maxdepth: 1

/core/security

Tutorials
---------

.. toctree::
:maxdepth: 2
:maxdepth: 1

/tutorial/configure-linux-iptables-firewall
/tutorial/configure-windows-netsh-firewall
Expand All @@ -40,7 +40,7 @@ Reference
---------

.. toctree::
:maxdepth: 2
:maxdepth: 1

/reference/user-privileges
/reference/privilege-documents
8 changes: 4 additions & 4 deletions source/use-cases.txt
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ presents a method for using MongoDB to process and store hierarchical
reports (i.e. per-minute, per-hour, and per-day) from raw event data.

.. toctree::
:maxdepth: 2
:titlesonly:

/use-cases/storing-log-data
/use-cases/pre-aggregated-reports
Expand All @@ -63,7 +63,7 @@ inventory and users' shopping carts. Finally the
interacting with category hierarchies in MongoDB.

.. toctree::
:maxdepth: 2
:titlesonly:

/use-cases/product-catalog
/use-cases/inventory-management
Expand All @@ -81,7 +81,7 @@ introduces the method for modeling user comments on content, like blog
posts, and media, in MongoDB.

.. toctree::
:maxdepth: 2
:titlesonly:

/use-cases/metadata-and-asset-management
/use-cases/storing-comments
Expand All @@ -94,7 +94,7 @@ Python Application Development
------------------------------

.. toctree::
:maxdepth: 1
:titlesonly:

/tutorial/write-a-tumblelog-application-with-django-mongodb-engine
/tutorial/write-a-tumblelog-application-with-flask-mongoengine

0 comments on commit 286680f

Please sign in to comment.