--- title: 'Juju GUI: get your users started with getstarted.md' description: 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 […] url: https://canonical.com/blog/juju-gui-get-your-users-started-with-getstarted-md?format=md --- 1. [Blog](https://canonical.com/blog) 2. Article --- [jeffpihach](https://canonical.com/blog/author/jeffpihach "More about jeffpihach") 31 October 2017 # Juju GUI: get your users started with getstarted.md [Deployment](https://canonical.com/blog/tag/deployment) [Grafana](https://canonical.com/blog/tag/grafana) [GUI](https://canonical.com/blog/tag/gui) [juju charms](https://canonical.com/blog/tag/juju-charms) --- Share the article 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 * * * [Get in touch Interested in running Ubuntu in your organization?](https://ubuntu.com/about/contact-us/form) ## Sign up for our newsletter Get the latest Canonical news and updates in your inbox. Work email: \*I agree to receive information about Canonical's products and services. By submitting this form, I confirm that I have read and agree to [Canonical's Privacy Policy](https://canonical.com/legal/dataprivacy). Sign up ## Share on --- ## Related posts [### Canonical Observability Stack: Reimagining observability with MicroK8s and Grafana, Prometheus and Grafana Loki](https://canonical.com/blog/lma-2-modern-observability-with-juju-by-charming-the-grafana-ecosystem) 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... [Michele Mancioppi](https://canonical.com/blog/author/michele-mancioppi) 28 October 2021 [### Deploy your Spring Boot application to production](https://canonical.com/blog/deploy-spring-application-to-production) In this article we walk through the steps required to deploy a Spring Boot application to production using Juju and Kubernetes. The goal is to showcase the integration of the... [Javier de la Puente](https://canonical.com/blog/author/javierdelapuente) 13 January 2026 [### Canonical joins Open Networking Foundation](https://canonical.com/blog/canonical-joins-open-networking-foundation) 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... [Serdar Vural](https://canonical.com/blog/author/serdarvural80) 8 November 2023 [### Early access to the LXD graphical user interface](https://canonical.com/blog/lxd_ui) Early access to LXD graphical user interface is now available. [Miona Aleksic](https://canonical.com/blog/author/mionaalex) 27 June 2023