Developer tools: documentation site using Django · Ample Computer

Developer tools: documentation site using Django

A documentation site blueprint for developer tools built with Django on Ample. Domain schema:
customer_workspaces (name, plan, api_key_count): customer organizations;
doc_versions (product_version, title, object_key, published_at): versioned reference docs and guides;
sdk_releases (language, version, changelog_object_key, released_at): SDK releases and changelogs;
customer_assets (workspace_id, title, object_key, visibility): customer-specific artifacts;
state_transitions (record_type, from_state, to_state): the allowed state machine.
Public information: versioned API reference and guides, SDK release notes, status page links.
Kept out of scope until handling is reviewed: customer API keys and usage logs, private integration details.
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).

What it runs on

You need

Exact tested configuration

installpython3 -m pip install --target .ample/python -r requirements.txt

runtimepython

sizes-1vcpu-1gb

startPYTHONPATH=.ample/python:${PYTHONPATH:-} python3 run.py

templatepython-3.12

Steps

  1. Model the developer tools domain. Create the tables customer_workspaces, doc_versions, sdk_releases, customer_assets, state_transitions. Customer organizations live in customer_workspaces; keep the sensitive classes (customer API keys and usage logs, private integration details) 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=...  
  1. Verify. Run the pattern self-test(s) from the example (/p/relational-records) and your own acceptance checks for the developer tools workflow.
   $ ample logs <deployment_id> --kind build  

How it was checked

✓ app responds on its public URL · http get/ → “ample canary django patterns”
✓ relational-records self-test from the example · http get/p/relational-records → “see the pattern fixture checks”

Evidence

  1. November 6, 2026 · canary run
    Django pattern fixture deployed on Ample (pip install into .ample/python from requirements.txt, then waitress serving project.wsgi from run.py reading PORT on the python-3.12 template); the relational records checks passed: 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). The blueprint's Developer tools schema and workflow below build on that verified basis.

Tested examples

What it doesn’t cover