The Grove platform contains infrastructure to test code examples and OpenAPI specifications, as well as helpful tooling for writers.
Test Code Examples
Use Grove's code example testing infrastructure to validate code examples used in our documentation. See the Test Code Examples section for detailed instructions on the following:
Set up a local environment
Create example files
Add tests for examples
Run tests locally
Format and snip tested examples for inclusion in documentation
Supported MongoDB Products
Grove's code example testing infrastructure currently supports the following MongoDB products:
Drivers
C#/.NET
Go
Java Sync
JavaScript
PyMongo
MongoDB Shell
Validate OpenAPI Specs
Use Grove's OASprey tool to validate OpenAPI specifications. See OpenAPI Spec Validation for detailed instructions on how to add and run tests.
Useful Tooling
Use Grove's custom tooling to simplify your workflow:
Copier App: Copy files automatically to another repository. See Copy Files Automatically to Another Repo for detailed instructions on how to configure a copier workflow.
Audit CLI: Perform various audit tasks in the
docs-mongodb-internalrepository. See Audit CLI for MongoDB Documentation for detailed instructions on how to use the Audit CLI tool.