SDK How-to guides

Step-by-step guides covering key operations and common tasks related to the Juju SDK

Before you begin:

  • Users of the Juju SDK are expected to have basic familiarity with Juju OLM tools and concepts and access to a deployment environment set up with the Juju OLM. Please see the Juju OLM docs if you need an introduction or a refresher.
  • The required test environment is a Linux environment that supports installation via snap, e.g., Ubuntu 16.04 or later. If you don’t have that yet, see How to create an Ubuntu virtual machine with Multipass.

Manage Charmcraft

Manage charms

Manage charm resources

Manage charm libraries

Manage charm bundles

Add the following next to “Document your library”?

Document your charm

BTW is the linking to charmhub instead of intentional?

1 Like

Hi @sed-i! Thanks for your feedback—I’ll make them adjacent. Note 1: I’m not sure that doc should be called “How to document your charm”, because it doesn’t really discuss that; rather, only the mechanics of how to add documentation on Charmhub. Note 2: This is very much work in progress. There’s lots that will be moved around in the days to come. Note 3: Yes, linking to was on purpose, as the idea is to keep all documentation together under Of course, the formatting is still for, so that poses a small challenge. I’ll probably create a copy without that formatting, and then add a note in the tutorials doc to link to that.

1 Like