[DOCS] Add cloud store backend sync recipe (#11986) - #12046
Open
TemidayoA wants to merge 1 commit into
Open
Conversation
👷 Deploy request for niobium-lead-7998 pending review.Visit the deploys page to approve it
|
Contributor
Author
|
PR is up for #11986 — @joshua-stauffer, could you approve the workflow runs when you get a chance? |
Contributor
Author
|
Note on folder structure: the issue suggested placing this content under |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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!