H2 Contribute Redux · Part 1

pages/04.Contribute/00.ways2contribute/docs.en.md

@@ -1,39 +0,0 @@
----
-title: "How-to Contribute: Choose the way"
-published: true
-visible: true
-updated:
-taxonomy:
-    category:
-        - docs
-    tags:
-        - contribute
-page-toc:
-    active: false
----
-
-# How to contribute to the Howto's?
-
-Here are some ways you can chose:
-
-#### [GIT](/contribute/git)
-You can work offline, writing a how-to or improving an existing one, and then "push" the changes through Git.<br><br>**Technical level required**: Basic.
-
-#### [PAD](/contribute/pad)
-You can work on an online collaborative text file, writing or modifying a how-to, then communicating with Disroot HowTo team.<br><br>**Technical level required**: None.
-
-#### [EMAIL](/contribute/email)
-You can write or modify a how-to the way you want, and send us an email with the finished work. If you have suggestions or feedback on the H2s you could also communicate with us by this mean. <br><br>**Technical level required**: Basic.
-
-#### [FORUM](/contribute/forum)
-Through the forum you can upload, write or share a how-to and also make suggestions, give us feedback, etc. <br><br>**Technical level required**: Basic.
-
-#### [XMPP](/contribute/xmpp)
-You can communicate with us at our **Disroot** How-To's XMPP Room.<br><br>**Technical level required**: very basic.
-
-----
-### [Disroot Translations](/contribute/translations_procedure)
-If you want to collaborate by translating **Disroot HowTo** to your language, please, check this guide. 
-
-### [Disroot's How-To style guide](/contribute/styleguide)
-Some basic guidelines about the content and style criteria for the how-to's.

pages/04.Contribute/01.git/docs.de.md

