Skip to content

Commit 22f4db4

Browse files
authored
ecosystem public changes (#815)
* ecosystem public changes * clarification * cc suggestion
1 parent 39308f1 commit 22f4db4

File tree

2 files changed

+14
-60
lines changed

2 files changed

+14
-60
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-ecosystem/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: 10 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -2,56 +2,23 @@
22
MongoDB Ecosystem Documentation
33
===============================
44

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.
116

12-
pip install giza
13-
git clone git://github.com/mongodb/docs-ecosystem
14-
cd docs-ecosystem/
15-
make html
167

17-
To build on Windows (using Cygwin):
8+
File JIRA Tickets
9+
-----------------
1810

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>`_.
2313

24-
You may also wish to install `Pygments
25-
<http://pygments.org>`_ to provide syntax highlighting for code
26-
examples.
14+
Licenses
15+
--------
2716

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

3120
The MongoDB Documentation Project is governed by the terms of the
3221
`MongoDB Contributor Agreement
3322
<https://www.mongodb.com/legal/contributor-agreement>`_.
3423

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

Comments
 (0)