-
Notifications
You must be signed in to change notification settings - Fork 300
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* ecosystem public changes * clarification * cc suggestion
- Loading branch information
1 parent
39308f1
commit 22f4db4
Showing
2 changed files
with
14 additions
and
60 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,26 +1,13 @@ | ||
## Pull Request Info | ||
# Pull Request Info | ||
|
||
[PR Reviewing Guidelines](https://github.com/mongodb/docs-ecosystem/blob/master/REVIEWING.md) | ||
|
||
### Issue JIRA link: | ||
https://jira.mongodb.org/browse/DOCSP-NNNNN | ||
JIRA - <https://jira.mongodb.org/browse/DOCSP-NNNNN> | ||
Staging - <https://docs-mongodbcom-staging.corp.mongodb.com/drivers/docsworker-xlarge/NNNNN/> | ||
|
||
### Snooty build log: | ||
**Paste your workerpool job link here** | ||
|
||
### Docs staging link (requires sign-in on MongoDB Corp SSO): | ||
https://docs-mongodborg-staging.corp.mongodb.com/NNNNNNN/node/docsworker-xlarge/NNNNNNNNNNN/ | ||
|
||
### Self-Review Checklist | ||
## Self-Review Checklist | ||
|
||
- [ ] Is this free of any warnings or errors in the RST? | ||
- [ ] Did you run a spell-check? | ||
- [ ] Did you run a grammar-check? | ||
- [ ] Does it render on staging correctly? | ||
- [ ] Are all the links working? | ||
- [ ] Are the staging and workerpool job links in the PR description updated? | ||
|
||
### If your page documents a concept, does it meet the following criteria? | ||
|
||
- [ ] Target the [Jasmin persona](https://drive.google.com/file/d/14FbBOLCVxwSP6M9BK4Nz1Ir9tzxT8_02/view) | ||
- [ ] Target the [Lucas persona](https://drive.google.com/file/d/1J2vqJxo7ldv7OP_obA9Q-avf0o_ju4Lk/view) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,56 +2,23 @@ | |
MongoDB Ecosystem Documentation | ||
=============================== | ||
|
||
This repository contains documentation regarding components of the | ||
MongoDB ecosystem that lay outside of the core server | ||
functionality. This documentation builds on the work of the `MongoDB | ||
Manual <http://docs.mongodb.org/manual/>`. You can download and build | ||
this documentation locally if you already have `Sphinx | ||
<http://sphinx.pocoo.org/>`_ installed, with the following command: :: | ||
This repository contains documentation for the MongoDB drivers ecosystem site. | ||
|
||
pip install giza | ||
git clone git://github.com/mongodb/docs-ecosystem | ||
cd docs-ecosystem/ | ||
make html | ||
|
||
To build on Windows (using Cygwin): | ||
File JIRA Tickets | ||
----------------- | ||
|
||
- Ensure you have python installed | ||
- install Sphinx using ``easy_install -U Sphinx`` | ||
- install pyyamml using ``pip install pyyaml`` | ||
- Build the docs using ``sphinx-build -b html -d build/doctrees-html -c ./ source build/html`` | ||
Please file issue reports or requests at the `Documentation Jira Project | ||
<https://jira.mongodb.org/browse/DOCS>`_. | ||
|
||
You may also wish to install `Pygments | ||
<http://pygments.org>`_ to provide syntax highlighting for code | ||
examples. | ||
Licenses | ||
-------- | ||
|
||
Contribute | ||
---------- | ||
All documentation is available under the terms of a `Creative Commons | ||
License <https://creativecommons.org/licenses/by-nc-sa/3.0/>`_. | ||
|
||
The MongoDB Documentation Project is governed by the terms of the | ||
`MongoDB Contributor Agreement | ||
<https://www.mongodb.com/legal/contributor-agreement>`_. | ||
|
||
To contribute to the documentation, | ||
|
||
- If you have not done so already, please sign the `MongoDB Contributor Agreement <https://www.mongodb.com/legal/contributor-agreement>`_. | ||
|
||
- Fork this repository on GitHub and issue a pull request. | ||
|
||
|
||
Report Issues | ||
------------- | ||
|
||
File issue reports or requests at the `Documentation Jira Project | ||
<https://jira.mongodb.org/browse/DOCS>`_. | ||
|
||
License | ||
------- | ||
|
||
All documentation is available under the terms of a `Creative Commons | ||
License <http://creativecommons.org/licenses/by-nc-sa/3.0/>`_. | ||
|
||
If you have any questions, please contact `[email protected] | ||
<mailto:[email protected]>`_. | ||
|
||
-- The MongoDB/10gen Docs Team | ||
-- The MongoDB Docs Team |