|
2 | 2 | MongoDB Ecosystem Documentation |
3 | 3 | =============================== |
4 | 4 |
|
5 | | -This repository contains documentation regarding components of the |
6 | | -MongoDB ecosystem that lay outside of the core server |
7 | | -functionality. This documentation builds on the work of the `MongoDB |
8 | | -Manual <http://docs.mongodb.org/manual/>`. You can download and build |
9 | | -this documentation locally if you already have `Sphinx |
10 | | -<http://sphinx.pocoo.org/>`_ installed, with the following command: :: |
| 5 | +This repository contains documentation for the MongoDB drivers ecosystem site. |
11 | 6 |
|
12 | | - pip install giza |
13 | | - git clone git://github.com/mongodb/docs-ecosystem |
14 | | - cd docs-ecosystem/ |
15 | | - make html |
16 | 7 |
|
17 | | -To build on Windows (using Cygwin): |
| 8 | +File JIRA Tickets |
| 9 | +----------------- |
18 | 10 |
|
19 | | -- Ensure you have python installed |
20 | | -- install Sphinx using ``easy_install -U Sphinx`` |
21 | | -- install pyyamml using ``pip install pyyaml`` |
22 | | -- Build the docs using ``sphinx-build -b html -d build/doctrees-html -c ./ source build/html`` |
| 11 | +Please file issue reports or requests at the `Documentation Jira Project |
| 12 | +<https://jira.mongodb.org/browse/DOCS>`_. |
23 | 13 |
|
24 | | -You may also wish to install `Pygments |
25 | | -<http://pygments.org>`_ to provide syntax highlighting for code |
26 | | -examples. |
| 14 | +Licenses |
| 15 | +-------- |
27 | 16 |
|
28 | | -Contribute |
29 | | ----------- |
| 17 | +All documentation is available under the terms of a `Creative Commons |
| 18 | +License <https://creativecommons.org/licenses/by-nc-sa/3.0/>`_. |
30 | 19 |
|
31 | 20 | The MongoDB Documentation Project is governed by the terms of the |
32 | 21 | `MongoDB Contributor Agreement |
33 | 22 | <https://www.mongodb.com/legal/contributor-agreement>`_. |
34 | 23 |
|
35 | | -To contribute to the documentation, |
36 | | - |
37 | | -- If you have not done so already, please sign the `MongoDB Contributor Agreement <https://www.mongodb.com/legal/contributor-agreement>`_. |
38 | | - |
39 | | -- Fork this repository on GitHub and issue a pull request. |
40 | | - |
41 | | - |
42 | | -Report Issues |
43 | | -------------- |
44 | | - |
45 | | -File issue reports or requests at the `Documentation Jira Project |
46 | | -<https://jira.mongodb.org/browse/DOCS>`_. |
47 | | - |
48 | | -License |
49 | | -------- |
50 | | - |
51 | | -All documentation is available under the terms of a `Creative Commons |
52 | | -License <http://creativecommons.org/licenses/by-nc-sa/3.0/>`_. |
53 | | - |
54 | | -If you have any questions, please contact `docs@10gen.com |
55 | | -<mailto:docs@10gen.com>`_. |
56 | | - |
57 | | --- The MongoDB/10gen Docs Team |
| 24 | +-- The MongoDB Docs Team |
0 commit comments