This section intends to provide some basic guidelines about how to write a tutorial or a how-to for the Disroot's How-to Website. The purpose of it is to help keep a similar structure to all the how-tos, and to make sure that they contain some features that the Disroot community (after some debates) think are important to be in the tutorials.
As we mentioned in our contribute page here, we work with Git, Atom text editor and Markdown Markup language as the tools to write them.
But if you're not feel comfortable with these tools you can just write a pad, email, etc. We'll take it all :smiley:
Basically, a how-to should have the following structure:
This is the first section of the how-to and goes before any content. By meta information we mean:
All of this can be done by placing a copy of the following paragraph on the top of the tuturial, and ajusting the information accordingly:
Software name: version 00.0.0-0 for GNU/Linux distro:
If the howto reffers to an older software version than the provided by Disroot,
or the one you're using in your device, there could be missing features or small parts of the information that may have changed.
how-to documentation is a community driven procces. We try to keep it as updated as we can.
Here you can find the template.
We think that how-to's text content should be kept at the minimum for the clarity and portabilaty sake of it. In the ideal case, just the specific context necessary, the essential steps to do a task and, whenever it's possible, supported by visual aids (screenshots, gifs) showing how a task is being done.
The content of a how-to then should meet the following criteria:
For gif / video recordings of a desktop we usually work with Peek
For mobile devices you can use screenrecorder
Easy to adapt by other projects: In order to do so, we think that mentions to Disroot and other unique identifiers of the Disroot project, should be kept at the necessary minimum and the content the more generic and adjectiveless as possible. This way, it's easier for other projects to use, adapt and edit the howtos.
Concise text content: Write only what is necessary to explain a task or a feature and warn about important things users should know.
Avoid long text paragraphs
So if you want to write a how-to for Disroot and you're not experienced with Markdown, here are some tips and recomandations about the text formating of a tutorial.
The how-to title itself goes in the page header, you can edit it if you use git.
As for the different sections titles of a how-to you can compose it in Markdown by using the
# symbol and a space before the title itself. For example:
# Title 1
## Title 2
### Title 3
#### Title 4
##### Title 5
... it will be displayed as:
# you use the smaller the title will be.
Titles are important for several reasons. One of the main is that Grav uses them to automatically generate the TOC / Index of the page. So they can be used to show the different chapters / sections of the howto at the top of the page index.
Smaller titles appear as "sub chapters" in the TOC. This could be useful to do something like this:
|We recommend the using of one
Please, use bullet points to list steps or features in a howto.
Making bullet points is easy. Writing...
- something 1
- something 2
... will show this:
Please, use bold to highlight:
To highlight a word or a line with bold, use two
* symbol before and after the part it needed.
For example, if you write...
it will be displayed as:
Italic works in a similar way as bold. You can use the
_ symbol or one
* symbol before and after the word or text section you want to apply the format.
... will show this:
Sometimes we need to insert links to some pages or websites. It can be done this way:
[link to Disroot website](disroot.org)
will be displayed as:
As we've mentioned, we like images / videos in the tutorials. You can embed them by doing the following:
Then create a link with the path to the folder and name of the file in question.
So if you write...
... you will see this:
And if you do this:
text before !(name_of_folder_full_of_media_files/example_1.png) text after
you'll get this:
text before text after
The structure described above also works to embed gifs and .mp4 videos.
If you need to show some terminal commands, code lines, instructions or examples like the ones we've been doing through this guide, you can use the ` symbol before and after the text you want to show.
This is a command line command:
sudo apt update
To make the tutorials more coherent and easier to be adapted by other groups, we recommend the use of the following criteria:
When writing a how-to, Disroot's name should be refered as: Disroot, starting with capital letter and bold type.
|Email services in general||Disroot Email|
|Private Bin||Disroot Bin|
|Nextcloud Calendar App||Disroot Calendar|
|Nextcloud Notes App||Disroot Notes|
|Nextcloud Contacts App||Disroot Contacts|
This way, if the expressions are regular, it's easier to just do a "Search and replace" :wink:
As we'd stated at the licensing page, all how-tos in this website are under a Creative Commons Attribution-ShareAlike license (CC BY-SA), so we ask anyone who wants to contribute with a howto to license their work under this same licensing. If you have any doubts, please, visit our licensing page.
That said, the last part of the howto is the licensing information. It should be at the bottom of the page and looking like this:
This work is licensed under a
Creative Commons Attribution-ShareAlike 4.0 International License.
You can do it by pasting the following code at the end of the related howto:
--- <center><a rel="license" href="http://creativecommons.org/licenses/by- sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-sa/4.0/88x31.png" /></a><br />This work is licensed under a <br><a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike 4.0 International License</a>.</center> ---
For video how-tos we also think that the content should be kept at the minimum and short enough for the user to be able to complete a task and for the clarity sake of it.
Same as the text how-tos, the tutorials should have the folowing structure:
Meta information and licensing information will be place by the Disroot admins in the video description of the Peertube instance where the videos will be hosted.
To the extent possible, videos should go with:
So that they can be placed by Disroot admins on the video description at the Peertube instance.
As we mentioned before, the licensing information will be placed by Disroot's Admins in the video description.
However we recommend that you place the following image at the end of your video for about 10 seconds fade in and out:
In this case if the video is downloaded and reuploaded somewhere else the license information is still there