docs: update 12-factor how-to guide on async apps
Metadata
Current evaluation
Merged as commit 43dc21be, updating the async Flask 12-factor guide to cover Django, clarify app naming, label requirements.txt, and recommend status monitoring.
Resolution: closed resolved
Reason: PR canonical/charmcraft#2352 was approved and merged into main as commit 43dc21be, completing the documentation maintenance requested by ISD-3593.
Evaluated by: mr-cal-bot
No scores available.
Issue body
Relevant ticket: ISD-3593
Maintenance work on the how-to guide "Write a Kubernetes charm for an async Flask app".
### Summary of work
* Add a note admonition that the guide also applies to Django apps.
* Add a caption to the `requirements.txt` file included in the guide.
* Add in the assumption that the app name is `flask-async-app`.
* Originally, we had the suggestion to add `juju status` output to the guide. Since the configuration is not represented in the `juju status` table, I decided it wasn't worth adding in. However, I did add a suggestion to monitor the app status while waiting for the configuration to take effect.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged as commit 43dc21be, updating the async Flask 12-factor guide to cover Django, clarify app naming, label requirements.txt, and recommend status monitoring. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged in #2352 (43dc21be), updating the async Flask guide to cover Django, label requirements.txt, assume flask-async-app, and recommend monitoring app status. | |
| stealth/space-bunny-alpha | — | closed resolved | Docs-only PR merged as commit 43dc21be: the 12-factor async Flask how-to guide now notes it also applies to Django, captions requirements.txt, assumes the app name flask-async-app, and suggests monitoring app status. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged in #2352 as commit 43dc21be: the async Flask guide now notes Django applicability, labels requirements.txt, assumes flask-async-app, and recommends monitoring app status. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation update to the 12-factor async apps guide. Changes add a Django compatibility note, requirements.txt caption, assumed app name, and adjusted juju monitoring advice. Approved by two reviewers and passed CI checks. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation updates to the 12-factor async app how-to guide. Added a Django compatibility note, requirements.txt caption, standardized app name, and a monitoring tip replacing the original juju status suggestion. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #735 Update 12-factor docs | rockcraft | merged | Merged in canonical/rockcraft#735, adding a 12-factor app rock guide, updating Flask/Django/FastAPI references, revising tutorials, and refreshing documentation dependencies. | |
| #2263 docs: 12-Factor tutorial updates | charmcraft | merged | Merged PR #2263 as commit 410dcd0b, updating all four 12-factor tutorials and shared setup scripts with clearer naming, corrected links, --profile guidance, and revised Django instructions. | |
| #2721 fix(docs): auto-sync framework versions to 12-factor tutorials | charmcraft | merged | Merged in PR #2721 (commit ad3588c6), automatically syncing Django, Flask, and FastAPI versions into the 12-factor tutorials. | |
| #2220 docs: 12-factor tutorial maintenance | charmcraft | merged | Merged canonical/charmcraft#2220, updating four 12-factor tutorials with numbered task lists, tilde-prefixed paths, full-path captions, and consistent app.py naming. | |
| #2232 docs: Add 12-factor how-to on using observability | charmcraft | merged | Docs PR merged as commit 4a6de71a: adds a "Use observability" how-to (Grafana dashboards, app logs) to the 12-factor app guide, an integrate_web_app_cos section target, and Flask/Django reference updates. |