Skip to main content

Your submission was sent successfully! Close

Thank you for signing up for our newsletter!
In these regular emails you will find the latest updates from Canonical and upcoming events where you can meet our team.Close

Thank you for contacting us. A member of our team will be in touch shortly. Close

  1. Blog
  2. Article

jeffpihach
on 31 October 2017

Juju GUI: get your users started with getstarted.md

Deployment Grafana GUI juju charms
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

Related posts

Michele Mancioppi
28 October 2021

Canonical Observability Stack: Reimagining observability with MicroK8s and Grafana, Prometheus and Grafana Loki

Charms Article

Note: This post is co-authored by Jon Seager. Jon Seager is the Vice President of Enterprise Engineering at Canonical with responsibility for Juju, the Charmed Operator Framework, and several charmed operator development teams which operate across different software flavors, including observability, data platform, MLOps, identity, and mor ...

Michele Mancioppi
1 August 2021

Model-driven observability: modern monitoring with Juju

Charms Article

Learn how you can drastically simplify the monitoring setup for systems, reduce its ongoing maintenance costs and increase the actionability of your insights with Juju. ...

Serdar Vural
8 November 2023

Canonical joins Open Networking Foundation

Canonical announcements Article

Canonical is proud to announce that it is now a member of the Open Networking Foundation (ONF). This highlights our dedication to open source in mobile telecommunications and our continuous commitment to bringing cutting-edge solutions to the sector. Joining ONF is strategically important for Canonical to further its open source offerings ...