Juju GUI: get your users started with getstarted.md

jeffpihach

on October 31, 2017

Help your users get started with your solution by providing them the first steps in using your newly deployed bundle or charm. The latest release of the Juju GUI now displays a rendered markdown file to the user after deploying a bundle or charm with a getstarted.md file. Adding this functionality to your bundle deployments couldn’t be easier. Simply add a getstarted.md file to the root of your bundle archive with valid markdown and it will be rendered after the deployment has started. The getstarted.md file should include the users next steps, and to help you build the best guide possible. We have outlined a few best practices below.
  • State prerequisites upfront so they don’t start down a path they can’t finish.
  • List the minimum number of steps that they should follow to see the charm working at some level of success. e.g get your users to a web dashboard or a REPL. We suggest using fewer than 10 steps.
  • Give your user links to sensible next steps. Link to external resources, most important first.

Extra points to keep in mind

  • Remember your user is in the GUI.
  • Start instruction with verbs – write in the imperative tense.
  • Write the simplest actions. Concentrate on what they need to do to get started.
  • Use code blocks for CLI commands.
  • Use the format of machines, protocols, and full paths to make reaching the most important endpoints of your application obvious.

Examples of some quickstart.md files

Newsletter signup

Select topics you’re
interested in

In submitting this form, I confirm that I have read and agree to Canonical’s Privacy Notice and Privacy Policy.

Related posts

We are changing the way you build snaps from GitHub repos

On the 11th March 2020 we introduced a new process for building a snap using GitHub repos to snapcraft.io. Here is all you need to know about this update....

GNOME 3.34 snapcraft extension

We constantly strive to empower developers. Part of that aim extends to making development easier, for example improving build tools and documentation. As an...

An adventure through the Snap Store

An application store with a large number of entries is a double-edged sword. It’s often a good sign of a vibrant, thriving community of software creators,...