diff --git a/docs/cli.md b/docs/cli.md index b9f0d80..e954482 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -74,6 +74,12 @@ Publish the local HTML example: go run ./cmd/distributor run --config examples/local-html.yml ``` +Preview local fan-out publication: + +```sh +go run ./cmd/distributor run --config examples/fan-out.yml --dry-run +``` + ## Output `run` prints the number of configured pipelines, one line per pipeline, one line per planned destination action, and a final status line. Actions include: diff --git a/docs/config.md b/docs/config.md index 3b3b98e..1598bf7 100644 --- a/docs/config.md +++ b/docs/config.md @@ -150,5 +150,4 @@ Maintained examples live under [examples](../examples/): - `local-to-local.yml`: minimal local config. - `local-publish.yml`: runnable local source publication. - `local-html.yml`: runnable local HTML publication. - -`examples/fan-out.yml` currently demonstrates accepted SSH/S3 config shape but is not executable until remote backend support exists. +- `fan-out.yml`: runnable local fan-out publication to source and HTML destinations. diff --git a/docs/operations.md b/docs/operations.md index 0e5bc69..912047f 100644 --- a/docs/operations.md +++ b/docs/operations.md @@ -26,6 +26,12 @@ Run the local HTML publication: go run ./cmd/distributor run --config examples/local-html.yml ``` +Preview local fan-out publication: + +```sh +go run ./cmd/distributor run --config examples/fan-out.yml --dry-run +``` + ## Filesystem Layout Source bundles are discovered beneath the configured local source root. Each bundle is a directory containing `manifest.json`. diff --git a/examples/fan-out.yml b/examples/fan-out.yml index d60fdb7..27fc304 100644 --- a/examples/fan-out.yml +++ b/examples/fan-out.yml @@ -1,28 +1,18 @@ pipelines: - - id: reports + - id: example-fan-out source: backend: local - path: /var/spool/distributor/reports - validation: - on_digest_mismatch: fail + path: examples/source-bundle destinations: - - id: markdown-archive - backend: s3 - endpoint: https://s3.example.com - bucket: reports - prefix: archive - region: us-east-1 - force_path_style: true - credentials: - access_key_id_env: DISTRIBUTOR_S3_ACCESS_KEY_ID - secret_access_key_env: DISTRIBUTOR_S3_SECRET_ACCESS_KEY + - id: local-source-archive + backend: local + path: workspace/published/fan-out/source publish: source: true html: false - - id: static-site - backend: ssh - uri: ssh://deploy@example.com:22 - path: /srv/www/reports + - id: local-html-site + backend: local + path: workspace/published/fan-out/html publish: source: false html: true