Are you writing a new page for one of the drivers documentation sets? Do you need an existing, relatively similar page as a starting point to copy, paste, then tweak accordingly? Look no further.

First, make sure you have Rust installed. Follow these instructions to do so.

On your command line, navigate to the directory that contains a subdirectory housing all of your driver docs repositories. Then, clone the i-need-a-reference repository.

For example, if all your driver docs repositories (docs-java, docs-golang, etc.) live in a directory called work-stuff/repositories/, go to the work-stuff directory and clone this repository.

After cloning this repository, navigate into the i-need-a-reference directory and run the following:

cargo run -- <new file name> <category> <parent directory>

Edit the placeholders like this:

• Change <new file name> to the intended name of your new page, like aggregation.txt. Make sure that your file name ends in .txt.
• Change <category> to reflect the type of page you're writing, like fundamentals. There are only three available options for this argument: usage-examples, fundamentals, or other.
• Change <parent directory> to the name of the directory that holds all your drivers repos, like repositories.

If you're writing a new fundamentals page on aggregation and all your driver docs repositories are in a directory called repositories, run the following:

cargo run -- aggregation.txt fundamentals repositories

A reference file will open in your default text editor, and you'll see some information about how much of the reference file you can expect to replace.

Created by Nora Reidy