docs: add structure to 12-factor reference pages
Metadata
Current evaluation
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.
Suggested action: —
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 |
|---|---|---|---|---|
| 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation update restructuring 12-factor reference pages. Integrations were renamed to relations, content organized into Relation endpoints and Environment variables sections, and tables added for clarity. Resolves issue #81. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #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. | |
| #1253 docs: Incorporate user feedback in the 12-factor reference pages | rockcraft | merged | Merged documentation updates to the 12-factor reference pages. Incorporates UXR feedback by improving headers, clarifying parts snippets and file inclusion rules, adding links and captions, and fixing acronyms. Approved and passed CI. | |
| #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. | |
| #2241 Docs: Update 12-factor tutorials | charmcraft | merged | Merged documentation updates to the 12-factor tutorials. Changes add UX tips for charmcraft and juju status, update rockcraft output, note faster builds, and condense architecture text. Approved by two reviewers and passed CI. | |
| #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. | |
| #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. | |
| #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. | |
| #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. | |
| #2354 docs: Incorporate UX feedback into 12-factor tutorials | charmcraft | merged | Merged documentation updates to 12-factor tutorials based on UX feedback. Changes include switching code blocks to dropdowns, adding explicit paths, and clarifying MicroK8s and Juju setup. Approved by two reviewers and merged after CI validation. | |
| #2489 docs: add targets to 12-factor sections | charmcraft | merged | Merged documentation update adding intersphinx targets to 12-factor sections. Approved by two reviewers, the change adds 93 lines across 10 files to improve cross-referencing. |