Update 12-factor docs
Metadata
Current evaluation
Merged documentation update migrating 12-factor Charm SDK guides to Rockcraft. Revised tutorial language and updated dev requirements to fix a failing security test. Approved by three reviewers and successfully integrated.
Suggested action: —
No scores available.
Issue body
- [X] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
-----
Major changes:
- **Migrated some Charm SDK docs to Rockcraft**: Created a how-to guide "How to build a 12-Factor app rock" that contains the rock-related sections currently in the [corresponding Charm SDK how-to guide](https://juju.is/docs/sdk/build-a-12-factor-app-charm). Migrated information on the Charm SDK reference pages for the Rockcraft extensions ([Flask](https://juju.is/docs/sdk/rockcraft-extension-flask-framework), [Django](https://juju.is/docs/sdk/rockcraft-extension-django-framework), [FastAPI](https://juju.is/docs/sdk/rockcraft-extension-fastapi-framework)).
- **Language changes to the tutorials**: Based on the [discussion](https://github.com/canonical/rockcraft/pull/723#discussion_r1793550048) in the PR to add the Go docs, I updated the language in the three tutorials to remove "you" entirely and replace with either "we" or imperative language.
- **Other**: A security test was failing in my forked repo, so I updated `requirements-dev.txt` and `requirements-doc.txt`. I mention it here because I don't know whether that was the correct solution or best practice (forgive me, I'm more of a technical author than software engineer).
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation update migrating 12-factor Charm SDK guides to Rockcraft. Revised tutorial language and updated dev requirements to fix a failing security test. Approved by three reviewers and successfully integrated. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged. Documentation updated to migrate Charm SDK content to Rockcraft, standardize tutorial language, and resolve a failing security test by updating development dependencies. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation update migrating Charm SDK 12-factor guides to Rockcraft, standardizing tutorial language, and fixing a failing security test by updating dependency files. Changes were reviewed and integrated. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #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. | |
| #2251 Docs: Updated 12-factor tutorials | charmcraft | merged | Merged documentation updates for the 12-factor tutorials. Changes include switching to the latest Rockcraft edge channel, removing outdated warnings, simplifying file creation, and refining wording across six files. Approved and merged. | |
| #2282 docs: Updates to the 12-factor tutorials | charmcraft | merged | Merged documentation updates to the 12-factor tutorials and task files. Changes include added rockcraft admonitions, clarified skopeo copy options, and updated the MicroK8s registry description. Approved 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. | |
| #1006 docs: Incorporate UX feedback into 12-factor tutorials | rockcraft | merged | Merged documentation updates to the 12-factor tutorials incorporating UX feedback. Changes clarify VM shell instructions, terminal closing steps, and rockcraft version warnings. Approved by two reviewers and passed CI checks. |