docs/source/about.txt at master · jwilliams-mongo/docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
:orphan:

===========================
About MongoDB Documentation
===========================

.. default-domain:: mongodb

.. contents:: On this page
   :local:
   :backlinks: none
   :depth: 1
   :class: singlecol

The :manual:`MongoDB Manual </#>` contains
comprehensive documentation on MongoDB. 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.

License
-------

This work is licensed under a `Creative Commons
Attribution-NonCommercial-ShareAlike 3.0 United States License
<http://creativecommons.org/licenses/by-nc-sa/3.0/us/>`_

|copy| MongoDB, Inc. 2008-|year|

Man Pages
---------

In addition to the :manual:`MongoDB Manual </#>`, you can
access the :manual:`MongoDB Man Pages </manpages.tar.gz>`,
which are also distributed with the official MongoDB Packages.

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

This version of the manual reflects version {+version+}
of MongoDB.

See the `MongoDB Documentation Project Page <https://www.mongodb.com/docs>`_
for an overview of all editions and output formats of the MongoDB
Manual. You can see the full revision history and track ongoing
improvements and additions for all versions of the manual from its `GitHub
repository <https://github.com/mongodb/docs>`_.

The most up-to-date, current, and stable version of the manual is
always available at "https://www.mongodb.com/docs/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:

Contribute to the Documentation
-------------------------------

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.

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

You can clone the repository by issuing the following command at your
system shell:

.. code-block:: bash

   git clone git://github.com/mongodb/docs.git

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

The MongoDB Manual uses `Sphinx <http://sphinx-doc.org//>`_, a
sophisticated documentation engine built upon `Python Docutils
<http://docutils.sourceforge.net/>`_. The original `reStructured Text
<http://docutils.sourceforge.net/rst.html>`_ files, as well as all
necessary Sphinx extensions and build tools, are available in the same
repository as the documentation.

For more information on the MongoDB documentation process, see the
`Meta Documentation <https://www.mongodb.com/docs/meta/>`__.

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