Docs: Add 12-factor how-to sections for integrations
Metadata
Current evaluation
Merged as 69dd1326, adding database, ingress, and observability integration sections to the 12-factor web-app charm how-to.
Resolution: closed resolved
Reason: PR #2219 was approved and merged into the project as commit 69dd1326. The documentation now includes dedicated integration sections for databases, ingress, and observability.
Evaluated by: mr-cal-bot
No scores available.
Issue body
### Overview
Add three new sections on how to integrate a web app charm with database, ingress, or observability.
Note: These sections are limited in scope to integration only. Eventually we will add content about how to configure ingress and how to use observability (getting the IP address, visiting the Grafana dashboard, viewing logs, etc).
### Summary of changes
1. Move the "In this example" content about integrating with a database to its own dedicated section.
2. Add a new section, "Integrate with ingress"
3. Add a new section, "Integrate with observability"
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged as 69dd1326, adding database, ingress, and observability integration sections to the 12-factor web-app charm how-to. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #2219 added 12-factor integration guidance for databases, ingress, and observability in commit 69dd1326, with 50 additions and 2 deletions. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #2219 added 12-factor how-to sections covering database, ingress, and observability integrations for web app charms. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation update adding three sections on integrating web app charms with databases, ingress, and observability. Approved by three reviewers, the change modifies one file with 50 additions and 2 deletions. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation updates adding three 12-factor how-to sections for integrating web app charms with databases, ingress, and observability. Scope is limited to integration steps, with configuration details planned for future updates. |
Update history
No update history recorded yet.
Related work
-
Related To:
charmcraft#2232
(confidence 99%)
Follow-up PR #2232, merged as 4a6de71a, expanded the observability guidance with Grafana dashboard and application-log usage.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #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. | |
| #2246 docs: add 12-factor troubleshooting section | charmcraft | merged | Merged in charmcraft#2246 via commit a2846b5d, adding 12-factor troubleshooting guidance for Juju, application, and MicroK8s logs and SSH debugging. | |
| #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. | |
| #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. | |
| #2232 docs: Add 12-factor how-to on using observability | charmcraft | merged | Docs PR merged as commit 4a6de71a: adds a "Use observability" how-to (Grafana dashboards, app logs) to the 12-factor app guide, an integrate_web_app_cos section target, and Flask/Django reference updates. | |
| #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. | |
| #2048 docs: add "How to manage 12-factor app charms" | charmcraft | closed | Closed unmerged and superseded by #2083, merged as commit 8732a51a, which completed the remaining Markdown-to-RST documentation conversion. | |
| #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. | |
| #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. |