docs: update and clarify info about environment prep #2217
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the environment preparation documentation in the "How to manage charms" guide to align with current Charmcraft profiles and clarify tool purposes. The updates remove outdated Multipass recommendations and emphasize using uv for dependency management alongside Charmcraft and tox.
- Replaces manual tool installation instructions with clearer, purpose-specific descriptions
- Adds uv as the recommended dependency manager with installation instructions
- Standardizes "Concierge" naming and adds cross-references to CI integration examples
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/howto/manage-charms.md | Updates environment prep section with clearer tool descriptions, adds uv installation, removes Multipass mention, and reorganizes Concierge guidance |
| docs/howto/write-integration-tests-for-a-charm.md | Adds cross-reference link to CI validation section |
| docs/howto/write-and-structure-charm-code.md | Standardizes Concierge name with proper capitalization and link |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
tonyandrewmeyer
left a comment
tonyandrewmeyer
left a comment
There was a problem hiding this comment.
Looks good to me, thanks, but I think the tools bit over-focuses using a VM for testing, when it's actually what you do when you're just developing and manually trying things out too.
tonyandrewmeyer
left a comment
tonyandrewmeyer
left a comment
There was a problem hiding this comment.
Thanks, I like this more indeed :)
One small suggestion.
3 participants
This PR updates the environment prep info in How to manage charms, to match the expectations of the latest Charmcraft profiles and clarify the purpose of each tool.
I've removed the mention of Multipass for a couple of reasons: It's covered in the environment prep for integration testing (which is linked), and the
charm-devblueprint isn't recommended any more.Preview of doc build
Drive-bys: Use consistent name of Concierge across the docs. Link to the Concierge CI example from the integration testing doc.