TEMPLATE How to guide {stub}
This guide will help you {do something.} {That something is important or useful, because of some reason.}
Prerequisites: This how-to guide assumes you have:
- Completed the Getting Started Tutorial
- Have a working installation of Great Expectations
- Additional guide-specific prerequisites go here.
-
Guides must have a single h2
## Steps
heading with numbered h3### 1. xxx
headings below it. This ensures consistency and supports a built in TOC seen on the upper right of all guides. -
Guides may have an optional
## Additional Notes
and## Next Steps
headings as shown at the end of this template.
Steps
To qualify as a step, the things within it must either:
- require user input (change a name, add credentials, etc)
- or require user to run something and view output
1. First do this
Run this code to {do a thing}.
import os
2. Next do this.
{Concise description of what the user is going to do}.
context = ge.get_context()
3. Finally, do this.
When using Great Expectations there are sometimes choices to be made that do not warrant a separate how to guide. Use tabs to represent these.
Next, do {concise description of what the user is going to do} using either {choice in tab 1} or {choice in tab 2}.
- Using the CLI
- Using Python
Run this command in the CLI.
great_expectations suite new
Run this code in Python.
import os
from ruamel import yaml
Congratulations! You successfully {did the thing this guide is about}.
Additional Notes
- links to any scripts used in this guide to facilitate user feedback via GitHub
- additional context (use extremely sparingly)
To view the full scripts used in this page, see them on GitHub:
Next Steps
Include them only if it makes sense.
Now that you've {done a thing}, you'll want to work on these {other things}: