Skip to content

Tooling for working with and tracking code examples across MongoDB documentation.

License

Notifications You must be signed in to change notification settings

mongodb/code-example-tooling

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

92 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Code Example Tooling

This repository contains tooling that the MongoDB Developer Docs team uses to help us audit and track code examples across MongoDB's documentation corpus.

  • github-metrics: a Node.js script to get metrics from GitHub and write them to a database in Atlas.
  • audit: Two Go projects, plus Go type definitions and constants that are common to both of them:
    • gdcd: The Great Docs Code Devourer gets code examples from MongoDB documentation, along with a selection of metadata, adds a category, and writes the info to a database in Atlas.
    • dodec: The Database of Devoured Example Code: query and perform a few manual updates on the database of code examples and related metadata.
  • query-docs-feedback: A Go project and type definitions to query the MongoDB docs feedback for feedback related to code examples, and output the result to a report as .csv.
  • examples-copier: a Go app that runs as a GitHub App and copies files from the source code repo (generated code examples) to multiple target repos and branches.

About

Tooling for working with and tracking code examples across MongoDB documentation.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •