Skip to content

Commit e340676

Browse files
authored
community update (mongodb#96)
1 parent e032749 commit e340676

File tree

2 files changed

+8
-49
lines changed

2 files changed

+8
-49
lines changed

.github/pull_request_template.md

+4-17
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,13 @@
1-
## Pull Request Info
1+
# Pull Request Info
22

33
[PR Reviewing Guidelines](https://github.com/mongodb/docs-golang/blob/master/REVIEWING.md)
44

5-
### Issue JIRA link:
6-
https://jira.mongodb.org/browse/DOCSP-NNNNN
5+
JIRA - <https://jira.mongodb.org/browse/DOCSP-NNNNN>
6+
Staging - <https://docs-mongodbcom-staging.corp.mongodb.com/drivers/docsworker-xlarge/NNNNN/>
77

8-
### Snooty build log:
9-
**Paste your workerpool job link here**
10-
11-
### Docs staging link (requires sign-in on MongoDB Corp SSO):
12-
https://docs-mongodborg-staging.corp.mongodb.com/golang/docsworker-xlarge/NNNNNNNNNNN/
13-
14-
### Self-Review Checklist
8+
## Self-Review Checklist
159

1610
- [ ] Is this free of any warnings or errors in the RST?
1711
- [ ] Did you run a spell-check?
1812
- [ ] Did you run a grammar-check?
19-
- [ ] Does it render on staging correctly?
2013
- [ ] Are all the links working?
21-
- [ ] Are the staging and workerpool job links in the PR description updated?
22-
23-
### If your page documents a concept, does it meet the following criteria?
24-
25-
- [ ] Target the [Jasmin persona](https://drive.google.com/file/d/14FbBOLCVxwSP6M9BK4Nz1Ir9tzxT8_02/view)
26-
- [ ] Target the [Lucas persona](https://drive.google.com/file/d/1J2vqJxo7ldv7OP_obA9Q-avf0o_ju4Lk/view)

README.rst

+4-32
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,24 @@
1-
=================================
1+
===============================
22
MongoDB Go Driver Documentation
3-
=================================
3+
===============================
44

55
This repository contains documentation for the MongoDB Go Driver.
66

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`_
347

358
File JIRA Tickets
369
-----------------
3710

38-
File issue reports or requests at the `Documentation Jira Project
11+
Please file issue reports or requests at the `Documentation Jira Project
3912
<https://jira.mongodb.org/browse/DOCS>`_.
4013

4114
Licenses
4215
--------
4316

4417
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/>`_.
4619

4720
The MongoDB Documentation Project is governed by the terms of the
4821
`MongoDB Contributor Agreement
4922
<https://www.mongodb.com/legal/contributor-agreement>`_.
5023

5124
-- The MongoDB Docs Team
52-

0 commit comments

Comments
 (0)