fix(templates): update out-of-date parts in template README files
Metadata
Current evaluation
Merged PR #2351 (commit 368b5382), updating Kubernetes and machine template READMEs with current config names, dynamic package names, and Juju documentation links.
Resolution: closed resolved
Reason: PR #2351 was merged as commit 368b5382, resolving the outdated template README content.
Evaluated by: mr-cal-bot
No scores available.
Issue body
Inspired by https://github.com/canonical/charmcraft/pull/2350, this PR makes some fixes in the template README files for the `kubernetes` and `machine` profiles.
Fixes:
- Talk about `charmcraft.yaml` instead of `metadata.yaml`
- Use the (dynamic) charm name for the package name instead of `operator-template`
- Replace links to https://juju.is/docs/sdk by https://documentation.ubuntu.com/juju/3.6/howto/manage-charms/
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #2351 (commit 368b5382), updating Kubernetes and machine template READMEs with current config names, dynamic package names, and Juju documentation links. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged #2351 (commit 368b5382), updating Kubernetes and machine template READMEs to use charmcraft.yaml, dynamic charm names, and current Juju documentation links. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #2351 (commit 368b5382), updating kubernetes and machine template READMEs to use charmcraft.yaml, dynamic package names, and current Juju documentation links. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged update to kubernetes and machine template README files. Replaced metadata.yaml with charmcraft.yaml, updated package naming, and fixed documentation links. Approved by three reviewers and merged. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged update to kubernetes and machine template READMEs. Replaced metadata.yaml with charmcraft.yaml, updated package name placeholders, and redirected Juju SDK links to current Ubuntu documentation. |
Update history
No update history recorded yet.
Related work
-
Related To:
canonical/charmcraft#2350
(confidence 100%)
PR #2350 updated similar outdated Juju documentation links and inspired #2351.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #2350 docs: fix broken link to Juju docs in template CONTRIBUTING.md | charmcraft | merged | Merged PR #2350 updated two obsolete Juju development-setup links in the template CONTRIBUTING.md to their current documentation equivalents. | |
| #2753 docs: update urls and doc string in kubernetes and machine profiles | charmcraft | merged | Merged PR #2753 as commit 389d7dcb, updating Juju Ops URLs and fixture docstrings in Kubernetes and machine init profiles; fixes #2752. | |
| #1199 docs: update README according to template | craft-parts | merged | README documentation was updated to match the standard template; PR #1199 was merged via commit ef4d4fff. |