← Back to issue list

docs: 12-factor tutorial maintenance

View original Github issue

Metadata

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

Current evaluation

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.

Suggested action:

No scores available.

Issue body

### Overview Mostly directory-related maintenance work spanning across all four 12-factor tutorials. ### Summary of changes * The "What you'll do" sections are now numbered lists. * Any mention of the root directory (e.g., `/django-hello-world`) now contains a tilde in front (e.g., `~/django-hello-world`). * Captions on full code examples now contain captions with explicit reference to the full path (e.g., `app.py` is now `~/flask-hello-world/app.py`). This change did not affect snippets of YAML files, which contain no caption whatsoever. * Some mentions of `visitors_app.py` were renamed to `app.py` as the `visitors_app.py` naming was due to the multiple Python files needed for the spread tests.

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.6-35b-a3b 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.
qwen3.6-35b-a3b-mtp-q6 Merged documentation maintenance for the 12-factor tutorials. Updates include numbering what-you-will-do sections, prefixing root paths with tildes, updating code captions to show full paths, and renaming visitors_app.py to app.py.
qwen3.6-35b-a3b-mtp-q6 Merged documentation maintenance for the 12-factor tutorials. Updates include numbered what-you-will-do sections, tildes for root directory paths, explicit paths in code captions, and renaming visitors_app.py to app.py.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#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.
85%
#2257 Docs: 12-factor tutorial updates charmcraft merged Merged documentation updates for the 12-factor tutorials. Changes clarify architecture instructions, fix Django tutorial terminology, convert admonitions to paragraphs, and correct variable formatting. Approved by reviewers and merged.
81%
#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.
79%
#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.
78%
#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.
78%
#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.
78%
#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.
78%
#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.
78%
#2425 docs: Incorporate UX feedback into 12-factor tutorials charmcraft merged Merged documentation updates to the 12-factor tutorials based on UX feedback. Changes include reordered setup steps, improved upload phrasing, added command blocks, and updated next steps links. Approved and passed CI.
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.
77%