← Back to issue list

docs: Update 12-factor initialization how-to guide

View original Github issue

Metadata

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

Current evaluation

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.

Resolution: closed resolved

Reason: The PR was merged to main as commit fee8f06e ("docs: Update 12-factor initialization how-to guide"). Its changes are present in the tree: docs/redirects.txt maps the removed "howto/manage-web-app-charms/init-web-app-charm.rst" to "howto/manage-web-app-charms/index.rst". Reviewer @medubelko approved it on 2025-07-10, noting the only failing check (lint / files) was unrelated Ruff noise.

Evaluated by: mr-cal-bot

No scores available.

Issue body

Update the 12-factor initialization how-to guide based on user feedback. ### Summary of changes * Remove the dedicated initialization page; add contain to main "how to manage" page. * Remove the section structure to demote the rock initialization as a prerequisite. * Update the redirects file.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved 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.
stealth/space-bunny-alpha — closed resolved Merged #2368 (fee8f06e), consolidating 12-factor initialization guidance into the main management page, removing the dedicated page, and updating redirects.
qwen/qwen3.6-35b-a3b — — 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.
qwen3.6-35b-a3b-mtp-q6 — — Merged docs update consolidating the 12-factor initialization guide into the main management page, removing its dedicated section, and updating redirects. Approved and merged despite unrelated Ruff linting errors.

Update history

No update history recorded yet.

Related work

  • Related To: charmcraft#2387 (confidence 45%)

    Follow-on 12-factor docs UX-feedback series (commit 6368b845) continuing the same how-to restructure shortly after this PR.

  • Related To: charmcraft#2742 (confidence 30%)

    Much later 12-factor V2 docs rewrite (commit 91f9fc06) that supersedes this page structure for the V2 contract.

Related issues

Issue Project State Summary Similarity
#2326 docs: Update 12-factor how-to landing page charmcraft merged Merged in charmcraft#2326 via commit 706e0dba, adding context to the 12-factor how-to landing page for ISD-3595.
80%
#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.
79%
#2197 docs: Add structure to 12-factor how-to guides charmcraft merged Merged in #2197 via commit 462296b4, reorganizing 12-factor guides into Initialization, Configuration, Integration, and Usage pages with redirects.
77%
#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.
76%
#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.
76%
#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.
75%
#2219 Docs: Add 12-factor how-to sections for integrations charmcraft merged Merged as 69dd1326, adding database, ingress, and observability integration sections to the 12-factor web-app charm how-to.
75%
#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.
75%
#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.
74%
#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.
74%