MongoDB Documentation, Release 3.0.4 For the sake of consistency, remove trailing whitespaces in the source file. “Hard wrap” files to between 72 and 80 characters per-line. To propose a change to the documentation, do either of the following: Building the documentation is useful because Sphinx 40 and docutils can catch numerous errors in the format and syntax of the documentation. Additionally, having access to an example documentation as it will appear to the users is useful for providing more effective basis for the review process. Besides Sphinx, Pygments, and Python-Docutils, the documentation repository contains all requirements for building the documentation resource. Talk to someone on the documentation team if you are having problems running builds yourself. The makefile for this repository contains targets that automate the publication process. Use make html to publish a test build of the documentation in the build/ directory of your repository. Use make publish to build the full contents of the manual from the current branch in the ../public-docs/ directory relative the docs repository. Other targets include: This section provides an overview of the git branches in the MongoDB documentation repository and their use. $^{37}$https://jira.mongodb.org/browse/DOCS $^{38}$https://github.com/ $^{39}$https://github.com/mongodb/docs $^{40}$http://sphinx.pocoo.org/ 937 13.5. Contribute to the Documentation Branches Publication Builds Collaboration Standards and Practices • At least two people should vet all non-trivial changes to the documentation before publication. One of the reviewers should have significant technical experience with the material covered in the documentation. • All development and editorial work should transpire on GitHub branches or forks that editors can then merge into the publication branches. • Open a ticket in the documentation project 37 proposing the change. Someone on the documentation team will make the change and be in contact with you so that you can review the change. • Using GitHub$^{38}$, fork the mongodb/docs repository$^{39}$, commit your changes, and issue a pull request. Someone on the documentation team will review and incorporate your change into the documentation. • man - builds UNIX Manual pages for all Mongodb utilities. • pdfs - builds a PDF version of the manual (requires LaTeX dependencies.) • push - builds and deploys the contents of the ../public-docs/ .