django.md

Publishing: documentation site using Django

Summary

A documentation site blueprint for publishing built with Django on Ample. Domain schema: titles (isbn_or_slug, title, author, imprint, published_at): the catalog of titles; editions (title_id, format, version, object_key): editions and versioned files; customer_workspaces (name, license_type, seat_count): institutional or trade customers; customer_assets (workspace_id, title_id, object_key, license_expires_at): licensed files per customer; state_transitions (record_type, from_state, to_state): the allowed state machine. Public information: title catalog and author pages, release schedules, rights and permissions contact. Kept out of scope until handling is reviewed: unreleased manuscripts, royalty statements, customer license keys. Manuscripts and royalty data are confidential; licensed files are authorized per customer workspace. Technical basis verified on Django: a workspace-scoped table, an explicit state machine (draft to review to published) that rejects invalid transitions, and a cross-workspace read that returns nothing (transitions=true isolation=true).

Infrastructure requirements

Prerequisites

Exact tested configuration

Steps

  1. Model the publishing domain. Create the tables titles, editions, customer_workspaces, customer_assets, state_transitions. The catalog of titles lives in titles; keep the sensitive classes (unreleased manuscripts, royalty statements, customer license keys) out of this schema.

  2. Workflow step 1. Model versioned documents with a state machine (draft, review, published) scoped to a product version.

  3. Workflow step 2. Publish assets for released versions to the CDN bucket.

  4. Workflow step 3. Serve only published versions publicly.

  5. Workflow step 4. Deploy and verify the version list and a published page.

  6. Deploy. Run the synchronous deploy once and read the result. Re-running with no change is a no-op.

    ample deploy . --name <app-name> --public --start "python3 run.py" --env S3_ENDPOINT=... --env S3_REGION=... --env S3_BUCKET=... --env S3_ACCESS_KEY_ID=... --env S3_SECRET_ACCESS_KEY=... --env CDN_PUBLIC_URL=...
    
  7. Verify. Run the pattern self-test(s) from the example (/p/relational-records) and your own acceptance checks for the publishing workflow.

    ample logs <deployment_id> --kind build
    

Tested examples

Success checks

Limitations

Cost estimate

Estimated 10.00 USD per month (size prices from pricing.toml at build revision a1b8c38919e59cd035ebabaced73cf84ece24371).

Always-on monthly price of the tested sizes; apps and databases auto-pause when idle. Buckets are allocation-priced per quota and not included.

Verification evidence

Last verified: 2026-09-20T03:31:44Z

Execution binding

MCP tool ample_deploy (registry mcp:ample_deploy), schema hash 876465fce906da0c observed 2026-09-21T03:19:59.461917+00:00 at revision 49962bcade4f, binding state current, required scopes: servers:write, databases:read, buckets:read.