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.
See CONTRIBUTING.md.
See Documentation.
This repo uses pre-commit for managing linting. pre-commit performs various
checks on the files and uses tools that help follow a consistent style within the repo.
To set up pre-commit locally, run:
brew install pre-commit
pre-commit installTo run pre-commit manually, run pre-commit run --all-files.
To run a manual hook like shellcheck manually, run:
pre-commit run --all-files --hook-stage manual shellcheckWe use mkdocs to render the documentation. To see a live view of the documentation, in a Python venv run:
pip install -r source/requirements.txt
mkdocs serveTo build the docs, use mkdocs build.
In CI we verify that there are no warnings. To replicate locally, run mkdocs build --strict.
There are many YAML to JSON converters. There are even several converters called yaml2json in NPM. Alas, we are not
using yaml2json anymore, but instead the js-yaml package. Use only that
converter, so that JSON is formatted consistently.
Run npm install -g js-yaml, then run make in the source directory at the top level of this repository to convert
all YAML test files in source to JSON.
Some specs include Python scripts that generate test files. These often live alongside their respective specs:
python source/server-discovery-and-monitoring/tests/errors/generate-error-tests.py # SDAM error tests
python source/client-side-encryption/etc/generate-corpus.py # Client-side encryption corpus tests
python source/etc/generate-handshakeError-tests.py # Handshake error testsIn general, these follow the generate-*.py naming convention in a spec's etc/ or tests/ subdirectory.
All the specs in this repository are available under the Creative Commons Attribution-NonCommercial-ShareAlike 3.0 United States License.