← Back to issue list

docs: Add structure to 12-factor how-to guides

View original Github issue

Metadata

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

Current evaluation

Merged following two reviewer approvals. Consolidated 12-factor how-to guides into a structured manage-12-factor-charms directory with categories and redirects. Required squashing commits and force-pushing to pass the merge queue.

Suggested action:

No scores available.

Issue body

Currently the 12-factor how-to guides were split into two documents: one for the async configuration, and another containing all other how-to sections. This pull request consolidates the two documents into a directory, `manage-12-factor-charms`, with added structure by splitting up the sections into separate pages. ### Summary of changes * Created `manage-12-factor-charms` directory with an index page and four different categories: Initialization, Configuration, Integration, and Usage * Consolidated the flask-async document into the Configuration category * Added redirects Additional reviewers: @jdkandersson

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.6-35b-a3b Merged following two reviewer approvals. Consolidated 12-factor how-to guides into a structured manage-12-factor-charms directory with categories and redirects. Required squashing commits and force-pushing to pass the merge queue.
qwen3.6-35b-a3b-mtp-q6 Merged after the author squashed commits and force-pushed per reviewer request. Consolidated two 12-factor how-to guides into a structured manage-12-factor-charms directory with categorized pages and updated redirects.
qwen3.6-35b-a3b-mtp-q6 Merged after the author squashed commits and force-pushed. Consolidated 12-factor how-to guides into a structured manage-12-factor-charms directory with four categories and updated redirects.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#877 docs: Reorganize 12-factor how-to guides rockcraft merged Merged documentation reorganization splitting the 12-factor how-to guide into initialization, configuration, and usage files under a new directory. Updated index and added redirect. Approved by two reviewers and merged after passing doc lint.
82%
#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.
75%
#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.
74%
#2345 docs: add structure to 12-factor reference pages charmcraft merged Merged documentation update restructuring the 12-factor reference pages. Changes rename sections to Relation endpoints and Environment variables, add tables, and align terminology with Juju guidelines. Approved and merged.
74%
#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.
73%
#2219 Docs: Add 12-factor how-to sections for integrations charmcraft merged Merged documentation update adding three sections on integrating web app charms with databases, ingress, and observability. Approved by three reviewers, the change modifies one file with 50 additions and 2 deletions.
72%
#2085 docs: update 12-factor tutorials charmcraft merged Merged after converting the 12-factor tutorials to reStructuredText and incorporating UX feedback. Conflicts with PR #2083 were resolved via maintainer coordination before finalizing the merge.
72%
#2193 Docs: Maintenance work on 12-factor tutorials charmcraft merged Merged documentation maintenance for 12-factor tutorials. Updates rename files for shorter URLs, fix code highlighting, revise instructions, and standardize terminology for consistency and accessibility. Approved by two reviewers.
72%
#918 docs: Incorporate UX feedback into 12-factor tutorials rockcraft merged Merged documentation updates to the 12-factor tutorials incorporating UX feedback. Changes clarify architecture, update multi-arch commands, refine terminology, and adjust setup. Approved by three reviewers and merged.
72%
#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.
71%