← Back to issue list

docs: Reorganize 12-factor how-to guides

View original Github issue

Metadata

Project
rockcraft
Number
#877
Type
pull request
State
merged
Author
erinecon
Labels
—
Created
Updated
Closed

Current evaluation

Merged in #877 via b0fbdfa9, splitting the 12-factor guide into initialization, configuration, and usage pages while updating indexes and redirects.

Resolution: closed resolved

Reason: PR #877 was merged into main as commit b0fbdfa9, completing the documentation reorganization after approval.

Evaluated by: mr-cal-bot

No scores available.

Issue body

In preparation for adding more how-to guides specific to the 12-factor tooling, this PR reorganizes the current 12-factor how-to guides. ### Summary of changes * A new folder, `how-to/manage-web-app-rock`, was added. * The original 12-factor file, `how-to/build-a-12-factor-app-rock.rst`, was split into two under the `how-to/manage-web-app-rock` directory: `configure-web-app-rock.rst` and `use-web-app-rock.rst`. The main how-to index page was updated, and a relevant redirect was added. * A new 12-factor file, `how-to/manage-web-app-rock/init-web-app-rock.rst`, was created. This is to complete the full story of initialization-configuration-usage. - [X] Have you followed the guidelines for contributing? - [X] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)? - [ ] Have you successfully run `make lint && make test`? --- I successfully ran `make lint-docs`. I am not contributing a code change (although, for completeness, I ran `make lint && make test` and the commands failed).

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Merged in #877 via b0fbdfa9, splitting the 12-factor guide into initialization, configuration, and usage pages while updating indexes and redirects.
stealth/space-bunny-alpha — closed resolved Merged in canonical/rockcraft#877: split the 12-factor how-to into initialization, configuration, and usage guides, with index and redirect updates.
qwen/qwen3.6-35b-a3b — — 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.
qwen3.6-35b-a3b-mtp-q6 — — Merged documentation update reorganizing 12-factor how-to guides. The original guide was split into init, configure, and use steps under a new manage-web-app-rock directory. Index pages were updated and redirects added to preserve navigation.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#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.
90%
#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.
79%
#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.
77%
#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.
76%
#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.
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.
73%
#893 docs: Incorporate UX feedback into 12-factor tutorials rockcraft merged Merged as 9a40a4a3, updating 12-factor tutorials with clearer skopeo guidance, file headers, and corrected Express and Spring Boot setup instructions.
73%
#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.
73%
#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.
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%