docs: update 12-factor how-to guide on async apps
Metadata
Current evaluation
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.
Suggested action: —
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 |
|---|---|---|---|---|
| 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation update to the 12-factor async app how-to guide. Changes include a Django compatibility note, requirements.txt caption, explicit app name assumption, and a monitoring suggestion replacing the original juju status output recommendation. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #2246 docs: add 12-factor troubleshooting section | charmcraft | merged | Merged. Adds a 12-factor app troubleshooting section covering log access for Juju, application, and MicroK8s, plus SSH debugging into Juju containers. Approved by two reviewers and passed CI checks. | |
| #2276 docs: Updates to the 12-factor tutorials | charmcraft | merged | Merged documentation updates across four 12-factor tutorials. Changes add rock and Juju model explanations, standardize instructional wording, and include context notes. Approved by reviewers and integrated. | |
| #2220 docs: 12-factor tutorial maintenance | charmcraft | merged | Merged documentation maintenance for 12-factor tutorials. Changes include numbered task lists, tildes for root directories, explicit paths in captions, and renaming visitors_app.py to app.py. Approved by two reviewers with passing CI. | |
| #2257 Docs: 12-factor tutorial updates | charmcraft | merged | Merged documentation updates for the 12-factor tutorials. Changes clarify architecture instructions, fix Django tutorial terminology, convert admonitions to paragraphs, and correct variable formatting. Approved by reviewers and merged. | |
| #2263 docs: 12-Factor tutorial updates | charmcraft | merged | Merged documentation updates for 12-Factor tutorials and setup scripts. Fixes Multipass link, removes outdated notes, clarifies --profile flag, simplifies text, and corrects Django PostgreSQL relation description. Approved by two reviewers. | |
| #2368 docs: Update 12-factor initialization how-to guide | charmcraft | merged | Merged documentation update consolidating the 12-factor initialization guide into the main how-to page, removing dedicated sections, and updating redirects. Approved by reviewers with CI lint errors dismissed as unrelated to the docs. | |
| #2326 docs: Update 12-factor how-to landing page | charmcraft | merged | Merged documentation update to the 12-factor how-to landing page, adding context to the guides. Approved by two reviewers and rebased to the hotfix/3.5 branch before successful merge. | |
| #2241 Docs: Update 12-factor tutorials | charmcraft | merged | Merged documentation updates to the 12-factor tutorials. Changes add UX tips for charmcraft and juju status, update rockcraft output, note faster builds, and condense architecture text. Approved by two reviewers and passed CI. | |
| #2721 fix(docs): auto-sync framework versions to 12-factor tutorials | charmcraft | merged | Merged automated syncing of Django, Flask, and FastAPI versions to 12-factor tutorials, removing manual maintenance. Approved after passing all CI checks, implementing follow-up to PR #2703. |