Skip to content

Commit 24d7e0b

Browse files
authored
community updates (#124)
1 parent b01cc8a commit 24d7e0b

File tree

2 files changed

+7
-50
lines changed

2 files changed

+7
-50
lines changed

.github/pull_request_template.md

Lines changed: 4 additions & 17 deletions
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-spark-connector/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/NNNNNNN/node/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

Lines changed: 3 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -2,50 +2,20 @@
22
MongoDB Spark Connector Documentation
33
=====================================
44

5-
This repository contains documentation regarding MongoDB Spark Connector.
5+
This repository contains documentation for the MongoDB Spark Connector.
66

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

388
File JIRA Tickets
399
-----------------
4010

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

4414
Licenses
4515
--------
4616

4717
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/>`_.
4919

5020
The MongoDB Documentation Project is governed by the terms of the
5121
`MongoDB Contributor Agreement

0 commit comments

Comments
 (0)