canonical / canonical/charm-integration-testing

Improve development sandbox documentation

Open
#1,003 1 comment 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
6
Forks
1
Avg merge
1d 20h
Merged PRs (30d)
98

Description

_Generated by an AI assistant on behalf of @rpbritton._

### Problem statement

Raised as an action item in the Charm QA Triage Retrospective (9 Sept 2026): several attendees reported that environment setup and troubleshooting for the development sandbox took too much time. Existing docs don't cover cases such as CMR testing or re-using an existing controller for environments like testing on top of a local CK8s.

### Enhancement Proposal

Expand the development sandbox documentation to cover the gaps identified above, so new contributors can set up and troubleshoot the sandbox without needing to reverse-engineer command lines via trial and error (or an AI assistant).

### What needs to get done?

- Document CMR (cross-model relation) testing setup in the sandbox.
- Document how to reuse an existing controller for environments (e.g. testing on top of a local CK8s) instead of always bootstrapping fresh.
- Review and fill other gaps found during onboarding/troubleshooting.

Contributor guide

Open the contributing guide

Research direction

Start by locating the existing development sandbox documentation and the current setup or troubleshooting entry points. Document CMR testing, reusing an existing controller for local CK8s environments, and other onboarding gaps found during review; done means contributors can follow the documented workflows without reverse-engineering commands.

Written by the indexing model from the issue text.

Assessment

Tech stack
kubernetes
Domain
devops, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
62/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.