[DOCS] Add cloud store backend sync recipe (#11986) - #12046
Conversation
👷 Deploy request for niobium-lead-7998 pending review.Visit the deploys page to approve it
|
|
PR is up for #11986 — @joshua-stauffer, could you approve the workflow runs when you get a chance? |
|
Note on folder structure: the issue suggested placing this content under |
|
Thanks @TemidayoA! I'll have a chance to review the content in detail later this week. I built the docs preview (see link above), I noticed that it's missing from the navbar and the section overview. Two places to add a link:
The parallel data docs page should have the pattern you can follow. |
|
Thanks for the review, @joshua-stauffer I've added the sidebar entry and the LinkCard on the section overview page in commit |
Closes #11986
invoke lint(usesruff format+ruff check)tests/integration/data_sources_and_expectations(see AGENTS.md#integration-test-requirement)Summary
Adds a new docs recipe covering the supported sync-based workflow for storing GX artifacts (Expectations, Validation Results, Checkpoints, Data Docs) in cloud object storage, replacing the removed
TupleGCSStoreBackend,TupleS3StoreBackend, andTupleAzureBlobStoreBackendstore backends from GX 1.0.Follows the
configure_data_docs/pattern as requested in the issue:cloud_store_backend_sync/cloud_store_backend_sync.md— main guide (pull → run → push workflow, config-as-read-only, safe results syncing, single-writer Data Docs)cloud_store_backend_sync/_backends/_gcs.md,_aws.md,_azure.md— per-provider partialscloud_store_backend_sync/_examples/cloud_store_backend_gcs.py,_aws.py,_azure.py— tested example scripts, wired via<snippet>tagsIntegrationTestFixtureindocs/docusaurus/docs/components/examples_under_test.pywith the correspondingBackendDependenciesflag (GCS / AWS / AZURE)For more information about contributing, visit our community resources.
After you submit your PR, keep the page open and monitor the statuses of the various checks made by our continuous integration process at the bottom of the page. Please fix any issues that come up and reach out on Slack if you need help. Thanks for contributing!