← Back to issue list

docs: Updates to the 12-factor tutorials

View original Github issue

Metadata

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

Current evaluation

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.

Resolution: closed resolved

Reason: PR #2276 was approved (medubelko gave LGTM pending lengau) and merged into main as commit 5cacee4a, changing 4 doc files (+74/-21). It delivered six of the doc improvements requested in issue #2235, which was later closed as complete by the remaining sibling PRs.

Evaluated by: mr-cal-bot

No scores available.

Issue body

Six updates proposed by @evildmp in https://github.com/canonical/charmcraft/issues/2235 that affect all four of the 12-factor tutorials. ### Summary of changes * Added a brief explanation of a rock at the beginning of the rock sections. * (Django tutorial) Before packing the rock, added a note that explains that the user can no longer run or test the app locally due to the changes we made in preparing the app for a PostgreSQL database. * (FastAPI and Go tutorials) Changed some instances of the mechanical instruction "open" to a functional action "edit" for updating the `charmcraft.yaml` file. This also establishes consistency with the corresponding rock sections. * Added a `seealso` box to `charmcraft pack` to provide more context to the user. * Added a brief explanation of a Juju model at the beginning of the deploy section. * (Django tutorial) When setting the `django-debug` configuration, added more information in the note admonition that this configuration sets an environment variable in the Django app. This gives the user a way to connect the Juju-specific command with a familiar concept.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved 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.
stealth/space-bunny-alpha — closed resolved Merged in #2276 via commit 5cacee4a, applying six documentation updates from #2235 across all four 12-factor tutorials.
qwen/qwen3.6-35b-a3b — — 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.
qwen3.6-35b-a3b-mtp-q6 — — Merged documentation updates to four 12-factor tutorials. Changes add rock and Juju model explanations, update instructions for consistency, include a charmcraft pack seealso box, and clarify Django config notes. Approved and merged.

Update history

No update history recorded yet.

Related work

  • Related To: canonical/charmcraft#2235 (confidence 97%)

    Source issue 'Feedback on the Django tutorial' listing the six documentation updates this PR implements; it was closed as complete.

  • Related To: canonical/charmcraft#2241 (confidence 80%)

    Sibling 12-factor tutorial docs PR (commit acf5d293) from the same #2235 feedback batch.

  • Related To: canonical/charmcraft#2251 (confidence 80%)

    Sibling 'Updated 12-factor tutorials' PR (commit 592d93aa) from the same #2235 feedback batch.

  • Related To: canonical/charmcraft#2257 (confidence 75%)

    Sibling 12-factor tutorial docs PR (commit e549afa7) from the same feedback effort.

  • Related To: canonical/charmcraft#2263 (confidence 75%)

    Sibling '12-Factor tutorial updates' PR (commit 410dcd0b) from the same feedback effort.

  • Related To: canonical/charmcraft#2282 (confidence 70%)

    Follow-on 'Updates to the 12-factor tutorials' PR (commit 2199bc08) continuing the same doc improvements.

Related issues

Issue Project State Summary Similarity
#2241 Docs: Update 12-factor tutorials charmcraft merged Merged as commit acf5d293 ("Docs: Update 12-factor tutorials", #2241), updating all four tutorials with a charmcraft expand-extensions tip, juju status tip, generic arch output, and faster repacking notes.
84%
#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.
81%
#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.
81%
#2282 docs: Updates to the 12-factor tutorials charmcraft merged Merged PR #2282 as commit 2199bc08, updating four 12-factor tutorials with Rockcraft context, expanded Skopeo guidance, and clearer MicroK8s registry wording.
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%
#2193 Docs: Maintenance work on 12-factor tutorials charmcraft merged Merged in canonical/charmcraft#2193 via commit ecd6b411, shortening 12-factor tutorial URLs, fixing code-block highlighting, and standardizing terminology across four tutorials.
80%
#2425 docs: Incorporate UX feedback into 12-factor tutorials charmcraft merged Merged docs PR applying UX-session feedback to the 12-factor tutorials (commit 17ce91b5, 8 files, +349/-207): reordered rockcraft.yaml arch steps, reworded rock upload, code-blocked curl/config commands, and refreshed next-step links.
78%
#2251 Docs: Updated 12-factor tutorials charmcraft merged Merged as canonical/charmcraft#2251 (commit 592d93aa), updating 12-factor setup instructions to use Rockcraft latest/edge, simplify file creation, and remove outdated warnings and wording.
78%
#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%
#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%