forked from Disroot/Howto
Merge branch 'master' into 'h2.fixes'
# Conflicts: # pages/08.Contribute/06.Styleguide/docs.en.md
This commit is contained in:
parent
8a258b9b5d
commit
50bdbb1509
|
|
@ -8,31 +8,32 @@ page-toc:
|
|||
active: false
|
||||
---
|
||||
|
||||
|[**User**<br>](/user/)|[**Cloud**<br>](/cloud/)|
|
||||
|:--:|:--:|
|
||||
|01.[Account & Password Management](/user/account_password/)<br>02.[Personal data](/user/gdpr/)|**WEB**:<br>01.[General overview](/cloud/introduction/)<br>02.[Files management](/cloud/files_management)<br>03.[Applications](/cloud/apps/)<br><br>**DESKTOP**:<br>[Clients](/cloud/clients/desktop)<br><br>**MOBILE**:<br>[Clients](/cloud/clients/mobile)|
|
||||
<br>
|
||||
|[**User**<br>](/user/)|[Account](/user/account_password/) & [Personal Data](/user/gdpr/) management.|
|
||||
|:--:|--|
|
||||
|
||||
|[**Cloud**<br>](/cloud/)|**WEB**:<br>01.[General overview](/cloud/introduction/)<br>02.[Files management](/cloud/files_management)<br>03.[Applications](/cloud/apps/)|**DESKTOP**:<br>[Clients](/cloud/clients/desktop)|**MOBILE**:<br>[Clients](/cloud/clients/mobile)|
|
||||
|:--:|--|:--:|:--:|
|
||||
|
||||
|**COMMUNICATION TOOLS**|
|
||||
|:--:|
|
||||
|
||||
|[**Mail**<br>](/communication/email/)|[**Chat**<br>](/communication/chat/)|[**Forum**<br>](/communication/forum/)|
|
||||
|:--:|:--:|:--:|
|
||||
|01.[Email settings](/communication/email/clients)<br>02.[Setting aliases](/communication/email/alias)<br>03.[Setting filters](/communication/email/filters)<br><br>**WEB**:<br>[Webmail](/communication/email/webmail)<br><br>**DESKTOP**:<br>[Clients](/communication/email/clients/desktop)<br><br>**MOBILE**:<br>[Clients](/communication/email/clients/mobile)|**WEB**:<br>[Webchat](/communication/chat/webchat)<br><br>**DESKTOP**:<br>[Clients](/communication/chat/desktop)<br><br>**MOBILE**:<br>[Clients](/communication/chat/mobile)|[Discourse](/communication/forum/)|
|
||||
<br>
|
||||
|[**Mail**<br>](/communication/email/)|01. [Email settings](/communication/email/clients)<br>02. [Setting aliases](/communication/email/alias)<br>03. [Setting filters](/communication/email/filters)|**WEB**:<br>[Webmail](/communication/email/webmail)<br>|**DESKTOP**:<br>[Clients](/communication/email/clients/desktop)|**MOBILE**:<br>[Clients](/communication/email/clients/mobile)|
|
||||
|:--:|--|:--:|:--:|:--:|
|
||||
|[**Chat**<br>](/communication/chat/)||**WEB**:<br>[Webchat](/communication/chat/webchat)|**DESKTOP**:<br>[Clients](/communication/chat/desktop)|**MOBILE**:<br>[Clients](/communication/chat/mobile)|
|
||||
|[**Forum**<br>](/communication/forum/)|<center>[Discourse](/communication/forum/)</center>|
|
||||
|
||||
|[**SOCIAL**<br>](/social/)|
|
||||
|:--:|
|
||||
|**WEB:**<br>[**DisHub**: Disroot's Hubzilla instance](/social/dishub)<br><br>**MOBILE**:<br>[**Nomad**: Disroot's Hubzilla mobile app](/social/nomad)|
|
||||
<br>
|
||||
|[**SOCIAL**<br>](/social/)|**WEB:**<br>[**DisHub**:<br>Disroot's Hubzilla instance](/social/dishub)|**MOBILE**:<br>[**Nomad**:<br>Disroot's Hubzilla mobile app](/social/nomad)|
|
||||
|:--:|:--:|:--:|
|
||||
|
||||
|PROJECTS AND COLLABORATIVE TOOLS|
|
||||
|:--:|
|
||||
|
||||
|[**Project Board**<br>](/projects_office/taiga/)|[**Collaboratory**<br>](/projects_office/)|
|
||||
|:--:|:--:|
|
||||
|[Project Management](/projects_office/taiga/)|**WEB**:<br>01.[Pads](/projects_office/pads/)<br>02.[Pastebin](/projects_office/bin)<br>03.[Polls](/projects_office/polls/)<br>04.[File Sharing](/projects_office/lufi/)<br><br>**MOBILE**:<br>01.[DisApp](/projects_office/disapp)<br>02.[Padland](/projects_office/padland)|
|
||||
<br>
|
||||
|[**Project Board**<br>](/projects_office/taiga/)|[Project Management](/projects_office/taiga/)|
|
||||
|:--:|--|
|
||||
|
||||
|[**Collaboratory**<br>](/projects_office/)|**WEB**:<br>01.[Pads](/projects_office/pads/)<br>02.[Pastebin](/projects_office/bin)<br>03.[Polls](/projects_office/polls/)<br>04.[File Sharing](/projects_office/lufi/)|**MOBILE**:<br>01.[DisApp](/projects_office/disapp)<br>02.[Padland](/projects_office/padland)|
|
||||
|:--:|--|:--:|
|
||||
|
||||
|
||||
|[How-to Glossary](/glossary)|[How-to contribute](/contribute)|[How-to License](/licensing)|
|
||||
|:--:|:--:|:--:|
|
||||
|
|
|
|||
|
|
@ -13,6 +13,27 @@ page-toc:
|
|||
|
||||
# **Disroot How-to** guidelines
|
||||
|
||||
## Table of contents
|
||||
- [How-to's text content structure](#Howto_text_content_structure)
|
||||
- Meta Information
|
||||
- The how-to content
|
||||
- [Some formating tips](#Some_formating_tips)
|
||||
- Titles
|
||||
- Bullet Points
|
||||
- Bold
|
||||
- Italic
|
||||
- Links
|
||||
- Embedding videos / gifs / screenshots in the howto
|
||||
- Code
|
||||
- Terminologies
|
||||
- [Licensing of text how-to's](#Licensing_of_text_how-tos)
|
||||
- [Video how-to's](#Video_howtos)
|
||||
- Description of Content
|
||||
- Content
|
||||
- Licensing of video how-to's
|
||||
|
||||
----
|
||||
|
||||
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](https://howto.disroot.org).
|
||||
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.
|
||||
|
||||
|
|
@ -20,6 +41,7 @@ As we mentioned in our contribute page [here](/contribute/git/how-to-use-git), w
|
|||
|
||||
But if you're not feel comfortable with these tools you can just write a pad, email, etc. We'll take it all :smiley:
|
||||
|
||||
<a name="Howto_text_content_structure"></a>
|
||||
# How-to's text content structure
|
||||
|
||||
Basically, a how-to should have the following structure:
|
||||
|
|
@ -68,7 +90,7 @@ The content of a how-to then should meet the following criteria:
|
|||
|
||||
5. **Use bullet points instead of a big paragraphs when describing several steps or features**
|
||||
|
||||
|
||||
<a name="Some_formating_tips"></a>
|
||||
# Some formating tips
|
||||
|
||||
**Disroot**'s [How-to Website](https://howto.disroot.org/) is built with [Grav](https://getgrav.org/), and uses **Markdown** as Markup / Formating text composing language because it's an easy one to do so.
|
||||
|
|
@ -248,7 +270,7 @@ To make the tutorials more coherent and easier to be adapted by other groups, we
|
|||
This way, if the expressions are regular, it's easier to just do a "*Search and replace*" :wink:
|
||||
|
||||
---
|
||||
|
||||
<a name="Licensing_of_text_how-tos"></a>
|
||||
# Licensing of text how-to's
|
||||
|
||||
As we'd stated at the [licensing page](howto.disroot.org/en/licensing), all how-tos in this website are under a [Creative Commons Attribution-ShareAlike license](https://creativecommons.org/licenses/by-sa/4.0/) (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.
|
||||
|
|
@ -271,7 +293,7 @@ You can do it by pasting the following code at the end of the related howto:
|
|||
|
||||
|
||||
---
|
||||
|
||||
<a name="Video_howtos"><a/>
|
||||
# Video how-to's
|
||||
|
||||
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.
|
||||
|
|
|
|||
Loading…
Reference in New Issue