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
Computeverified
Apps run in isolated x86_64 Firecracker microVMs; sizes are the priced VM sizes.Postgresverified
Managed PostgreSQL 16 with pgvector runs in its own microVM and is auto-provisioned when an app needs a database and no DATABASE_URL is supplied.CDNverified
A published bucket's objects are served from its public URL; set Cache-Control when uploading to control caching. App responses are served by the app.
You need
A Django project (pip install into .ample/python from requirements.txt, then waitress serving project.wsgi from run.py reading PORT on the python-3.12 template)
A PostgreSQL driver reading DATABASE_URL (auto-provisioned when omitted)
Bucket credentials from
ample bucket createpassed as encrypted S3_* environment variables and a published bucket for public assets (CDN_*)A review of which developer tools data classes may be handled at all; this blueprint models public information only
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
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.
Workflow step 1. Model versioned documents with a state machine (draft, review, published) scoped to a product version.
Workflow step 2. Publish assets for released versions to the CDN bucket.
Workflow step 3. Serve only published versions publicly.
Workflow step 4. Deploy and verify the version list and a published page.
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=...
- 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
- 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
- Django pattern fixture. Verified relational records basis for this blueprint.
What it doesn’t cover
- The technical basis (relational records on Django) was verified with the pattern fixture; the developer tools schema and workflow are an original design for this blueprint, built on that basis.
- API keys and usage logs are secrets or personal data; keep them out of documentation workflows.
- Verified on the python-3.12 template at s-1vcpu-1gb.
- Managed PostgreSQL 16 with pgvector.
- Buckets speak the standard S3 API (PutObject and GetObject with path-style addressing are checked by the fixture);
ample bucket upload-urlreturns presigned upload URLs.