How to host and share Data Docs on a filesystem
This guide will explain how to host and share Data DocsHuman readable documentation generated from Great Expectations metadata detailing Expectations, Validation Results, etc. on a filesystem.
Prerequisites
- Completion of the Quickstart guide.
- A working installation of Great Expectations.
- A Great Expectations instance
Steps
1. Review defaults and change if desired.
Filesystem-hosted Data Docs are configured by default for Great Expectations deployments created using great_expectations init. To create additional Data Docs sites, you may re-use the default Data Docs configuration below. You may replace local_site
with your own site name, or leave the default.
data_docs_sites:
local_site: # this is a user-selected name - you may select your own
class_name: SiteBuilder
store_backend:
class_name: TupleFilesystemStoreBackend
base_directory: uncommitted/data_docs/local_site/ # this is the default path but can be changed as required
site_index_builder:
class_name: DefaultSiteIndexBuilder
2. Test that your configuration is correct by building the site
Run the following Python code to build and open your Data Docs:
context.build_data_docs()
context.open_data_docs()
Additional notes
- To share the site, you can zip the directory specified under the
base_directory
key in your site configuration and distribute as desired.
Additional resources
- Data DocsHuman readable documentation generated from Great Expectations metadata detailing Expectations, Validation Results, etc.