Back to Great Expectations

2 Managing The Expectation Gallery Site

docs/expectation_gallery/2-managing-the-expectation-gallery-site.md

1.17.13.0 KB
Original Source

Managing the Expectation Gallery Site

Re-deploy the staging site

This should only need to be done if there are new Expectations merged in or if the content in the Expectation details pages changes (i.e. reformatting Expectation docstrings like PR 6340, PR 6423, PR 6577, and PR 8353).

Manually promote staging to prod

Staging changes will never go to prod without doing this!

The staging S3 file will get copied to prod at <https://superconductive-public.s3.us-east-2.amazonaws.com/static/gallery/expectation_library_v2.json> and the Algolia indicies for the prod site are updated by the manual_staging_json_to_prod CI pipeline, which is only manually triggered. You can re-deploy the prod site through Netlify.

Misc things you should rarely need to touch

Netlify environment variables

Staging site vars and Prod site vars

  • ALGOLIA_API_KEY
  • ALGOLIA_APPLICATION_KEY
  • S3_EXPECTATIONS_URL
  • S3_PACKAGES_URL

The Netlify vars are read by gatsby-node.js in the website repo

Algolia index names

On the <https://dashboard.algolia.com/apps/2S9KBQSQ3L/indices> page, the names that match these patterns are used by the gallery

  • prod_expectations_*
  • prod_expectations
  • prod_pack_expectations_*
  • prod_packages
  • staging_expectations_*
  • staging_expectations
  • staging_pack_expectations_*
  • staging_packages

These are the values of the Azure Pipelines environment variables in the pipeline yaml files which invoke the nodejs algolia scripts