@@ -1,31 +0,0 @@
----
-title: How-to: Mitwirken via Git
-published: true
-visible: true
-updated:
-taxonomy:
-    category:
-        - docs
-    tags:
-        - contribute
-        - git
-        - mitwirken
-page-toc:
-    active: false
----
-
-
-![](de/git.png)
-
-# Was ist git?
-
-**git** ist eine freie Software zur verteilten Versionsverwaltung, ein Werkzeug, um Dateien, Code und Inhalt zu verfolgen. Es ermöglicht vielen Menschen gleichzeitig, an den Codes zu arbeiten und allen Änderungen zu folgen, indem auf den Computern der Entwickler eine Kopie des Projekts vorliegt. git ist sehr beliebt bei Entwicklern und Systemadministratoren. Darüber hinaus können seine Funktionen überall dort Anwendung finden, wo der Verlauf von Änderungen und die Möglichkeit, Inhalt einzureichen und in Gruppen zusammenzuarbeiten, nötig sind.
-
-Wir nutzen git als Hauptwerkzeug für die Entwicklung unserer How-tos und Website. Es ist auch das Werkzeug, das wir bevorzugen, hauptsächlich, weil seine Anwendung wirklich einfach und schnell und es gleichzeitig sehr mächtig ist. Für die Bearbeitung der Texte nutzen wir **Atom**, einen mächtigen Text- und Code-Editor, wobei Du natürlich einen beliebigen Texteditor Deiner Wahl benutzen kannst.
-
-Auf den nächsten Seiten werden wir Dir zeigen, wie Du diese für die Arbeit an der Dokumentation von **Disroot** nutzen kannst.
-
-### [git: Basics How-to](how-to-use-git)
-
-----
-Mehr Informationen über git findest Du [hier](https://de.wikipedia.org/wiki/Git) und in [diesem Onlinebuch](https://git-scm.com/book/de/v2).

pages/04.Contribute/01.git/docs.en.md

@@ -1,30 +0,0 @@
----
-title: How-to Contribute: Git
-published: true
-visible: true
-updated:
-taxonomy:
-    category:
-        - docs
-    tags:
-        - contribute
-        - git
-page-toc:
-    active: false
----
-
-
-![](en/git.png)
-
-# What is git?
-
-**Git** is a distributed version control system, a tool for tracking files, code and content. It allows many people to work on the codes and follow all the changes at the same time with a copy of the project in all the developer's computers. It's very popular among developers and system administrators but it's features can be easily applicable everywhere history of changes and ability to submit content and collaborate in a group is required.
-
-We use it as the main tool for the development of our howtos and website. And it's the one we prefer, mainly because its usage is quite simple, fast and it's very powerful. In addition, we also use **Atom**, a rich text and code editor, although you can use the text editor of your choice.
-
-In the next pages we'll see how to use them for **Disroot**'s documentation.
-
-### [Git: Basics How-to](how-to-use-git)
-
-----
-You can find more information about git [here](https://en.wikipedia.org/wiki/Git) and in [this article](https://medium.freecodecamp.org/what-is-git-and-how-to-use-it-c341b049ae61?gi=805863b5a598).

pages/04.Contribute/01.howto/docs.en.md

@@ -0,0 +1,53 @@
+---
+title: "Howto Project"
+published: true
+visible: true
+indexed: true
+updated:
+taxonomy:
+    category:
+        - docs
+    tags:
+        - contribute
+page-toc:
+    active: true
+---
+
+# Howto Project
+The main goal of this part of the **Disroot** project is to provide clear and accessible information about how to use and configure the services we offer and, moreover, to do so in as many languages as possible.
+It consists mostly of guides and tutorials that evolve as the software does. So we are always looking for help to check, write and translate howtos.
+
+We use two tools for our work (although only one is essential): **Git** and (optionally) **a text editor**.
+
+## Git?
+Yes, **Git**. It is a control version system, a software that allows you to track modifications to files, keeping a record of all the changes made, so if you need to revert to a specific version you can do it in a relatively easy way. It is also a powerful collaboration tool, since it allows many people working on the same files of a project.
+
+Our use of **Git** doesn't require a high level of technical knowledge, anyone can learn the set of basic commands needed. And, to make it even easier, there are several text editors with **Git** integrated to reduce the interaction with the terminal to the minimum.
+
+To learn the basics of **Git** and to work with it can be not only a very useful but also a fun experience.
+
+Regarding the translations, we also use **Git** as our main tool for several reasons, the main one being our documents structure and code language. Even though there are many (and very good ones) translation tools which look more "user friendly", none of them fit our use case or have **Markdown** text format support out-of-the-box. In the best scenario, it will requires us to make massive modifications on the files in order to strip them down into several "text sections" or "strings".<br>
+Another reason is that **Gitea** (our **Git** hosting software) has a lot of useful features to organize and improve the work in one single place.
+
+So...
+
+# How do we work?
+The process is rather simple:
+1. We get a copy of the files we are going to work on;
+2. we work locally on the files,
+3. and once we have finished, we submit the work.
+
+Sounds pretty easy, doesn't it? Well, it really is. Of course, every step of the process has its own set of actions, which we will see later on, but that is it basically.
+
+## What tools do you need?
+1. **Git**: If you are a **GNU/Linux** user it is highly probable that you already have it installed (you can check in your software package manager or through the terminal with the command `which git`). If you are using **Windows** or **Mac OS**, you can download it from [here](https://git-scm.com/downloads).
+
+2. **A text editor**: Although there are many of them, we suggest you to use one with **Markdown** format support and **Git** integration. Both, **Kate Editor** and **Atom Text Editor**, meet this criteria, and they are also Free/Libre and Open Source multiplatform software.
+
+  **Kate Editor**: [Download](https://kate-editor.org/) · [Source code](https://invent.kde.org/utilities/kate)  |  **Atom Text Editor**: [Download](https://atom.io/) · [Source code](https://github.com/atom/atom)
+
+3. **A Disroot Gitea account**: In order to be able to submit your work, you will need to register an account on our **Gitea** instance (**Disroot** credentials will not work).
+
+  [**Register a new account**](https://git.disroot.org/user/sign_up) on **Disroot's Gitea** instance.
+
+Once you have the tools installed, it is time to set them up to start working.

pages/04.Contribute/02.disroot/docs.en.md

@@ -0,0 +1,17 @@
+---
+title: "Disroot Project"
+published: true
+visible: true
+indexed: true
+updated:
+taxonomy:
+    category:
+        - docs
+    tags:
+        - contribute
+        - disroot
+page-toc:
+    active: true
+---
+
+# Disroot Project

pages/04.Contribute/02.pad/docs.de.md

@@ -1,19 +0,0 @@
----
-title: How-to: Mitwirken via Pads
-published: false
-visible: true
-updated:
-taxonomy:
-    category:
-        - docs
-    tags:
-        - contribute
-        - mitwirken
-page-toc:
-    active: false
----
-
-
-# Ein gutes Beispiel
-
-Hier haben wir ein gutes Beispiel für die Arbeit, die noch nötig ist. Leider hat sich noch niemand bereit gefunden, ein How-to für diesen Bereich zu schreiben. Vielleicht möchtest Du dies ja zu Deinem ersten Projekt machen?!

pages/04.Contribute/02.pad/docs.en.md

@@ -1,18 +0,0 @@
----
-title: How-to Contribute: Pads
-published: false
-visible: true
-updated:
-taxonomy:
-    category:
-        - docs
-    tags:
-        - contribute
-page-toc:
-    active: false
----
-
-
-# Open Task
-
-This is a good example for the work still to do. Until now, no one was found to write this Tutorial. Maybe you want to make it your first project?

pages/04.Contribute/02.pad/docs.es.md

@@ -1,9 +0,0 @@
----
-title: Cómo contribuir: Pads
-published: true
-visible: true
-taxonomy:
-    category:
-        - docs
----
-ToDo

pages/04.Contribute/02.pad/docs.pt.md

@@ -1,19 +0,0 @@
----
-title: Como contribuir: Pads
-published: false
-visible: true
-updated:
-taxonomy:
-    category:
-        - docs
-    tags:
-        - contribute
-page-toc:
-    active: false
----
-
-
-# Por fazer
-
-Isto é um bom exemplo do trabalho que ainda falta fazer. Até agora ainda não se encontrou ninguém para escrever este documento.<br>
-Talvez escrever a documentação para esta página possa ser o teu primeiro projeto? :)

pages/04.Contribute/03.email/docs.de.md

@@ -1,20 +0,0 @@
----
-title: How-to: Mitwirken via Email
-published: true
-visible: false
-updated:
-taxonomy:
-    category:
-        - docs
-    tags:
-        - contribute
-        - email
-        - mitwirken
-page-toc:
-    active: false
----
-
-
-# Ein gutes Beispiel
-
-Hier haben wir ein gutes Beispiel für die Arbeit, die noch nötig ist. Leider hat sich noch niemand bereit gefunden, ein How-to für diesen Bereich zu schreiben. Vielleicht möchtest Du dies ja zu Deinem ersten Projekt machen?!

pages/04.Contribute/03.email/docs.en.md

@@ -1,19 +0,0 @@
----
-title: How-to Contribute: Email
-published: true
-visible: false
-updated:
-taxonomy:
-    category:
-        - docs
-    tags:
-        - contribute
-        - email
-page-toc:
-    active: false
----
-
-
-# Open Task
-
-This is a good example for the work still to do. Until now, no one was found to write this Tutorial. Maybe you want to make it your first project?

pages/04.Contribute/03.email/docs.es.md

@@ -1,9 +0,0 @@
----
-title: Cómo contribuir: Correo electrónico
-published: true
-visible: true
-taxonomy:
-    category:
-        - docs
----
-ToDo