docs: add structure to 12-factor reference pages
Metadata
Current evaluation
Merged in canonical/charmcraft#2345 as commit e0d3c296, restructuring 12-factor reference pages with clearer relation and environment-variable sections and tables.
Resolution: closed resolved
Reason: PR canonical/charmcraft#2345 was merged to main as commit e0d3c296, adding structured sections and tables for relation endpoints and environment variables.
Evaluated by: mr-cal-bot
No scores available.
Issue body
Add structure in the reference pages to better organize the content surrounding relation endpoints and environment variables. Pointed out in the issue https://github.com/canonical/paas-charm/issues/81
### Summary of changes
* Changed some references of "integrations" to "relations" to follow the guidance from the Juju team
* Renamed the section "``peers``, ``provides``, and ``requires`` keys" to "Relation endpoints". Added a subsection "Environment variables".
* Added tables to organize the relations, endpoint definitions, and environment variables.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged in canonical/charmcraft#2345 as commit e0d3c296, restructuring 12-factor reference pages with clearer relation and environment-variable sections and tables. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged to main as commit e0d3c296: restructured 12-factor reference docs, renaming "integrations" to "relations", renaming the peers/provides/requires section to "Relation endpoints" with a new "Environment variables" subsection and added tables. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged in canonical/charmcraft#2345 as commit e0d3c296, restructuring 12-factor reference pages with clearer relation and environment-variable sections and tables. | |
| qwen/qwen3.6-35b-a3b | — | — | 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation update restructuring 12-factor reference pages. Aligns terminology with Juju guidelines, renames sections to Relation endpoints and Environment variables, and adds tables to organize relation definitions and environment variables. |
Update history
No update history recorded yet.
Related work
-
Related To:
paas-charm#81
(confidence 98%)
The PR description identifies this issue as the source of the documentation improvements.
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. | |
| #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. | |
| #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. | |
| #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. | |
| #2732 docs: Update 12-factor Spread tests | charmcraft | merged | Merged as 14284182 (canonical/charmcraft#2732), updating 12-factor Spread test documentation with typo fixes and removal of outdated material. | |
| #2251 Docs: Updated 12-factor tutorials | charmcraft | merged | Merged as canonical/charmcraft#2251 (commit 592d93aa), updating 12-factor setup instructions to use Rockcraft latest/edge, simplify file creation, and remove outdated warnings and wording. | |
| #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. | |
| #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. | |
| #2241 Docs: Update 12-factor tutorials | charmcraft | merged | Merged as commit acf5d293 ("Docs: Update 12-factor tutorials", #2241), updating all four tutorials with a charmcraft expand-extensions tip, juju status tip, generic arch output, and faster repacking notes. | |
| #1253 docs: Incorporate user feedback in the 12-factor reference pages | rockcraft | merged | Docs PR #1253 merged as commit 176cba44 into rockcraft main, applying UXR feedback to 12-factor reference pages (headings, parts snippets, include/exclude guidance, captions, acronym clarifications). |