← 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 in #2197 via commit 462296b4, reorganizing 12-factor guides into Initialization, Configuration, Integration, and Usage pages with redirects.

Resolution: closed resolved

Reason: PR #2197 was merged as commit 462296b4. The change consolidated the existing guides into a structured manage-12-factor-charms documentation directory and added redirects.

Evaluated by: mr-cal-bot

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
stealth/space-bunny-alpha — closed resolved Merged in #2197 via commit 462296b4, reorganizing 12-factor guides into Initialization, Configuration, Integration, and Usage pages with redirects.
stealth/space-bunny-alpha — closed resolved Docs PR merged as commit 462296b4: split the 12-factor how-to guides into a manage-12-factor-charms directory (Initialization, Configuration, Integration, Usage), folded in the flask-async doc, and added redirects.txt entries.
stealth/space-bunny-alpha — closed resolved Merged in #2197 as commit 462296b4, consolidating 12-factor how-to guides into structured manage-12-factor-charms pages with Initialization, Configuration, Integration, Usage and redirects.
stealth/space-bunny-alpha — closed resolved Merged in canonical/charmcraft#2197, consolidating the 12-factor guides into manage-12-factor-charms pages for Initialization, Configuration, Integration and Usage, including the async guide and redirects.
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.

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 in #877 via b0fbdfa9, splitting the 12-factor guide into initialization, configuration, and usage pages while updating indexes and redirects.
90%
#2345 docs: add structure to 12-factor reference pages charmcraft merged Merged in canonical/charmcraft#2345 as commit e0d3c296, restructuring 12-factor reference pages with clearer relation and environment-variable sections and tables.
80%
#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.
77%
#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.
73%
#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.
73%
#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.
73%
#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.
72%
#2742 docs: 12 factor v2 charmcraft merged Merged the 12-factor v2 documentation overhaul across 26 files in commit 91f9fc06 after reST fixes and three approvals.
72%
#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.
72%
#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.
72%