Skip to content

DOCS-1009 Import Meta Section into Manual #622

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.

Sign up for GitHub

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 10 commits into from
Feb 8, 2013
Merged

DOCS-1009 Import Meta Section into Manual #622

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
2a4b14d
DOCS-1009 move meta files to source/about directory
Feb 7, 2013
c6e6425
DOCS-1009 changed file extensions to .txt
Feb 7, 2013
112b0ad
DOCS-1009 reorged the 'about docs' page and added links to meta docs
Feb 7, 2013
16e8fc1
DOCS-1009 addition and edits to style guide
Feb 7, 2013
138d5c6
DOCS-1009 edits to the documentation organziation topic
Feb 7, 2013
f031f99
DOCS-1009 edits to practices
Feb 7, 2013
fc60eca
DOCS-1009 edits to build and deploy page
Feb 7, 2013
822be6a
DOCS-1009 minor
Feb 7, 2013
ca53951
DOCS-1009 moved and renamed files
Feb 7, 2013
9d9a68d
DOCS-1009 update to toc in about.txt
Feb 7, 2013
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
113 changes: 53 additions & 60 deletions source/about.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,40 +4,17 @@ About MongoDB Documentation

.. default-domain:: mongodb

.. _meta-about-mongodb:
`The MongoDB Manual <http://docs.mongodb.org/manual/#>`_ contains
comprehensive documentation on the MongoDB :term:`document`-oriented
database management system. This page describes the manual's licensing,
editions, and versions, and describes how to make a change request and
how to contribute to the manual.

About MongoDB
-------------
For more information on MongoDB, see `MongoDB: A Document Oriented Database <http://www.mongodb.org/about/>`_.
To download MongoDB, see the `downloads page <http://www.mongodb.org/downloads>`_.

MongoDB is a :term:`document`-oriented database management system
designed for performance, horizontal scalability, high
availability, and advanced queryability. See the following :wiki:`wiki
pages <>` for more information about MongoDB:

- :wiki:`Introduction`
- :wiki:`Philosophy`
- :wiki:`About`

If you want to download MongoDB, see the `downloads page
<http://www.mongodb.org/downloads>`_.

If you'd like to learn how to use MongoDB with your programming
language of choice, see the introduction to the :doc:`drivers
</applications/drivers>`.

.. _meta-about-documentation-project:

About the Documentation Project
-------------------------------

This Manual
~~~~~~~~~~~

The MongoDB documentation project provides a complete manual for the
MongoDB database.

Licensing
``````````
License
-------

This manual is licensed under a Creative Commons
"`Attribution-NonCommercial-ShareAlike 3.0 Unported
Expand All @@ -47,19 +24,18 @@ This manual is licensed under a Creative Commons
The MongoDB Manual is copyright |copy| 2011-|year| 10gen, Inc.

Editions
````````
--------

In addition to the <http://docs.mongodb.org/manual/> site, you can
also access this content in the following editions provided for your
convenience:
In addition to the `MongoDB Manual <http://docs.mongodb.org/manual/#>`_, you can
also access this content in the following editions:

- :hardlink:`ePub Format <MongoDB-Manual.epub>`

- :hardlink:`Single HTML Page <single/>`

- :hardlink:`PDF Format <MongoDB-Manual.pdf>`

PDF files that provide access to subsets of the MongoDB Manual:
You also can access PDF files that contain subsets of the MongoDB Manual:

- :hardlink:`MongoDB Reference Manual <MongoDB-reference-manual.pdf>`

Expand All @@ -81,7 +57,7 @@ manuals are available for offline use:
:issue:`DOCS Jira project<DOCS>`.

Version and Revisions
`````````````````````
---------------------

This version of the manual reflects version |version| of MongoDB.

Expand All @@ -99,10 +75,16 @@ current manual in the :hardlink:`release.txt` file.
The most up-to-date, current, and stable version of the manual is
always available at "http://docs.mongodb.org/manual/."

Report an Issue or Make a Change Request
----------------------------------------

To report an issue with this manual or to make a change request, file a ticket at the
`MongoDB DOCS Project on Jira <https://jira.mongodb.org/browse/DOCS>`_.

.. _meta-contributing:

Contributing to the Documentation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Contribute to the Documentation
-------------------------------

.. this toctree should be moved to a not-yet-extant "translation"
section of this page.
Expand All @@ -112,27 +94,30 @@ Contributing to the Documentation

/meta/translation

The entire source of the documentation is available in the `docs
repository <https://github.com/mongodb/docs>`_ along with all of the
other `MongoDB project repositories on GitHub <http://github.com/mongodb>`_.
You can clone the repository by issuing the following command at your
system shell:
The entire documentation source for this manual is available in the
`mongodb/docs repository <https://github.com/mongodb/docs>`_, which is one of the
`MongoDB project repositories on GitHub <http://github.com/mongodb>`_.

To contribute to the documentation, you can open a `GitHub account <https://github.com/>`_,
fork the `mongodb/docs repository <https://github.com/mongodb/docs>`_, make a
change, and issue a pull request.

.. code-block:: sh
In order for the documentation team to accept your change, you must
complete the `MongoDB/10gen Contributor Agreement <http://www.10gen.com/contributor>`_.

git clone git://github.com/mongodb/docs.git
.. regarding this, below. Isn't it the case that forking to their origin is the way
users can contribute to github.com/mongodb/docs. Simply cloning
to their local workstation gives no access to issue pull requests:
Copy link
Contributor

Choose a reason for hiding this comment

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

definitely.

I think explaining to people how to use github/git is beyond the scope of this document.

Copy link
Author

Choose a reason for hiding this comment

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

simpatico-nicity!

On Fri, Feb 8, 2013 at 11:17 AM, Sam Kleinman [email protected]:

In source/about.txt:

  • git clone git://github.com/mongodb/docs.git
    +.. regarding this, below. Isn't it the case that forking to their origin is the way
  • users can contribute to github.com/mongodb/docs. Simply cloning
  • to their local workstation gives no access to issue pull requests:

definitely.

I think explaining to people how to use github/git is beyond the scope of
this document.

—
Reply to this email directly or view it on GitHubhttps://github.com//pull/622/files#r2944717.


If you have a GitHub account and want to fork this repository, you may
issue pull requests, and someone on the documentation team will merge
in your contributions promptly. In order to accept your changes to the
Manual, you have to complete the `MongoDB/10gen Contributor Agreement
<http://www.10gen.com/contributor>`_.
.. You can clone the repository by issuing the following command at your
system shell:

This project tracks issues at MongoDB's :issue:`DOCS` project.
If you see a problem with the documentation, please report it there.
.. .. code-block:: sh

Writing Documentation
~~~~~~~~~~~~~~~~~~~~~
.. git clone git://github.com/mongodb/docs.git

About the Documentation Process
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The MongoDB Manual uses `Sphinx <http://sphinx.pocoo.org/>`_, a
sophisticated documentation engine built upon `Python Docutils
Expand All @@ -141,9 +126,17 @@ sophisticated documentation engine built upon `Python Docutils
necessary Sphinx extensions and build tools, are available in the same
repository as the documentation.

You can view the documentation style guide and the build instructions
in reStructured Text files in the top-level of the `documentation
repository <https://github.com/mongodb/docs>`_. If you have any
questions, please feel free to open a :issue:`Jira Case <DOCS>`.
For more information on the MongoDB documentation process, see:

.. toctree::
:maxdepth: 1

meta/style-guide
meta/practices
meta/organization
meta/build

If you have any questions, please feel free to open a :issue:`Jira Case
<DOCS>`.

.. include:: /includes/hash.rst
Loading