← Back to issue list

docs: update "manage configurations"

View original Github issue

Metadata

Project
charmcraft
Number
#2300
Type
pull request
State
merged
Author
dwilding
Labels
—
Created
Updated
Closed

Current evaluation

Docs PR #2300 merged as commit dc4bedb1: updated Charmcraft links to operator's renamed "Manage configuration" howto and renamed the section heading to "Manage the app configuration" per maintainer request.

Resolution: closed resolved

Reason: PR #2300 was approved by 2 reviewers and merged to main as commit dc4bedb1 (docs: update "manage configurations"). It retargeted links to the renamed operator howto (canonical/operator#1746) and, at medubelko's request, changed the Charmcraft section title to "Manage the app configuration".

Evaluated by: mr-cal-bot

No scores available.

Issue body

In https://github.com/canonical/operator/pull/1746 we renamed [Manage configuration](https://ops.readthedocs.io/en/latest/howto/manage-configuration.html) from "Manage configurations". This PR updates the relevant links in the Charmcraft docs.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Docs PR #2300 merged as commit dc4bedb1: updated Charmcraft links to operator's renamed "Manage configuration" howto and renamed the section heading to "Manage the app configuration" per maintainer request.
stealth/space-bunny-alpha — closed resolved Merged PR #2300 updated Charmcraft links for the singular "Manage configuration" title and renamed its section to "Manage the app configuration."
qwen/qwen3.6-35b-a3b — — Merged after two reviewers approved. Updated Charmcraft documentation links and renamed the section to Manage the app configuration per feedback. All CI checks passed and changes were integrated.
qwen3.6-35b-a3b-mtp-q6 — — Merged documentation update aligning Charmcraft docs with the Operator framework. The section title was changed from Manage configurations to Manage the app configuration per reviewer feedback to maintain consistency with Juju terminology.

Update history

No update history recorded yet.

Related work

  • Related To: operator#1746 (confidence 90%)

    Upstream operator PR that renamed the 'Manage configurations' howto to 'Manage configuration', triggering this docs update.

Related issues

Issue Project State Summary Similarity
#2748 docs: improve charm naming docs, with links to detailed guidance charmcraft merged Docs PR #2748 merged (commit 0389aeb4): rewrote charm naming guidance in the charmcraft.yaml reference and manage-charms how-to, replacing inline best-practice notes with links to the Ops docs. Fixes #2582; relied on canonical/operator#2610.
77%
#2274 docs: fix typo in 'manage 12-factor app charm' charmcraft merged Merged PR #2274 as commit 917d32c6, correcting a typo in the "manage 12-factor app charm" documentation.
73%
#2010 docs: add, refactor, and reformat discourse docs feat. charmcraft charmcraft merged Merged PR #2010 as commit a1a3d4b1, migrating Charmcraft content to RTD-ready docs, reformatting it, and separating Ops-related material.
72%
#2262 docs: hotfix for links syntax for charm docs examples charmcraft merged Merged PR #2262 as commit 675e5e7e, fixing links in the Manage charms docs and adding a Charmhub Discourse link.
72%
#2824 docs: Update documentation to add link to HTTP proxy configurator tutorial charmcraft merged Merged charmcraft#2824 adds Canonical's HTTP proxy configurator tutorial link to the web-app charm integration guide; all CI checks passed.
71%
#2038 docs: prepare 3.3 changelog charmcraft merged Merged documentation preparing Charmcraft's 3.3 changelog in PR #2038 (commit 5037fcb1), updating four files with 48 additions and 10 deletions.
71%
#2128 docs: add anchors and fix a few small things charmcraft merged Docs PR merged as commit e880b4bd: added intersphinx anchors (e.g. _manage-charms, _initialise-a-charm) for Ops/Juju linking, retitled 'Set up Charmcraft' to 'Manage Charmcraft', expanded content, and fixed a rendering error.
71%
#2240 docs: update charm definition in security doc charmcraft merged Merged PR #2240 updated SECURITY.md’s charm definition after review of #2237, resolving documentation feedback in commit c7f258db.
71%
#471 config: add charm part to documentation (CRAFT-356) charmcraft merged Merged PR #471 via commit e0b18661, documenting the charm part in the configuration schema for CRAFT-356.
71%
#2299 docs: fix formatting issues charmcraft merged Merged docs formatting fixes for local documentation builds in charmcraft#2299 via commit 5ffb80fe; two files changed (+3/-1).
71%