Skip to content

DOCS-1396 content audit #861

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

Closed
wants to merge 1 commit into from
Closed
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
12 changes: 2 additions & 10 deletions source/administration.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,7 @@ Administration
==============

The documentation in this section outlines core administrative tasks
and practices that operators of MongoDB will want to consider. In
addition to the core topics that follow, also consider the relevant
documentation in other sections including: :doc:`/sharding`,
:doc:`/replication`, and :doc:`/indexes`.
and practices that operators of MongoDB will want to consider.

.. toctree::
:maxdepth: 1
Expand All @@ -26,11 +23,6 @@ documentation in other sections including: :doc:`/sharding`,

.. seealso::

- :doc:`/administration/replica-sets`
- :doc:`/administration/sharded-clusters`
- :doc:`/administration/replica-sets`
- :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.
8 changes: 4 additions & 4 deletions source/administration/configuration.txt
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ control the configuration of your database instance.

.. _base-config:

Starting, Stopping, and Running the Database
--------------------------------------------
Configure the Database
----------------------

Consider the following basic configuration:

Expand Down Expand Up @@ -255,8 +255,8 @@ among all :program:`mongos` instances.
.. seealso:: The ":doc:`/sharding`" section of the manual for more
information on sharding and cluster configuration.

Running Multiple Database Instances on the Same System
------------------------------------------------------
Run Multiple Database Instances on the Same System
--------------------------------------------------

In many cases running multiple instances of :program:`mongod` on a
single system is not recommended. On some types of deployments
Expand Down
6 changes: 3 additions & 3 deletions source/administration/monitoring.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
===========================
Monitoring Database Systems
===========================
========================
Monitor Database Systems
========================
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

reverting. in favor of "Monitoring for MongoDB"

GIven that this is conceptual, I also think that calling it "Monitor MongoDB" would make it sound like a tutorial, which it really isn't.


.. default-domain:: mongodb

Expand Down
3 changes: 0 additions & 3 deletions source/administration/production-notes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@ Production Notes

.. default-domain:: mongodb

Overview
--------

This page details system configurations that affect MongoDB,
especially in production.

Expand Down
7 changes: 6 additions & 1 deletion source/contents.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ MongoDB Manual Contents
=======================

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

installation
administration
Expand All @@ -18,6 +18,11 @@ MongoDB Manual Contents
mongo
use-cases
faq

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

reference
release-notes
about
15 changes: 6 additions & 9 deletions source/core/import-export.txt
Original file line number Diff line number Diff line change
@@ -1,21 +1,18 @@
====================================
Importing and Exporting MongoDB Data
====================================
==============================
Import and Export MongoDB Data
==============================

.. default-domain:: mongodb

Full :doc:`database instance backups </core/backups>` are
useful for disaster recovery protection and routine database backup
operation; however, some cases require additional import and export
functionality.

This document provides an overview of the import and export programs
included in the MongoDB distribution. These tools are useful when you
want to backup or export a portion of your data without capturing the
state of the entire database, or for simple data ingestion cases. For
more complex data migration tasks, you may want to write your own
import and export scripts using a client :term:`driver` to interact
with the database itself.
with the database itself. For disaster recovery protection and routine
database backup operation, use full :doc:`database instance backups
</core/backups>`.

.. warning::

Expand Down
6 changes: 3 additions & 3 deletions source/installation.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
==================
Installing MongoDB
==================
===============
Install MongoDB
===============

.. index:: tutorials; installation
.. index:: installation tutorials
Expand Down
6 changes: 3 additions & 3 deletions source/mongo.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
=========================
Using the ``mongo`` Shell
=========================
===================
The ``mongo`` Shell
===================

.. default-domain:: mongodb

Expand Down
2 changes: 1 addition & 1 deletion source/security.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ risk management strategies. Additionally, this section includes
:ref:`tutorials` that outline basic network filter and firewall rules
to configure trusted environments for MongoDB.

Additionally, these documents describe the MongoDB role-based
This section also describes the MongoDB role-based
access-control model. MongoDB provides user roles that authorize users
for different levels of access to databases and database
operations. For more information, see the reference pages listed at
Expand Down
2 changes: 1 addition & 1 deletion source/tutorial.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
MongoDB Tutorials
=================

This index page provides a complete listing of all tutorials available
This page lists the tutorials available
as part of the :doc:`MongoDB Manual <contents>`. In addition to these
documents, you can refer to the introductory :doc:`MongoDB Tutorial
</tutorial/getting-started>`. If there is a process or pattern that you
Expand Down
6 changes: 3 additions & 3 deletions source/tutorial/configure-ssl.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
================================
Use MongoDB with SSL Connections
================================
=====================
Authenticate with SSL
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

editing because SSL isn't authentication (exactly) as much as it is encryption...

=====================

.. default-domain:: mongodb

Expand Down
6 changes: 3 additions & 3 deletions source/tutorial/getting-started.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
========================================
Getting Started with MongoDB Development
========================================
============================
Getting Started with MongoDB
============================

.. default-domain:: mongodb

Expand Down
4 changes: 2 additions & 2 deletions source/tutorial/install-mongodb-on-debian.txt
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,8 @@ which contains the latest **stable** release. Additionally you can
You cannot install this package concurrently with the ``mongodb`` package that
your release of Debian may include.

Installing MongoDB
------------------
Install MongoDB
---------------

Configure Package Management System (APT)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
8 changes: 4 additions & 4 deletions source/tutorial/install-mongodb-on-os-x.txt
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ provided by 10gen.
.. - :doc:`/getting-started`
.. STUB - :doc:`/tutorial/insert-test-data-into-a-mongodb-database`

Installing with Package Management
----------------------------------
Install with Package Management
-------------------------------

Both community package management tools: `Homebrew
<http://mxcl.github.com/homebrew/>`_ and `MacPorts
Expand Down Expand Up @@ -121,8 +121,8 @@ commands to insert a record in the "test" :term:`collection` of the

.. seealso:: ":program:`mongo`" and ":doc:`/reference/javascript`"

Installing from 10gen Builds
----------------------------
Install from 10gen Builds
-------------------------

10gen provides compiled binaries of all MongoDB software compiled for
OS X, which may provide a more straightforward installation process.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,8 @@ The 10gen repository contains two packages:
MongoDB systems.


Installing MongoDB
------------------
Install MongoDB
---------------

Configure Package Management System (YUM)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -89,8 +89,8 @@ production deployments, place the following configuration in
gpgcheck=0
enabled=1

Installing Packages
~~~~~~~~~~~~~~~~~~~
Install Packages
~~~~~~~~~~~~~~~~

Issue the following command (as ``root`` or with ``sudo``) to install
the latest stable version of MongoDB and the associated tools:
Expand Down
4 changes: 2 additions & 2 deletions source/tutorial/install-mongodb-on-ubuntu.txt
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ which contains the latest **stable** release. Additionally you can
You cannot install this package concurrently with the ``mongodb`` package
provided by Ubuntu.

Installing MongoDB
------------------
Install MongoDB
---------------

Configure Package Management System (APT)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
6 changes: 3 additions & 3 deletions source/tutorial/monitor-with-snmp.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
================================
Use MongoDB with SNMP Monitoring
================================
=================
Monitor with SNMP
=================

.. versionadded:: 2.2

Expand Down