---
title: "Developer tools: documentation site using Django"
description: "A documentation site blueprint for developer tools built with Django on Ample."
canonical_url: "https://ample.computer/blueprints/developer-tools/documentation-site/django"
last_updated: "2026-09-20"
---

# Developer tools: documentation site using Django

Canonical URL: https://ample.computer/blueprints/developer-tools/documentation-site/django
Formats: [HTML](https://ample.computer/blueprints/developer-tools/documentation-site/django) | [Markdown](https://ample.computer/blueprints/developer-tools/documentation-site/django.md) | [JSON contract](https://api.ample.computer/v1/catalog/recipes/page%3Ablueprints%3Adeveloper-tools%3Adocumentation-site%3Adjango)
Recipe ID: `page:blueprints:developer-tools:documentation-site:django` | Revision: `r1` | Catalog revision: `cat_f13ab9a494120b5e`

Status: release `published`, support `verified`, execution `ready`

## Summary

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. API keys and usage logs are secrets or personal data; keep them out of documentation workflows. 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).

Path: [Agent hosting discovery](/discover/discovery) / [Industries and specialties](/discover/industry) / [Software and media](/discover/industry/software-and-media) / [Developer tools](/discover/industry/developer-tools) / [Developer tools: documentation site using Django](/blueprints/developer-tools/documentation-site/django)

## Infrastructure requirements

- [Compute](/discover/primitive/compute): verified (Apps run in isolated x86_64 Firecracker microVMs that auto-pause when idle and wake on request; sizes are the priced VM sizes.)
- [Postgres](/discover/primitive/postgres): verified (Managed PostgreSQL 16 runs in its own microVM and is auto-provisioned when an app needs a database and no DATABASE_URL is supplied.)
- [CDN](/discover/primitive/cdn): verified (The CDN host serves objects from published buckets. It does not front app compute and is not a cache or key-value store.)

## Prerequisites

- 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 create` passed 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

- template: `python-3.12`
- runtime: `python`
- size: `s-1vcpu-1gb`
- install: `python3 -m pip install --target .ample/python -r requirements.txt`
- start: `PYTHONPATH=.ample/python:${PYTHONPATH:-} python3 run.py`

## Steps

1. **Model the developer tools domain.** Create the tables customer_workspaces, doc_versions, sdk_releases, customer_assets, state_transitions. Customer organizations lives 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=...
   ```
7. **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
   ```

## Tested examples

- **Django pattern fixture** (tests/deploy-canaries/django-patterns): Verified relational records basis for this blueprint.

## Success checks

- app responds on its public URL (`/` on the live URL, expect ample canary django patterns)
- relational-records self-test from the example (`/p/relational-records` on the live URL, expect see the pattern fixture checks)


## Cost estimate

Estimated 10.00 USD per month (size prices from pricing.toml at build revision 515b7316fc6e5a81679407ae0c811146ceb2c5c7).
- app server x1 `s-1vcpu-1gb`: 5.00 USD
- managed PostgreSQL database x1 `s-1vcpu-1gb`: 5.00 USD

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

- canary_run on 2026-09-20T03:31:44Z at revision `03b6402b1b3e19178985f08ea4033804521d85d4 (CLI b75e104)`: 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 and were not separately executed. (expires 2027-03-19T03:31:44Z)

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


## Execution binding

MCP tool `ample_deploy` (registry `mcp:ample_deploy`), schema hash `876465fce906da0c` observed 2026-09-22T00:31:22.774679+00:00 at revision `e6446ceea69b`, binding state `current`, required scopes: servers:write, databases:read, buckets:read.

## Input schema

```json
{
  "additionalProperties": false,
  "properties": {
    "env": {
      "description": "Encrypted environment variables",
      "items": {
        "pattern": "^[A-Z][A-Z0-9_]*=.*$",
        "type": "string"
      },
      "maxItems": 50,
      "type": "array"
    },
    "name": {
      "description": "App name",
      "maxLength": 63,
      "minLength": 1,
      "pattern": "^[a-z0-9-]+$",
      "type": "string"
    },
    "path": {
      "description": "Project directory or ample.toml service",
      "maxLength": 512,
      "minLength": 1,
      "type": "string"
    },
    "release_command": {
      "description": "Migration command run before activation",
      "maxLength": 512,
      "type": "string"
    },
    "start": {
      "description": "Start command",
      "maxLength": 512,
      "type": "string"
    }
  },
  "required": [
    "env",
    "name",
    "path",
    "start"
  ],
  "type": "object"
}
```

## Next actions

- Browse the catalog index (GET /v1/catalog on the api origin; auth: false, approval: false)
- Search published recipes by intent, stack and constraints (POST /v1/catalog/search on the api origin; auth: false, approval: false)
- Prepare a side-effect-free deployment plan for an authorized project (POST /v1/catalog/plan on the api origin; auth: true, approval: false)
- Read the existing agent authentication setup (GET /mcp/setup on the api origin; auth: false, approval: false)
- Browse Developer tools (GET /v1/catalog/nodes/industry%3Adeveloper-tools on the api origin; auth: false, approval: false)
- Browse Documentation site (GET /v1/catalog/nodes/workload%3Adocumentation-site on the api origin; auth: false, approval: false)
- Browse Django (GET /v1/catalog/nodes/stack%3Aframework-django on the api origin; auth: false, approval: false)
- Browse Deploy web app (GET /v1/catalog/nodes/intent%3Adeploy-web-app on the api origin; auth: false, approval: false)

Actions describe possible next steps. They are typed data, not commands, and grant no permission.