← 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 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.

Suggested action:

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
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.
qwen3.6-35b-a3b-mtp-q6 Merged documentation reorganization of 12-factor how-to guides. The original guide was split into configuration and usage files, with a new initialization guide added under the manage-web-app-rock directory. Index and redirects updated.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#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.
86%
#2197 docs: Add structure to 12-factor how-to guides charmcraft merged 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.
82%
#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.
80%
#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.
80%
#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.
78%
#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.
77%
#2455 docs: Incorporate UX feedback into 12-factor tutorials charmcraft merged Merged documentation updates to the 12-factor tutorials incorporating UX feedback. Changes refine directory phrasing, remove explicit cd commands, and relocate code comments to main text. Approved by two reviewers and merged.
77%
#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.
77%
#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.
76%
#956 docs: Incorporate UX feedback into 12-factor tutorials rockcraft merged Merged documentation updates to 12-factor tutorials incorporating UX feedback. Corrects browser instructions, reorganizes commands, adds experimental extension variables, updates next steps, and adds intersphinx links. Approved by two reviewers and passed CI.
76%