forked from tjworks/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathabout.txt
147 lines (100 loc) · 4.64 KB
/
about.txt
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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
:orphan:
===========================
About MongoDB Documentation
===========================
.. default-domain:: 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.
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>`_.
License
-------
This manual is licensed under a Creative Commons
"`Attribution-NonCommercial-ShareAlike 3.0 Unported
<http://creativecommons.org/licenses/by-nc-sa/3.0/>`_"
(i.e. "CC-BY-NC-SA") license.
The MongoDB Manual is copyright |copy| 2011-|year| MongoDB, Inc.
Editions
--------
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>` (without reference.)
- :hardlink:`HTML tar.gz <manual.tar.gz>`
You also can access PDF files that contain subsets of the MongoDB Manual:
- :hardlink:`MongoDB Reference Manual <MongoDB-reference-manual.pdf>`
- :hardlink:`MongoDB CRUD Operations <MongoDB-crud-guide.pdf>`
- :hardlink:`Data Models for MongoDB <MongoDB-data-models-guide.pdf>`
- :hardlink:`MongoDB Data Aggregation <MongoDB-aggregation-guide.pdf>`
- :hardlink:`Replication and MongoDB <MongoDB-replication-guide.pdf>`
- :hardlink:`Sharding and MongoDB <MongoDB-sharding-guide.pdf>`
- :hardlink:`MongoDB Administration <MongoDB-administration-guide.pdf>`
- :hardlink:`MongoDB Security <MongoDB-security-guide.pdf>`
MongoDB Reference documentation is also available as part of `dash
<http://kapeli.com/dash>`_. You can also access the :hardlink:`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 <http://docs.mongodb.org>`_
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>`_.
This edition reflects "|branch|" branch of the documentation
as of the "|commit|" revision. This branch is explicitly accessible
via "|hardlink|" and you can always reference the commit of the
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:
Contribute to the Documentation
-------------------------------
.. toctree::
:hidden:
/meta/translation
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:: sh
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:
.. 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