Specifications related to MongoDB
Python Perl JavaScript Java PHP C++ Other
Latest commit 6cee58a Feb 14, 2017 @ajdavis ajdavis committed on GitHub Merge pull request #146 from ajdavis/more-dbpointer
Extended JSON test: more DBPointer tests
Permalink
Failed to load latest commit information.
bin Addes skeleton scripts Apr 29, 2014
source Merge pull request #146 from ajdavis/more-dbpointer Feb 14, 2017
.gitignore
README.rst
makefile Added write specification after clean up May 14, 2014

README.rst

MongoDB Specifications

This repository holds in progress and completed specification for features of MongoDB, Drivers, and associated products. Also contained is a rudimentary system for producing these documents.

Writing Documents

Write documents using reStructuredText, following the MongoDB Documentation Style Guidelines.

Store all source documents in the source/ directory.

Building Documents

To build documents issue the make command in a local copy of this repository. The output PDFs end up in the build/ directory. The build depends on:

make all will build all documents in the source/ folder. The system builds all targets in build/.

Run make setup to generate (or regenerate) a makefile.generated file which provides specific targets for all files in the source file so you can choose to compile only some of the files that you need. Once generated, running "make [file-name-without-extension]" will rebuild only those files (if needed.)

Use make clean to remove the build/ directory and "make cleanup" to remove the LaTeX by-products from build/.

Licensing

All the specs in this repository are available under the Creative Commons Attribution-NonCommercial-ShareAlike 3.0 United States License.

In the future...

  • Templates will have logos, and templates for authorship, copyright, disclaimers, etc.
  • Non-PDF output targets.

If you have specific feature requests, or need help getting things running, please contact samk@10gen.com.