← Back to issue list

docs: 12-Factor tutorial updates

View original Github issue

Metadata

Project
charmcraft
Number
#2263
Type
pull request
State
merged
Author
erinecon
Labels
—
Created
Updated
Closed

Current evaluation

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.

Resolution: closed resolved

Reason: PR #2263 was merged into main as commit 410dcd0b. It implemented five documentation updates requested in issue #2235.

Evaluated by: mr-cal-bot

No scores available.

Issue body

Five updates proposed by @evildmp in https://github.com/canonical/charmcraft/issues/2235 that affect all four of the 12-factor tutorials and the reusable setup scripts. ### Summary of changes * Updated the Multipass install link to point to the correct how-to guide. * Removed explicit mentions of "If you aren't on a host with AMD64 architecture" and the note admonitions around the rock and charm names. This is to help the user build up the muscle memory of the naming and take responsibility for the file names. * Added a brief description of the ``--profile`` flag in the rock and charm creation sections. * (Django tutorial only) Reduced the text in the "We'll need to update the settings.py file..." paragraph, again to help the user build muscle memory of where the file is located. * (Django tutorial only) Rephrased the text about connecting the Django app to PostgreSQL, as that's not what's actually going on at that time. Instead we're adding the PostgreSQL relation endpoint to the charm project file, so the text now reflects that change. In addition to these changes, a warning admonition block about older versions of Charmcraft was removed in the Django tutorial.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved 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.
stealth/space-bunny-alpha — closed resolved Merged as #2263 (410dcd0b), updating all four 12-factor tutorials and shared setup scripts with corrected links, clearer naming, --profile guidance, and revised Django PostgreSQL instructions.
qwen/qwen3.6-35b-a3b — — 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.
qwen3.6-35b-a3b-mtp-q6 — — Merged documentation updates for 12-factor tutorials and setup scripts. Changes fix a broken Multipass link, remove redundant warnings, clarify the --profile flag, simplify Django instructions, and correct PostgreSQL relation descriptions.

Update history

No update history recorded yet.

Related work

  • Likely Fixed By: canonical/charmcraft#2235 (confidence 100%)

    The PR implemented five tutorial and setup-script updates requested by this feedback issue.

Related issues

Issue Project State Summary Similarity
#2276 docs: Updates to the 12-factor tutorials charmcraft merged Docs-only PR merged as commit 5cacee4a, applying six updates from issue #2235 across all four 12-factor tutorials: rock/Juju model intros, 'edit' vs 'open' wording, a charmcraft pack seealso box, and Django notes.
81%
#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.
80%
#2257 Docs: 12-factor tutorial updates charmcraft merged Merged PR #2257 as commit e549afa7, applying six clarity, terminology, and formatting updates across all four 12-factor tutorials.
80%
#2085 docs: update 12-factor tutorials charmcraft merged Merged in #2085 (79fa5ad9), updating 12-factor tutorials to rST, incorporating UX feedback, and standardizing content after #2083.
78%
#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.
77%
#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.
76%
#2352 docs: update 12-factor how-to guide on async apps charmcraft merged Merged as commit 43dc21be, updating the async Flask 12-factor guide to cover Django, clarify app naming, label requirements.txt, and recommend status monitoring.
75%
#2368 docs: Update 12-factor initialization how-to guide charmcraft merged Docs PR #2368 merged as commit fee8f06e: removed the standalone 12-factor init how-to page, folded its content into docs/howto/manage-web-app-charms/index.rst, dropped section structure, and added a redirect in docs/redirects.txt.
74%
#877 docs: Reorganize 12-factor how-to guides rockcraft merged Merged in #877 via b0fbdfa9, splitting the 12-factor guide into initialization, configuration, and usage pages while updating indexes and redirects.
73%
#2445 docs: Incorporate UX feedback into 12-factor tutorials charmcraft merged Merged PR #2445 as commit 787f82c4, updating six 12-factor tutorial files with UX feedback on resources, ingress, configuration, wording, and PostgreSQL setup.
73%