In this tutorial, you will learn how to write content for charmhub.io/tutorials.
We will start by looking at general guidelines, the structure of a tutorial and go through the publication and review process.
What you’ll learn
- How to create and structure a tutorial from a single Markdown file
- How to use the additional Markdown features specific to the engine
- How to render it locally to see what your readers will see
- How to get it ready for review by the Charmhub team
What you’ll need
- A Charmhub Discourse account, for the publication and review process
Depending on the topic and your level of experience, writing a tutorial can be a very easy task, but following these guidelines is important to keep the whole set of published tutorials consistent. Let’s get started!
Mission of tutorials
Tutorials are step by step guides aimed at a very diverse audience. To provide a good learning experience, a consistent and didactic approach is key.
A good tutorial should:
- be focused on one topic or a very small group of related topics. Keep it simple and on point as people who want to learn multiple subjects will take multiple tutorials.
- produce a tangible result. The topic is demonstrated with a small practical project and not only a theoretical or “hello world” example. The tutorial reader will come out of it with a working example on their environment.
- be short. An estimated 60 minutes for a tutorial is an absolute maximum. Most tutorials should be in the range of 15 - 30 minutes.
- be divided in short steps. Each step is practical and results in user-visible progress.
- be entertaining! Try to have a fun project to work on, even if it’s something impractical!
The tone of your tutorial should be friendly. Try to make the reader feel that they’re building and learning something together with you.
All tutorials should have the same tone, regardless of the topic. This is why you should complete one or two of the existing tutorials before writing your first one.
In short, this isn’t a teacher/student paradigm, but rather friends sharing some time together. Thus, “we” should be used as much as possible, like “we have just seen”, “we now understand that…”. However, “you” can be used for demonstrating things in the user’s context, like: “edit your file”, “your directory should look like this”, “on your system”, etc.
And now, let’s see the first required step!
Metadata and structure
Each tutorial is built using a single topic on discourse, under the category docs/tutorials.
Title of the topic
The tutorial title should be kept short (3 to 8 words as a guide) to not break the design. Try to make concise titles but also specific when possible, e.g. “How to build a charm using modern tools”
Each step is delimited by a second level title, for example:
## Step title
A step Duration in the
MM:SS format should immediately follow the step title. The total tutorial time will then be computed automatically. A third level heading or empty line will break into the step content.
## Step title Duration: 2:00 Step content starts here.
If we put these pieces together here is what a very simple tutorial looks like:
## This is the first step Duration: 2:00 This is the content of the first step. ## This is the second and final step Duration: 1:00 Congrats, you made it!
Once these structural pieces are out of the way, we can start getting into the most interesting part: the content.
Introducing your content
First impressions matter and the first page of your tutorial should be welcoming and informative. On charmhub.io/tutorials, an “Overview” page should be the first step of every tutorial.
The overview contains at least three small parts: * a summary * a “What you’ll learn” section * a “What you’ll need” section.
The first paragraph or paragraphs of the overview is a summary of the tutorial’s objectives, its purpose and why the reader should go through it. An image can be included, as well as external links.
## Overview Duration: 1:00 In this tutorial, you will learn how to write content for charmhub.io/tutorials. We will start by looking at general guidelines, the structure of a tutorial and go through the publication and review process.
The “What you’ll learn” section
This section includes the list of topics covered by your tutorial. It’s a way to align readers expectations with the content they are going to read. Topics are presented as bullet points.
### What you'll learn - How to create and structure a tutorial from a single Markdown file - How to use the additional Markdown features specific to the engine - How to render it locally to see what your readers will see - How to get it ready for review by the Charmhub team
The “What you’ll need” section
This is the list of prerequisites the reader needs to meet before starting the tutorial. If there is a need for specific hardware, software or user accounts, this is the right place to talk about it. If there is a need for specific technical knowledge to go through your tutorial, use this section as an opportunity to link to documentation and other tutorials.
Prerequisites are presented as bullet points.
### What you'll need - Ubuntu Desktop 16.04 or above - Some basic command-line knowledge
When you are done with your friendly and informative introduction, you can start adding more steps (remember, second level titles are used to declare the start of a step) and build your tutorial story.
To do so, we will now go through some content recommendations.
Dos and Don’ts
In addition to the previous advice on what a tutorial should be and what is mandatory, you should pay special attention to the following points:
Each step should be concise, but not too short
Be wary of a step’s length. On average, 5 to 10 minutes is more than enough for a single step to complete. Don’t make them too short either. Naturally, some steps will be shorter than others (such as the first and last steps).
If too long, prefer dividing the tutorial
Tutorials are self-sufficient, but they can nonetheless build upon each other (you can link from the requirements section of the first step, for example). One tutorial could require another tutorial to be completed first. And if you are reusing the same code, ensure you provide a repository as a starting point.
If a tutorial is too long, consider breaking it up into several pieces. However, ensure all tutorials present a distinct objective.
Don’t have too many steps
Steps should be concise and tutorials should be rather short. Consequently, you shouldn’t have too many steps in your tutorial. We don’t want to make the reader desperate by glancing at the number of remaining steps before tutorial completion.
Each step should be rewarding
As a writer, you should try to keep the reader entertained at each step and this is achieved by careful story building. Each step should end on concrete progress towards the end goal. It should be, if possible, tangible and interactive, so that the reader can be familiarised with notions introduced by the step.
To earn bonus reader commitment points, finish a step on a “cliffhanger”!
Make intentional mistakes
This could seem counterintuitive at first. However, learning by fire (or rather, by error here) is a key way of learning new things. Executing, erroring, analyzing and fixing has multiple benefits:
Users will be familiar with a particular error, and even if they don’t remember explicitly how to fix it the next time they encounter it, they will have some clue and some deja-vu feeling which will guide them towards its resolution.
Providing the perfect answer from the start hides complexity and a lot of non-formally written subtleties. Forcing readers to face them will ensure that the tutorial written doesn’t take these subtleties as a given and will greatly help newcomers.
ⓘ A concrete example of this is, in the “Create your first snap” tutorial, how we introduce building a snap. After creating the parts, we immediately build the snap and install it. Then, we try to execute one of the snap binaries, but no such command is found! That way, we can introduce the fact (in the following step) that binaries are not exposed by default as part of the snap. We can use this “mistake” to introduce further concepts.
External links in tutorials
Links to external websites are forbidden during a tutorial. We don’t want people’s attention diverted from the task they are going through (which emphasizes the fact that each step should have enough knowledge to be self-sufficient). In particular, do not link the reader to the reference documentation. We want to keep the user’s attention on the current task only. Download links are allowed though.
As previously written, only the first and last steps can (and probably should) link to external documentation for prerequisites or learning more on a particular topic. The same rule applies to external websites for libraries or frameworks.
The only exception to this rule is when linking to source code that is being used as a checkpoint in the tutorial (eg. “your code should look like this”).
Of course, this doesn’t concern key tutorial actions happening on a given website, like Launchpad, GitHub, login.ubuntu.com, etc.
Provide regular code “checkpoints”
This is mostly for developer oriented tutorials, but if this rule can be applied to an admin/advanced users oriented one, please do so!
The advice is to provide regular checkpoints where people can sync back their source code with the tutorial, in particular, at the start of a given step. Readers could have stopped then resumed going through a tutorial, and may not have the source code from previous steps anymore. Consequently, in the case of a code-writing tutorial, please try to provide a link to the current state of the code at the start of a step.
You can refer to it as “If you want to ensure you have all the needed bits we saw together in the previous steps…“ and point to an external repository on GitHub, Launchpad or others… This element should be in an admonition:
Do not separate exercises and answers
In general, try to avoid leaving the user hanging for the right answer. Tutorials aren’t a class/lesson or a test to pass with some exercises.
In particular, to avoid a teacher/student relationship, do not separate questions and answers (apart from cliffhangers as previously stated, but the questions you are asking your audience are more rhetorical in that case!).
Do not repeat the setup/install phase for each tutorial
Avoid repetitive setups or installation phases, particularly if the tutorial isn’t a beginner one. Beginner tutorials should contain a setup phase while more advanced tutorials should reference other beginner tutorials as prerequisites.
Command line snippets
Inline commands are styled with single backticks :
Which renders as
For longer example code we expect people to type in, we do not use the command prompt at the beginning of each line, and we separate the command from the output. This makes the command and outputs clearer and also easier to copy and paste.
` Run the following command:
This will display the content of the file:
Awesome my_file content on multiple lines
Finally, the code blocks (commands and code to write) of the tutorial should be self-sufficient. It means that we don’t expect people to write code or run commands outside of what we expose in code blocks, and only typing and executing their content should lead them to the desired state.
You should now have all the cards in hand to provide a rewarding learning experience! It’s time we look at how to structure the final page of a tutorial: the “rewarding” step.
Rewarding your readers
On the last page of a tutorial, the project is finished and you remind readers they have reached their goal and have grown some new skills.
Take one or two paragraphs to remind them of what they went through and what they have achieved. That way, readers can reflect upon the various steps and their newly acquired knowledge. Ensure you use a friendly title for this final step.
For example, as a reader of this tutorial, you should have understood what’s needed to create a successful learning experience, what the recommendations are, and how the Markdown syntax works. You now know how to deploy the website locally and how to propose your content for review!
On the last page, make sure you also include at least one of the following sections:
- Next steps
- Further reading
With a list of bullet points, offer some guidance on the next steps a reader may want to take. This could be other tutorials being the “next logical ones”, communication channels and places where to get support from.
### Next steps * If you need support, the [charmhub community](https://discourse.charmhub.io) is the best place to get all your questions answered and get in touch with the community.
With another list of bullet points, provide a list of external resources to get more information on the topic. You can link to documentation, related source code, or blog posts that will provide more insights.
### Further readings * The juju documentation has everything you need if you want to look more
To use everything the tutorials engine has to offer, let’s look at some syntax tips.
The syntax used is by and large regular Markdown syntax, but there are some specificities:
Line breaks and empty lines
- Paragraphs are delimited by empty lines
- Line breaks will create a new line
In the context of an admonition or a survey widget, using an empty line will close it and go back to text.
Images can be hosted locally (relatively linked to the markdown source) or remotely. The tutorial engine will fetch remote images and cache them locally.
In Markdown the syntax for an image is the following:
Admonitions are colored blocks that enclose special information, they can be a positive tip or a negative warning. To create an admonition, write its type (“positive” or “negative”) on a line by itself, then begin the next line with a colon and a space.
A positive admonition should contain positive information like best practices and time-saving tips.
> ⓘ **Eat your vegetables!** > This is a positive message.
Which renders as:
ⓘ Eat your vegetables!
This is a positive message.
A negative admonition should contain negative information such as warnings and API usage restrictions.
> ⚠️ **Eat your vegetables!** > This is a warning. > It can be multi-lines like this.
Which renders as:
Eat your vegetables!
This is a warning.
It can be multi-lines like this.
Fenced Code and Language Hints
Code blocks are declared by placing them between two lines containing three backticks. The tutorial engine will attempt to perform syntax highlighting on code blocks, but it is not always effective at guessing the language to highlight in.
Put the name of the coding language after the first fence to explicitly specify which highlighting plan to use, like this:
This block is highlighted as Go source code.
Which renders as:
This block is highlighted as Go source code.
These additions to standard Markdown are easy to master and play with, but in case you face unexpected behaviours in the rendering, feel free to reach out to the tutorials maintainers at #ubuntu-doc on Freenode IRC.
When writing a tutorial, it’s extremely useful to see how it will render. Discourse provides a very useful way of rendering the markdown when writing a new topic. Make sure that the tutorial is well rendered.
Once you can have seen your tutorial in its final form, it’s time to share it with the world.
Review and publishing process
The tutorials category is managed by the Charmhub team. A review process is in place to ensure new tutorials are being looked at by writers, engineers and documentation experts.
To get a new tutorial reviewed and published, please complete the text of the tutorial in discourse and then email: email@example.com. The email should contain the following:
- Link: the link to the new tutorial
- Summary: a description of the tutorial (just 10 to 20 words) that will be displayed on the frontpage of the site
Categories: suggest categories that users can use to filter to find tutorials. Use any of these preset options;
Difficulty level: the scale spans from 1 to 5. Beginners without previous knowledge of the given topic should be able to follow and understand tutorials from level 1 without any other prerequisite knowledge. As a guide:
- 1: Complete beginner with Ubuntu - just about knows how to open a terminal
- 2: Ubuntu novice - can be trusted to enter commands but experience limited to simple file operations
- 3: Experienced user - doesn’t need explanations about common topics (networking, sudo, services)
- 4: Advanced user - has experience running Ubuntu for many years, but may be unfamiliar with some sysadmin/programming topics
- 5: Ubuntu sysadmin/developer- very familiar with most aspects of the operating system and can be expected to know details about its inner worki
Author: the name and email address between brackets of the author of the tutorial. If you don’t intend to maintain this tutorial after publication, please use
Canonical Web team <firstname.lastname@example.org>
Once they get to it, they will review the content and open a discussion with you on the discourse topic directly. At the end of this process, they will either include your changes into the project or request additional changes.
That’s all folks!
Congrats, you made it! If you have been watching closely, you are now fully equipped to write a compelling tutorial and take your future readers to new heights!
Now you know how to:
- Create a welcoming and informative intro to your content
- Provide an interesting and easy-to-follow learning experience
- Structure your markdown source file
- Render tutorials locally and submit them for publication
There are a lot of topics to write about and if you are looking for ideas, just think about what you master and frequently do on Ubuntu, something that’s useful to you, even if it’s an arcane topic or a very simple set of tips you think people would benefit from.
- Write your first tutorial on your topic of choice and propose it for publication!
- Read other tutorials and help us improving them by commenting on discourses tutorials