|
2 | 2 | MongoDB Spark Connector Documentation |
3 | 3 | ===================================== |
4 | 4 |
|
5 | | -This repository contains documentation regarding MongoDB Spark Connector. |
| 5 | +This repository contains documentation for the MongoDB Spark Connector. |
6 | 6 |
|
7 | | -Build Locally |
8 | | -------------- |
9 | | - |
10 | | -To build the documentation locally, |
11 | | - |
12 | | -- Install `giza <https://pypi.python.org/pypi/giza/>`_, if not already |
13 | | - installed. |
14 | | - |
15 | | -- Run the following to download and build this documentation locally:: |
16 | | - |
17 | | - git clone [email protected]:mongodb/docs-spark-connector.git |
18 | | - cd docs-spark-connector/ |
19 | | - giza make html |
20 | | - |
21 | | -Contribute |
22 | | ----------- |
23 | | - |
24 | | -To contribute to the documentation, |
25 | | - |
26 | | -- If you have not done so already, please sign the `MongoDB Contributor |
27 | | - Agreement <https://www.mongodb.com/legal/contributor-agreement>`_. |
28 | | - |
29 | | -- Fork this repository on GitHub and issue a pull request. |
30 | | - |
31 | | -See the following documents that provide an overview of the |
32 | | -documentation style and process: |
33 | | - |
34 | | -- `Style Guide <http://www.mongodb.com/docs/meta/style-guide>`_ |
35 | | -- `Documentation Practices <http://www.mongodb.com/docs/meta/practices>`_ |
36 | | -- `Documentation Organization <http://www.mongodb.com/docs/meta/organization>`_ |
37 | 7 |
|
38 | 8 | File JIRA Tickets |
39 | 9 | ----------------- |
40 | 10 |
|
41 | | -File issue reports or requests at the `Documentation Jira Project |
| 11 | +Please file issue reports or requests at the `Documentation Jira Project |
42 | 12 | <https://jira.mongodb.org/browse/DOCS>`_. |
43 | 13 |
|
44 | 14 | Licenses |
45 | 15 | -------- |
46 | 16 |
|
47 | 17 | All documentation is available under the terms of a `Creative Commons |
48 | | -License <http://creativecommons.org/licenses/by-nc-sa/3.0/>`_. |
| 18 | +License <https://creativecommons.org/licenses/by-nc-sa/3.0/>`_. |
49 | 19 |
|
50 | 20 | The MongoDB Documentation Project is governed by the terms of the |
51 | 21 | `MongoDB Contributor Agreement |
|
0 commit comments