Skip to content

docs(sphinx): repair getting-started and supported-databases documentation - #172

Open
cofin wants to merge 1 commit into
feat/snowflake-embucket-servicefrom
feat/docs-overhaul
Open

cofin wants to merge 1 commit into
feat/snowflake-embucket-servicefrom
feat/docs-overhaul

Conversation

@cofin

@cofin cofin commented Oct 22, 2026

Copy link
Copy Markdown
Member

Summary

Repairs outdated configuration, installation, and provider documentation across docs/getting-started/ and docs/supported-databases/, removing stale Docker Compose environment variables (SKIP_DOCKER_COMPOSE, USE_LEGACY_DOCKER_COMPOSE), fixing broken class/fixture references (AzureBlobService, dragonfly_*, minio_service, elasticsearch), and documenting Docker/Podman runtime resolution, deterministic session ownership, and pytest-xdist isolation modes.

Key Changes

Getting Started Documentation (docs/getting-started/)

  • Runtime & Session Configuration (docs/getting-started/configuration.rst): Removes obsolete Docker Compose references and documents --container-runtime (auto, docker, podman), --container-runtime-path, --container-host, --session-id / PYTEST_DATABASES_NAMESPACE, and xdist_<backend>_isolation_level fixtures.
  • Installation & Clientless Usage (docs/getting-started/installation.rst, docs/getting-started/basic-usage.rst): Documents clientless *_service readiness validation and lists all supported compatibility extras (postgres, alloydb, mysql, mariadb, dolt, oracle, mssql, spanner, bigquery, cockroachdb, yugabyte, mongodb, gizmosql, redis, valkey, elasticsearch, azure-blob, minio, rustfs).

Supported Databases Documentation (docs/supported-databases/)

  • Azure Blob Storage & Redis (azure_blob_storage.rst, redis.rst): Fixes AzureBlobService class/fixture names and dragonfly_* fixture references.
  • MinIO, RustFS & Elasticsearch (minio.rst, rustfs.rst, elasticsearch.rst): Updates Chainguard MinIO images (cgr.dev/chainguard/minio:latest and cgr.dev/chainguard/minio-client:latest), removes unimplemented environment variable claims, and updates pytest-databases[elasticsearch] usage examples.
  • Oracle & Spanner (oracle.rst, spanner.rst): Documents xdist_oracle_isolation_level and xdist_spanner_isolation_level ("database" vs "server").

Closes #109
Closes #146

@cofin
cofin changed the base branch from feat/podman-support to feat/snowflake-embucket-service October 22, 2026 03:59
@cofin
cofin force-pushed the feat/docs-overhaul branch from 205d7f5 to 9aa9342 Compare October 22, 2026 03:59
@cofin
cofin added this pull request to stack #173 October 22, 2026 05:10
@cofin
cofin marked this pull request as ready for review October 22, 2026 05:52
@cofin
cofin marked this pull request as draft October 22, 2026 05:52
@cofin
cofin force-pushed the feat/docs-overhaul branch from 9aa9342 to 5c4a1ab Compare October 22, 2026 17:46
@cofin
cofin force-pushed the feat/docs-overhaul branch from 5c4a1ab to 57aefc1 Compare October 22, 2026 20:11
@cofin
cofin force-pushed the feat/docs-overhaul branch from 57aefc1 to 43728bb Compare October 22, 2026 23:10
@cofin
cofin marked this pull request as ready for review October 22, 2026 23:29
@cofin
cofin force-pushed the feat/docs-overhaul branch from 43728bb to 735e152 Compare October 28, 2026 19:03
@cofin
cofin force-pushed the feat/docs-overhaul branch from 735e152 to 9f6fc17 Compare October 29, 2026 14:20

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant