|
1 |
| -================================= |
| 1 | +=============================== |
2 | 2 | MongoDB Go Driver Documentation
|
3 |
| -================================= |
| 3 | +=============================== |
4 | 4 |
|
5 | 5 | This repository contains documentation for the MongoDB Go Driver.
|
6 | 6 |
|
7 |
| -Build and Stage |
8 |
| ---------------- |
9 |
| - |
10 |
| -To build and stage the documentation, use the |
11 |
| -`snooty autobuilder <https://docs.google.com/document/d/1tAr5kZL0xWhAbfmn9AVsIXbF9quaFFK9nfbUhpKJEBU/edit#heading=h.lwy5m08dmc0i>`_. |
12 |
| -To get the snooty autobuilder running on your fork, add a webhook |
13 |
| -according to the autobuilder setup guide. Feel free to reach out |
14 |
| -on the *snooty-onboarding* Slack channel if you cannot access |
15 |
| -the `how-to guide <https://docs.google.com/document/d/1x6NZExTldbAZCOMdKUVdPeI-ukMM1S6qZhbKjXAZ3uQ/edit>`_. |
16 |
| - |
17 |
| -Contribute |
18 |
| ----------- |
19 |
| - |
20 |
| -To contribute to the documentation, |
21 |
| - |
22 |
| -- If you have not done so already, please sign the `MongoDB Contributor |
23 |
| - Agreement <https://www.mongodb.com/legal/contributor-agreement>`_. |
24 |
| - |
25 |
| -- Fork this repository on GitHub and issue a pull request. |
26 |
| - |
27 |
| -See the following documents that provide an overview of the |
28 |
| -documentation style and process: |
29 |
| - |
30 |
| -- `Style Guide <http://www.mongodb.com/docs/meta/style-guide>`_ |
31 |
| -- `Documentation Practices <http://www.mongodb.com/docs/meta/practices>`_ |
32 |
| -- `Documentation Organization <http://www.mongodb.com/docs/meta/organization>`_ |
33 |
| -- `Build Instructions <http://www.mongodb.com/docs/meta/practices/#builds`_ |
34 | 7 |
|
35 | 8 | File JIRA Tickets
|
36 | 9 | -----------------
|
37 | 10 |
|
38 |
| -File issue reports or requests at the `Documentation Jira Project |
| 11 | +Please file issue reports or requests at the `Documentation Jira Project |
39 | 12 | <https://jira.mongodb.org/browse/DOCS>`_.
|
40 | 13 |
|
41 | 14 | Licenses
|
42 | 15 | --------
|
43 | 16 |
|
44 | 17 | All documentation is available under the terms of a `Creative Commons
|
45 |
| -License <http://creativecommons.org/licenses/by-nc-sa/3.0/>`_. |
| 18 | +License <https://creativecommons.org/licenses/by-nc-sa/3.0/>`_. |
46 | 19 |
|
47 | 20 | The MongoDB Documentation Project is governed by the terms of the
|
48 | 21 | `MongoDB Contributor Agreement
|
49 | 22 | <https://www.mongodb.com/legal/contributor-agreement>`_.
|
50 | 23 |
|
51 | 24 | -- The MongoDB Docs Team
|
52 |
| - |
0 commit comments