diff --git a/pages/04.Contribute/06.Translations_procedure/de/assign.gif b/pages/04.Contribute/01.procedure/de/assign.gif old mode 100644 new mode 100755 similarity index 100% rename from pages/04.Contribute/06.Translations_procedure/de/assign.gif rename to pages/04.Contribute/01.procedure/de/assign.gif diff --git a/pages/04.Contribute/01.git/how-to-use-git/de/atom-pull.gif b/pages/04.Contribute/01.procedure/de/atom-pull.gif old mode 100644 new mode 100755 similarity index 100% rename from pages/04.Contribute/01.git/how-to-use-git/de/atom-pull.gif rename to pages/04.Contribute/01.procedure/de/atom-pull.gif diff --git a/pages/04.Contribute/01.git/how-to-use-git/de/atom1.png b/pages/04.Contribute/01.procedure/de/atom1.png old mode 100644 new mode 100755 similarity index 100% rename from pages/04.Contribute/01.git/how-to-use-git/de/atom1.png rename to pages/04.Contribute/01.procedure/de/atom1.png diff --git a/pages/04.Contribute/01.git/how-to-use-git/de/atom_interface1.png b/pages/04.Contribute/01.procedure/de/atom_interface1.png old mode 100644 new mode 100755 similarity index 100% rename from pages/04.Contribute/01.git/how-to-use-git/de/atom_interface1.png rename to pages/04.Contribute/01.procedure/de/atom_interface1.png diff --git a/pages/04.Contribute/06.Translations_procedure/de/branch_01.gif b/pages/04.Contribute/01.procedure/de/branch_01.gif old mode 100644 new mode 100755 similarity index 100% rename from pages/04.Contribute/06.Translations_procedure/de/branch_01.gif rename to pages/04.Contribute/01.procedure/de/branch_01.gif diff --git a/pages/04.Contribute/06.Translations_procedure/de/commit.gif b/pages/04.Contribute/01.procedure/de/commit.gif old mode 100644 new mode 100755 similarity index 100% rename from pages/04.Contribute/06.Translations_procedure/de/commit.gif rename to pages/04.Contribute/01.procedure/de/commit.gif diff --git a/pages/04.Contribute/01.git/how-to-use-git/de/git-merge_request.gif b/pages/04.Contribute/01.procedure/de/git-merge_request.gif old mode 100644 new mode 100755 similarity index 100% rename from pages/04.Contribute/01.git/how-to-use-git/de/git-merge_request.gif rename to pages/04.Contribute/01.procedure/de/git-merge_request.gif diff --git a/pages/04.Contribute/01.git/how-to-use-git/de/git-request_access.png b/pages/04.Contribute/01.procedure/de/git-request_access.png old mode 100644 new mode 100755 similarity index 100% rename from pages/04.Contribute/01.git/how-to-use-git/de/git-request_access.png rename to pages/04.Contribute/01.procedure/de/git-request_access.png diff --git a/pages/04.Contribute/01.git/how-to-use-git/de/howto-duplicate1.gif b/pages/04.Contribute/01.procedure/de/howto-duplicate1.gif old mode 100644 new mode 100755 similarity index 100% rename from pages/04.Contribute/01.git/how-to-use-git/de/howto-duplicate1.gif rename to pages/04.Contribute/01.procedure/de/howto-duplicate1.gif diff --git a/pages/04.Contribute/01.git/how-to-use-git/de/note.png b/pages/04.Contribute/01.procedure/de/note.png old mode 100644 new mode 100755 similarity index 100% rename from pages/04.Contribute/01.git/how-to-use-git/de/note.png rename to pages/04.Contribute/01.procedure/de/note.png diff --git a/pages/04.Contribute/01.git/how-to-use-git/de/publish.png b/pages/04.Contribute/01.procedure/de/publish.png old mode 100644 new mode 100755 similarity index 100% rename from pages/04.Contribute/01.git/how-to-use-git/de/publish.png rename to pages/04.Contribute/01.procedure/de/publish.png diff --git a/pages/04.Contribute/06.Translations_procedure/de/pull_push.png b/pages/04.Contribute/01.procedure/de/pull_push.png old mode 100644 new mode 100755 similarity index 100% rename from pages/04.Contribute/06.Translations_procedure/de/pull_push.png rename to pages/04.Contribute/01.procedure/de/pull_push.png diff --git a/pages/04.Contribute/06.Translations_procedure/de/push.gif b/pages/04.Contribute/01.procedure/de/push.gif old mode 100644 new mode 100755 similarity index 100% rename from pages/04.Contribute/06.Translations_procedure/de/push.gif rename to pages/04.Contribute/01.procedure/de/push.gif diff --git a/pages/04.Contribute/06.Translations_procedure/docs.de.md b/pages/04.Contribute/01.procedure/docs.de.md old mode 100644 new mode 100755 similarity index 100% rename from pages/04.Contribute/06.Translations_procedure/docs.de.md rename to pages/04.Contribute/01.procedure/docs.de.md diff --git a/pages/04.Contribute/01.procedure/docs.en.md b/pages/04.Contribute/01.procedure/docs.en.md new file mode 100755 index 00000000..805f208d --- /dev/null +++ b/pages/04.Contribute/01.procedure/docs.en.md @@ -0,0 +1,44 @@ +--- +title: Procedures +published: true +visible: true +updated: +taxonomy: + category: + - docs + tags: + - contribute + - procedure +page-toc: + active: true +--- + +# Howto Procedures: What does it mean? +The possibility of writing a tutorial and making it accessible to everyone in their own languages is fundamental in order to encourage and promote not only the use of free/libre and open source software but also collective thoughts and actions. So coordinating the amount of information to be written and translated is an important task, therefore we developed a basic set of steps to follow to help us achieve this goal. + +The procedure 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 them. + +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 we need? +We use three tools for our work: **Git**, **a text editor** and **Gitea**. + +We choose **Git** 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". Another important reason is that **Git** allows us to keep track on the changes made on those files, making it easier to manage and collaborate on them. And one more reason is that **Gitea** (the code hosting software we use with **Git**) has a lot of useful features to organize and improve the work in one single place. + +OK, let's check our tools: + +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 **Microsoft 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. **Kate Editor**, **Atom Text Editor** and **VSCodium**, meet this criteria natively, and they are also Free/Libre and Open Source multiplatform software. But, **for practical reasons, we will only see how to work in Atom** (in the future we will include other tools). + + **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) and request access to our repository. + + [**Register a new account**](https://git.disroot.org/user/sign_up) on **Disroot's Gitea** instance. + +Once you have these tools, it is time to set them up. diff --git a/pages/04.Contribute/01.procedure/docs.es.md b/pages/04.Contribute/01.procedure/docs.es.md new file mode 100755 index 00000000..d64262c3 --- /dev/null +++ b/pages/04.Contribute/01.procedure/docs.es.md @@ -0,0 +1,44 @@ +--- +title: Procedimientos +published: true +visible: true +updated: +taxonomy: + category: + - docs + tags: + - contribuir + - procedimiento +page-toc: + active: true +--- + +# Procedimientos Howto: ¿Qué significa? +La posibilidad de escribir un tutorial y hacerlo accesible para todxs en sus propios idiomas es fundamental no solo para fomentar y promover el uso de software libre y de código abierto sino también pensamientos y acciones colectivas. Así que coordinar la cantidad de información a ser escrita y traducida es una tarea importante, por lo tanto desarrollamos una serie básica de pasos a seguir para que nos ayude a lograrlo. + +El procedimiento es bastante simple: +1. Obtenemos una copia de los archivos sobre los que vamos a trabajar; +2. trabajamos localmente en ellos, +3. y una vez que hemos terminado, los enviamos. + +Suena bastante fácil, ¿no?. Bueno, realmente lo es. Por supuesto, cada paso del procedimiento tiene su propio conjunto de acciones, que veremos más adelante, pero es eso básicamente. + +# ¿Qué herramientas necesitamos? +Usamos tres herramientas para nuestro trabajo: **Git**, **un editor de texto** y **Gitea**. + +Elegimos **Git** por varias razones, la principal es la estructura y el lenguaje de código de nuestros documentos. Aunque hay muchas (y muy buenas) herramientas de traducción que parecen más "fáciles de usar", ninguna de ellas se ajusta a nuestro caso de uso o tienen soporte para el formato de texto **Markdown** por defecto. En el mejor de los escenarios, requeriría que hagamos modificaciones enormes sobre los archivos para poder desglosarlos en muchas "secciones de texto" o "cadenas". Otra razón importante es que **Git** nos permite mantener un registro de los cambios realizados sobre esos archivos, haciéndo más sencillo manejarlos y colaborar sobre ellos. Y una razón más es que **Gitea** (el software para hospedar código que usamos con **Git**) tiene un montón de funcionalidades muy útiles para organizar y mejorar el trabajo en un solo lugar. + +Muy bien, repasemos nuestras herramientas: + +1. **Git**: Si eres usuarix de **GNU/Linux** es altamente probable que ya lo tengas instalado (puedes chequearlo en tu gestor de software o a través de la terminal con el comando `which git`). Si estás usando **Microsoft Windows** o **Mac OS**, puedes descargarlo desde [aquí](https://git-scm.com/downloads). + +2. **Un editor de texto**: Aunque hay muchos de ellos, sugerimos utilizar uno con soporte para el formato **Markdown** e integración con **Git**. Los editores **Kate**, **Atom** y **VSCodium**, cumplen con este criterio de forma nativa, y también son programas multiplataforma con licencias libres y de código abierto. Pero, **por razones prácticas, solo veremos cómo trabajar en Atom** (en el futuro incluiremos otras herramientas). + + **Atom Text Editor**: [Descargar](https://atom.io/) · [Código fuente](https://github.com/atom/atom) + + +3. **Una cuenta de Disroot Gitea**: Para poder enviar tu trabajo, necesitarás registrar una cuenta en nuestra instancia de **Gitea** (las credenciales de **Disroot** no funcionarán) y solicitar acceso a nuestro repositorio. + + [**Registrar una cuenta nueva**](https://git.disroot.org/user/sign_up) en la instancia **Gitea** de **Disroot**. + +Una vez que tengas estas herramientas, es momento de configurarlas. diff --git a/pages/04.Contribute/02.git/01.editors/01.atom/01.interface/docs.en.md b/pages/04.Contribute/02.git/01.editors/01.atom/01.interface/docs.en.md new file mode 100755 index 00000000..32e00132 --- /dev/null +++ b/pages/04.Contribute/02.git/01.editors/01.atom/01.interface/docs.en.md @@ -0,0 +1,63 @@ +--- +title: Interface +published: true +visible: true +updated: + last_modified: "January 2022" + app: Atom Text Editor + app_version: 1.58.0 +taxonomy: + category: + - docs + tags: + - contribute + - atom + - git +page-toc: + active: true +--- + +# Getting familiar with Atom +Let's start by getting to know the interface a little bit. Once we have started Atom we will see that it is quite straightforward. + +![](en/atom_01.png) + +First thing we need to do is to open the Howto project folder that we have just cloned. To do that we can either go to the **File menu** --> **Open Folder** and select the directory or directly from the **Add folders** button at the left. + +![](en/atom_interface.png) + +The left panel is the project's navigation tree and the main window is the editor where we will edit the files. + +![](en/navigation.gif) + +At the bottom is the "status bar" which displays, at the left, the path of the file we are working on and, at the right, information related to the code language, the current branch, some Git actions menu and the number of files we have modified. + +![](en/status.bar.png) + +Clicking on the **Git** button at the right side of the status bar will display the Git panel where we can view all the files we have modified as well as some Git operations that we can perform (and that we will see later on). + +![](en/git.panel.gif) + +We can also toggle the panels if we need to focus just on the text editor. + +![](en/panels.gif) + +We can activate the **Markdown preview** to have a visual idea of what are we doing on a file by pressing the keys `Ctrl` + `Shift` + `m`... + +![](en/preview.gif) + +... and we can open and work on multiple files in tabs or splitting the screen into several panels. + +![](en/splitted.panels.png) + +**Atom** is highly customizable, to the point we can tweak practically each and every one of its parts to better suit our needs. + +The two last things to note before we start to work are: + +- The unsaved files with local modifications are marked with a blue dot (depending on the theme we are using). + +![](en/unsaved.png) + +- To save the file changes we can use the **File menu** --> **Save** or the `Ctrl` + `s` keyboard shortcut. + +Now that we know our workspace, it is time to get down to work. diff --git a/pages/04.Contribute/02.git/01.editors/01.atom/01.interface/en/atom_01.png b/pages/04.Contribute/02.git/01.editors/01.atom/01.interface/en/atom_01.png new file mode 100755 index 00000000..20f9df12 Binary files /dev/null and b/pages/04.Contribute/02.git/01.editors/01.atom/01.interface/en/atom_01.png differ diff --git a/pages/04.Contribute/02.git/01.editors/01.atom/01.interface/en/atom_interface.png b/pages/04.Contribute/02.git/01.editors/01.atom/01.interface/en/atom_interface.png new file mode 100755 index 00000000..6c678818 Binary files /dev/null and b/pages/04.Contribute/02.git/01.editors/01.atom/01.interface/en/atom_interface.png differ diff --git a/pages/04.Contribute/02.git/01.editors/01.atom/01.interface/en/git.panel.gif b/pages/04.Contribute/02.git/01.editors/01.atom/01.interface/en/git.panel.gif new file mode 100755 index 00000000..bc7116bf Binary files /dev/null and b/pages/04.Contribute/02.git/01.editors/01.atom/01.interface/en/git.panel.gif differ diff --git a/pages/04.Contribute/02.git/01.editors/01.atom/01.interface/en/navigation.gif b/pages/04.Contribute/02.git/01.editors/01.atom/01.interface/en/navigation.gif new file mode 100755 index 00000000..268103e6 Binary files /dev/null and b/pages/04.Contribute/02.git/01.editors/01.atom/01.interface/en/navigation.gif differ diff --git a/pages/04.Contribute/02.git/01.editors/01.atom/01.interface/en/panels.gif b/pages/04.Contribute/02.git/01.editors/01.atom/01.interface/en/panels.gif new file mode 100755 index 00000000..c85c2b6f Binary files /dev/null and b/pages/04.Contribute/02.git/01.editors/01.atom/01.interface/en/panels.gif differ diff --git a/pages/04.Contribute/02.git/01.editors/01.atom/01.interface/en/preview.gif b/pages/04.Contribute/02.git/01.editors/01.atom/01.interface/en/preview.gif new file mode 100755 index 00000000..19130081 Binary files /dev/null and b/pages/04.Contribute/02.git/01.editors/01.atom/01.interface/en/preview.gif differ diff --git a/pages/04.Contribute/02.git/01.editors/01.atom/01.interface/en/project_panel.png b/pages/04.Contribute/02.git/01.editors/01.atom/01.interface/en/project_panel.png new file mode 100755 index 00000000..79b50bf8 Binary files /dev/null and b/pages/04.Contribute/02.git/01.editors/01.atom/01.interface/en/project_panel.png differ diff --git a/pages/04.Contribute/02.git/01.editors/01.atom/01.interface/en/project_tree.png b/pages/04.Contribute/02.git/01.editors/01.atom/01.interface/en/project_tree.png new file mode 100755 index 00000000..d892c1c0 Binary files /dev/null and b/pages/04.Contribute/02.git/01.editors/01.atom/01.interface/en/project_tree.png differ diff --git a/pages/04.Contribute/02.git/01.editors/01.atom/01.interface/en/splitted.panels.png b/pages/04.Contribute/02.git/01.editors/01.atom/01.interface/en/splitted.panels.png new file mode 100755 index 00000000..0550c9f4 Binary files /dev/null and b/pages/04.Contribute/02.git/01.editors/01.atom/01.interface/en/splitted.panels.png differ diff --git a/pages/04.Contribute/02.git/01.editors/01.atom/01.interface/en/status.bar.png b/pages/04.Contribute/02.git/01.editors/01.atom/01.interface/en/status.bar.png new file mode 100755 index 00000000..20903169 Binary files /dev/null and b/pages/04.Contribute/02.git/01.editors/01.atom/01.interface/en/status.bar.png differ diff --git a/pages/04.Contribute/02.git/01.editors/01.atom/01.interface/en/unsaved.png b/pages/04.Contribute/02.git/01.editors/01.atom/01.interface/en/unsaved.png new file mode 100755 index 00000000..47410ad6 Binary files /dev/null and b/pages/04.Contribute/02.git/01.editors/01.atom/01.interface/en/unsaved.png differ diff --git a/pages/04.Contribute/02.git/01.editors/01.atom/02.working/docs.en.md b/pages/04.Contribute/02.git/01.editors/01.atom/02.working/docs.en.md new file mode 100755 index 00000000..30eb754b --- /dev/null +++ b/pages/04.Contribute/02.git/01.editors/01.atom/02.working/docs.en.md @@ -0,0 +1,203 @@ +--- +title: Working with Atom + Git +published: true +visible: true +updated: +taxonomy: + category: + - docs + tags: + - contribute + - atom + - git +page-toc: + active: true +--- + +# Working with Atom + Git +Finally we get to the most interesting part! Let's review what we have done so far. + +We have got an exact copy of the **Disroot Howto** folder where are all the files we can see online when we need to learn something about how a service works or how to configure a client. + +We have **cloned** the repository and we did it using our first git command: `git clone`. The next step will be to create a **branch**. + +## Creating branches +Every git project, the Howto's project in this case, has a **main** branch (or master branch) which contains all the files we can see in *production*. The changes we make on this branch are automatically synced with the site, and become visible immediately. And that is the reason why adding any changes to this **main** branch is restricted to the owners of the project. + +In general terms, a branch is basically an independent workspace created from the main line of development on which we can work and test things without compromising the original code. + +![](en/branches.png) + +In the image above we have the Howto's site content represented by the main line (main). Suppose we want to translate one of its tutorials. We create a new branch (branch 1) and we start working locally on it. While we are translating, someone else wants to start writing a new howto so creates a new branch (branch 2) for that purpose. As we can see, all this happens in parallel and at the same time but without affecting the main branch. + +When the translation is done, it is "submitted" to the remote repository to be reviewed and integrated to the production line. In the meantime, the writing of the new howto continues and when it is ready it follows the same process, it is reviewed, updated with the changes introduced by the other branches if necessary and finally it is also integrated to the main one. + +OK. Let's create our branch so we can start working. + +In the bottom-right corner of **Atom**, click on **master** (or any other branch name) and choose **New Branch**. A good practice is to give it a name descriptive enough so that others can easily figure out what we are working on when they see it. For example, if we plan to translate the Nextcloud howto, we could call it "cloud_language_translation" or something similar. + +Once we are done we press **Enter** on our keyboard. + +![](en/atom-branch1.gif) + +In the terminal, we should use the `git branch` command like this: + +`git branch -b your.new.branch.name` + +To switch between branches we can also use this menu. Our current working branch is visible on the bottom bar. If we click on it other local branches will appear. + +![](en/atom-branch2.gif) + +Switching between branches in the terminal is done with the command `git checkout`. If, for example, we want to switch from our current branch to the main one, we should write: + +`git checkout master` + +And viceversa, from the main branch to our branch: + +`git checkout our.branch` + +### Publishing our branch +We have created a local branch and we can start translating or writing a howto. For this branch we just created to also exist in the remote repository we need to **publish** it. In Atom it is done using the **Publish** function. When we click on it, we will be asked to enter our credentials. We need to enter our Gitea username and password. + +![](en/publish.png) + +In the terminal this can be done with the `git push` command, specifying the remote and the branch name we want to push. In our case it would be: + +`git push origin our.branch.name` + +When we cloned the **Howto** repository, Git automatically set up its URL as the default "remote" called `origin`. In Git a "remote" is an "alias" for a repository, so we can use this "alias" (origin in this case) instead of writing the entire URL of the remote repository every time we need to interact with it. + +To understand this, we can write the command `git remote -v` to see the remotes we have set up in our local repository and the URLs that they refer to. + +![](en/remote.png) + +Now that we have created a branch and already published it, we can create new files and modify the existing ones on this (our) branch. + +## Committing changes +We are now on our computer translating an existing tutorial or creating a new one and we have been saving the changes we made (using `Ctrl`+`s`, for example) but those changes are only saved in our text editor. We need to **commit** them to our branch first to then "push" them to the remote repository. + +So, the first thing we need to understand is that a **commit** is not like doing `Ctrl`+`s` because Git is not "just a backup system". A **commit** is more like a snapshot of our project folder at a certain point. The main idea behind a version control system (Git in this case) is being able to keep track of all the changes made to our code over time so we can look back and check when, how and why it has "evolved". Every commit is, then, a "milestone" in the track history of our project. And every "milestone" is accompanied by a message which describes what has changed. We need to keep in mind that the more commits we make the more populated gets the project timeline, thus increasing the chances of generate a "confusing" record history. + +In a very general way, we could say a commit is a set of files created or modified on our local branch that we want to "submit" to the remote git repository. + +So when we have decided to create a commit we need to "tell" Git what we want to include in it. + +To do a "commit" of the changes is a process that consists of the following steps: + +1. Make sure we have saved all the modified files, +2. "stage" those files we want to commit, +3. write a descriptive "commit message" (a short and very specific summary of what has been changed), and finally +4. commit the files. + +All the changes we have done so far in our local branch, they were made in our "working directory" and now we need to "move" them to the "staging" area. "Staging" refers to the moment in which those changes are selected to be included in the next commit. + +In Atom, this process is incredibly easy. Let's check the process again: + +![](en/committing.png) + +1. Make sure all files are saved and **Stage all** the files we have modified and want to commit to the repo, +2. once they are in the "staging area" we can now +3. write a **commit message** and finally +4. commit the changes by clicking the **Commit** button. + +![](en/atom-commit.gif) + +Now let's see how to do the same but in the terminal. + +1. The Git command to "move" the files from the "working directory" to the "staging area" is `git add` and if we only have a file or two to **add** we can simply write: + + `git add our.file` + + But if we have several files to commit we do not need to add the changes file by file. We can use + + `git add .` + + and it will include all the current changes into the next commit. + +2. Now that the files are in the "staging area" we need to commit them. We can do that by using the `git commit` command with the option `-m` to write a commit message. For example: + + `git commit -m "my commit message"` + + Note that the commit message must be wrapped in quotations `"` `"`. + + If we do not use the `-m` option then we will be prompted to add a message in our default text editor. + + Another useful option is `-a`. It not only will automatically stages all modified files to be committed but we can also skip the `git add` command with it. For example, writing: + + `git commit -a -m "my commit message"` or + + `git commit -am "my commit message"` + +Once the files are committed, it is time to **push** (send) them to the remote repository. + +## Pushing the changes +We have committed all the changes in our local branch and we want now "upload" them to the remote repository. + +In Atom this can be done by simply clicking on the **Push** option in the bottom bar. + +![](en/atom-push.gif) + +In the terminal, we have already seen the command to do this: `git push`. So, to push our local changes to the remote branch we have to write: + +`git push origin our.branch.name` + +## Requesting a Merge + +![](en/git-merge_chaos.gif) + +**Merging** is the process of integrating commits from different branches. Usually (but not only) the commits made on a given branch into the main one. + +Once we think our work is finished and ready to be published on the website, it is time to merge it to the **main branch**. + +This merge operation is done by the **Disroot** admins. But it is us who have to request that it be done. + +In **Gitea** it is called **Pull Request** and the procedure, in principle, is pretty simple. + +1. We go to **Disroot's Git** site at [**git.disroot.org**](https://git.disroot.org) and login with our **Gitea** credentials. + +2. Next we need to look for our branch in the **Howto** repository, select it and then click on the **New Pull Request** button. + +![](en/pull.request.gif) + +3. In the next page we can do a last and more visual revision of the commits we have made and, if we find it OK, then press the **New Pull Request** again. + +![](en/pull.request.2.png) + +4. Now we are required to write a "merge request" message. It does not need to be long and detailed but descriptive enough, similar to the commit message one, in order to make it easy to others to know what the changes are about. We can also (and it is recommended) add labels for better identification. + +![](en/pull.request.3.png) + +5. In the last step we can assign "Reviewers", add "Labels" (if we did not do it previously), link our Pull Request to a "Milestone" or a "Project" and define who will be assigned to manage the request (usually the same **Disroot** admins with whom we have been in contact in the Howto's XMPP room). + +![](en/pull.request.4.png) + +That's it. \O/ + +Once the Pull Request is done, it will be reviewed by **Disroot** admins. If it is all right and the documentation meets the **Disroot** guidelines, they can approve our commits then. This means our changes will be merged with the main branch and therefore visible on the website. + +If there is any issue, admins could request us to correct something. And, again, once all the corrections are made, our Pull Request will be merged to the main branch. + +## Pulling changes from the repository +Pull is an operation to update a local version of a remote repository. + +If we want to keep the local main branch for future translations or howtos we will need to "pull" the changes integrated to the recently updated remote because ours will no longer be up-to-date with the remote main one. + +In Atom we only need to click on the **Pull** function at the right in the status bar. + +![](en/atom-pull.gif) + +In the terminal, this is done with the command `git pull`. So if we are still on our local branch and we want to "update" it after commits were sent and accepted, we need: + +1. Make sure we are on the local main branch or in another. We can use the `git branch` command which will shows us the branch we are + +2. Once we are on the main branch, write: + + `git pull` + + This will download the modifications added to the main branch and update our local copy with them. + +Since always there are people working on the code and it changes frequently, it is highly recommended to "pull" from the remote main branch to our local one - specially before we start working on new branch - so we can easily see what is new and what has changed recently. + +--- + +Check [Troubleshooting](troubleshooting) for more help and common conflict situations diff --git a/pages/04.Contribute/01.git/how-to-use-git/de/atom-branch1.gif b/pages/04.Contribute/02.git/01.editors/01.atom/02.working/en/atom-branch1.gif old mode 100644 new mode 100755 similarity index 100% rename from pages/04.Contribute/01.git/how-to-use-git/de/atom-branch1.gif rename to pages/04.Contribute/02.git/01.editors/01.atom/02.working/en/atom-branch1.gif diff --git a/pages/04.Contribute/01.git/how-to-use-git/de/atom-branch2.gif b/pages/04.Contribute/02.git/01.editors/01.atom/02.working/en/atom-branch2.gif old mode 100644 new mode 100755 similarity index 100% rename from pages/04.Contribute/01.git/how-to-use-git/de/atom-branch2.gif rename to pages/04.Contribute/02.git/01.editors/01.atom/02.working/en/atom-branch2.gif diff --git a/pages/04.Contribute/01.git/how-to-use-git/de/atom-commit.gif b/pages/04.Contribute/02.git/01.editors/01.atom/02.working/en/atom-commit.gif old mode 100644 new mode 100755 similarity index 100% rename from pages/04.Contribute/01.git/how-to-use-git/de/atom-commit.gif rename to pages/04.Contribute/02.git/01.editors/01.atom/02.working/en/atom-commit.gif diff --git a/pages/04.Contribute/01.git/how-to-use-git/en/atom-pull.gif b/pages/04.Contribute/02.git/01.editors/01.atom/02.working/en/atom-pull.gif similarity index 100% rename from pages/04.Contribute/01.git/how-to-use-git/en/atom-pull.gif rename to pages/04.Contribute/02.git/01.editors/01.atom/02.working/en/atom-pull.gif diff --git a/pages/04.Contribute/01.git/how-to-use-git/de/atom-pull_push.png b/pages/04.Contribute/02.git/01.editors/01.atom/02.working/en/atom-pull_push.png old mode 100644 new mode 100755 similarity index 100% rename from pages/04.Contribute/01.git/how-to-use-git/de/atom-pull_push.png rename to pages/04.Contribute/02.git/01.editors/01.atom/02.working/en/atom-pull_push.png diff --git a/pages/04.Contribute/01.git/how-to-use-git/de/atom-push.gif b/pages/04.Contribute/02.git/01.editors/01.atom/02.working/en/atom-push.gif old mode 100644 new mode 100755 similarity index 100% rename from pages/04.Contribute/01.git/how-to-use-git/de/atom-push.gif rename to pages/04.Contribute/02.git/01.editors/01.atom/02.working/en/atom-push.gif diff --git a/pages/04.Contribute/02.git/01.editors/01.atom/02.working/en/branches.png b/pages/04.Contribute/02.git/01.editors/01.atom/02.working/en/branches.png new file mode 100755 index 00000000..84145fb9 Binary files /dev/null and b/pages/04.Contribute/02.git/01.editors/01.atom/02.working/en/branches.png differ diff --git a/pages/04.Contribute/02.git/01.editors/01.atom/02.working/en/committing.png b/pages/04.Contribute/02.git/01.editors/01.atom/02.working/en/committing.png new file mode 100755 index 00000000..2f061735 Binary files /dev/null and b/pages/04.Contribute/02.git/01.editors/01.atom/02.working/en/committing.png differ diff --git a/pages/04.Contribute/01.git/how-to-use-git/de/git-merge_chaos.gif b/pages/04.Contribute/02.git/01.editors/01.atom/02.working/en/git-merge_chaos.gif old mode 100644 new mode 100755 similarity index 100% rename from pages/04.Contribute/01.git/how-to-use-git/de/git-merge_chaos.gif rename to pages/04.Contribute/02.git/01.editors/01.atom/02.working/en/git-merge_chaos.gif diff --git a/pages/04.Contribute/01.git/how-to-use-git/en/git-merge_request.gif b/pages/04.Contribute/02.git/01.editors/01.atom/02.working/en/git-merge_request.gif similarity index 100% rename from pages/04.Contribute/01.git/how-to-use-git/en/git-merge_request.gif rename to pages/04.Contribute/02.git/01.editors/01.atom/02.working/en/git-merge_request.gif diff --git a/pages/04.Contribute/01.git/how-to-use-git/en/git-request_access.png b/pages/04.Contribute/02.git/01.editors/01.atom/02.working/en/git-request_access.png similarity index 100% rename from pages/04.Contribute/01.git/how-to-use-git/en/git-request_access.png rename to pages/04.Contribute/02.git/01.editors/01.atom/02.working/en/git-request_access.png diff --git a/pages/04.Contribute/01.git/how-to-use-git/en/howto-duplicate1.gif b/pages/04.Contribute/02.git/01.editors/01.atom/02.working/en/howto-duplicate1.gif similarity index 100% rename from pages/04.Contribute/01.git/how-to-use-git/en/howto-duplicate1.gif rename to pages/04.Contribute/02.git/01.editors/01.atom/02.working/en/howto-duplicate1.gif diff --git a/pages/04.Contribute/01.git/how-to-use-git/de/howto-fork.gif b/pages/04.Contribute/02.git/01.editors/01.atom/02.working/en/howto-fork.gif old mode 100644 new mode 100755 similarity index 100% rename from pages/04.Contribute/01.git/how-to-use-git/de/howto-fork.gif rename to pages/04.Contribute/02.git/01.editors/01.atom/02.working/en/howto-fork.gif diff --git a/pages/04.Contribute/01.git/how-to-use-git/en/publish.png b/pages/04.Contribute/02.git/01.editors/01.atom/02.working/en/publish.png old mode 100644 new mode 100755 similarity index 100% rename from pages/04.Contribute/01.git/how-to-use-git/en/publish.png rename to pages/04.Contribute/02.git/01.editors/01.atom/02.working/en/publish.png diff --git a/pages/04.Contribute/02.git/01.editors/01.atom/02.working/en/pull.request.2.png b/pages/04.Contribute/02.git/01.editors/01.atom/02.working/en/pull.request.2.png new file mode 100755 index 00000000..6b89eceb Binary files /dev/null and b/pages/04.Contribute/02.git/01.editors/01.atom/02.working/en/pull.request.2.png differ diff --git a/pages/04.Contribute/02.git/01.editors/01.atom/02.working/en/pull.request.3.png b/pages/04.Contribute/02.git/01.editors/01.atom/02.working/en/pull.request.3.png new file mode 100755 index 00000000..f65819fd Binary files /dev/null and b/pages/04.Contribute/02.git/01.editors/01.atom/02.working/en/pull.request.3.png differ diff --git a/pages/04.Contribute/02.git/01.editors/01.atom/02.working/en/pull.request.4.png b/pages/04.Contribute/02.git/01.editors/01.atom/02.working/en/pull.request.4.png new file mode 100755 index 00000000..726c1426 Binary files /dev/null and b/pages/04.Contribute/02.git/01.editors/01.atom/02.working/en/pull.request.4.png differ diff --git a/pages/04.Contribute/02.git/01.editors/01.atom/02.working/en/pull.request.gif b/pages/04.Contribute/02.git/01.editors/01.atom/02.working/en/pull.request.gif new file mode 100755 index 00000000..37d25048 Binary files /dev/null and b/pages/04.Contribute/02.git/01.editors/01.atom/02.working/en/pull.request.gif differ diff --git a/pages/04.Contribute/02.git/01.editors/01.atom/02.working/en/remote.png b/pages/04.Contribute/02.git/01.editors/01.atom/02.working/en/remote.png new file mode 100755 index 00000000..563d4be0 Binary files /dev/null and b/pages/04.Contribute/02.git/01.editors/01.atom/02.working/en/remote.png differ diff --git a/pages/04.Contribute/01.git/how-to-use-git/en/template.txt b/pages/04.Contribute/02.git/01.editors/01.atom/02.working/en/template.txt old mode 100644 new mode 100755 similarity index 100% rename from pages/04.Contribute/01.git/how-to-use-git/en/template.txt rename to pages/04.Contribute/02.git/01.editors/01.atom/02.working/en/template.txt diff --git a/pages/04.Contribute/02.git/01.editors/docs.en.md b/pages/04.Contribute/02.git/01.editors/docs.en.md new file mode 100755 index 00000000..e4a5e186 --- /dev/null +++ b/pages/04.Contribute/02.git/01.editors/docs.en.md @@ -0,0 +1,27 @@ +--- +title: "Working with Editors" +published: true +visible: true +indexed: true +updated: +taxonomy: + category: + - docs + tags: + - contribute + - git + - editors + - atom +page-toc: + active: true +--- + +# Editors +The easiest way to work and edit the **Howto** files is through a text editor with Git integrated. + +As we mentioned before, for practical reasons, we will only see how to do it in **Atom Text Editor**, although you can choose to use any other. Along with every step to follow in the editor we will also see the Git commands in the terminal to learn and understand what are Atom and Git doing. + +We will try to add more howtos about using other editors in the future. If you want and have time, you can also write one yourself about your favorite editor and we can add it to this section. + + +## [Atom](atom/interface) diff --git a/pages/04.Contribute/02.git/02.Troubleshooting/docs.en.md b/pages/04.Contribute/02.git/02.Troubleshooting/docs.en.md new file mode 100755 index 00000000..86c34133 --- /dev/null +++ b/pages/04.Contribute/02.git/02.Troubleshooting/docs.en.md @@ -0,0 +1,43 @@ +--- +title: Troubleshooting +subtitle: +published: true +visible: true +indexed: true +updated: +taxonomy: + category: + - docs + tags: + - contribute + - git + - troubleshooting +page-toc: + active: true +--- + +# Troubleshooting + +# Our local branch is "behind" the remote main branch +While we are working on your branch, other users possibly commit and merge their own changes, especially if we are working on existing files. If those changes from the other users have already been merged to the **main branch**, the version of the files we changed may no longer be the actual ones and therefore the changes from other users may not be included in our files. In that case, if we want to let our changes be merged to the **main branch**, the process could become quite complicated. + +We need to update our branch **before** we **request** a **Pull** (a merge request). By doing this we will spare the admins and ourselves a lot of needless work. + +In Git there are two ways that allow us to integrate/merge/update branches: **git merge** and **git rebase**. + +**Git merge** compares the last two commits of each branch and the "common ancestor" of both branches we want to merge and creates a new commit with the changes. + +**Git rebase** tracks one by one the commits made on one branch and "replicates" them into other. This is helpful only if we apply it on the local commits that are not "uploaded" to any remote repository. If we do the "rebase" on a local branch which commits were already pushed to the remote one, we will surely have lots of conflicts. + +So if we are working on a local branch and we want to integrate to it the changes made to the remote main branch we will need to "rebase". + +To rebase: +1. Make sure all the changes are committed (locally) + +2. In the terminal: + - switch to the **Main Branch**: `git checkout master`; + - update the **Main Branch**: `git pull`; + - switch back to our working branch: `git checkout our.branch`; + - update our working branch from the updated **Main Branch**: `git rebase master`. + +3. Finally, verify the changes and commit the changes to the remote repository. diff --git a/pages/04.Contribute/02.git/docs.en.md b/pages/04.Contribute/02.git/docs.en.md new file mode 100755 index 00000000..7f4f75b6 --- /dev/null +++ b/pages/04.Contribute/02.git/docs.en.md @@ -0,0 +1,86 @@ +--- +title: "Git" +published: true +visible: true +indexed: true +updated: +taxonomy: + category: + - docs + tags: + - contribute + - git + - settings +page-toc: + active: true +--- + +# Git? +Yes, **Git**. It is a control version system, a software that allows us to track modifications to files, keeping a record of all the changes made, so if we need to revert to a specific version we 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. + +To learn the basics of Git and to work with it can be not only very useful but also a fun experience. + + +# Scope of this tutorial +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.
+So the aim of the following tutorials is to introduce you to the basics of Git, the main tool we use to manage the **Howto** project files. Therefore, we will not cover all the aspects of its usage, only some basic concepts and commands. + +If you get more interested about Git, there are lots of in-depth tutorials and documentation written about it that you can easily find on the internet. + + +# What does Git do?: Basic concepts + +![](en/git.png) + +When you read a **Disroot** tutorial, what you are seeing is the representation in your browser of a piece of code, in our case, a text file written in a formatting syntax called **Markdown**. The entire code of this site and its content is hosted in a **Git repository**, a folder containing all the project files and the changes history of each and every one of those files (what has changed, who has changed it and why it has changed). + +In this repository (or repo) there is a **main branch** (or "master branch"), which is the default project line of development and from which different other branches can be created without compromising it. + +Think of a tree: the "main branch" would be the trunk from which different branches "grow and develop". Once they complete their cycle, they can be integrated into the "trunk" or even "fall" from it without affecting it. + +So, the main branch is the one that contains the code we see online (or "in production") and the branches we create are the ones that contain our work. + +![](en/git_branches.png) + +This way, when a tutorial needs to be modified (e.g., because some software has been updated, typos were found in a document, there is information to be added/removed, etc) or translated, what we do is copy the remote repository into our machine so we can work locally on the files. This procedure is called **cloning** and once it is done, all modifications and Git operations are managed from our local repository. + +## Cloning the **Howto Disroot** repository +As we mentioned before, the process of getting a copy of all the files within the project is called "**to clone**" a repository. And once we have cloned it, all modifications will be done on this copy in our local machine (most of the work is done offline). + +To clone the repository we just open a terminal, navigate to the directory we would like to clone the repository to, and run the `git clone` command, that is, we are "telling" git through this command to "download" it. The command is followed by the **url address** of the repo we want to clone. In our case it would be: + +`git clone https://git.disroot.org/Disroot/Howto` + +If we want to translate a page from the **Disroot Website** then we write: + +`git clone https://git.disroot.org/Disroot/Website` + +The process will then begin and in a few minutes, depending on our internet connection, we will have the repository "cloned" on our machine. + +![](en/cloning.png) + +Once this process has been completed, we will see a `Howto` (or a `Website`) directory containing all the files of the site. We can later move that directory to any place we want on our computer. + +Now, before we really get to work, let's setup our identity so we can move forward without distractions. + +## Setting your identity +In order to be able to send our work from our machine to the remote repository, it is necessary to setup our username and email. This information is used by Git to "sign" the commits (the "snapshots" of our modifications, we will see this later on). + +1. We open a terminal in (or navigate to) the directory/folder where we have the cloned repository. + +2. Type and complete with your information the following commands:
+`git config --global user.email` **user@email** `<- here goes your email address`
+`git config --global user.name` **"Username"** `<- and here your username` + +We will not need to enter this information again. + +## Requesting access to the Disroot repository +The faster and recommended way to request access is via our **Howto Chat room** at `howto@chat.disroot.org`. You can also send us an email to `howto@disroot.org`. + +Once admins grant you the access, you will be able to "*push*" (send) your changes to the server. + +!! **NOTE**
+!! You could start working without access granted as all the changes happen on your local computer, and requesting it later. + + +Ok. Let's move on. diff --git a/pages/04.Contribute/02.git/en/Screenshot_20220102_015258.png b/pages/04.Contribute/02.git/en/Screenshot_20220102_015258.png new file mode 100755 index 00000000..c61bb4de Binary files /dev/null and b/pages/04.Contribute/02.git/en/Screenshot_20220102_015258.png differ diff --git a/pages/04.Contribute/02.git/en/cloning.png b/pages/04.Contribute/02.git/en/cloning.png new file mode 100755 index 00000000..a338fbce Binary files /dev/null and b/pages/04.Contribute/02.git/en/cloning.png differ diff --git a/pages/04.Contribute/02.git/en/git.png b/pages/04.Contribute/02.git/en/git.png new file mode 100755 index 00000000..3f35d2d7 Binary files /dev/null and b/pages/04.Contribute/02.git/en/git.png differ diff --git a/pages/04.Contribute/02.git/en/git_branches.png b/pages/04.Contribute/02.git/en/git_branches.png new file mode 100755 index 00000000..4bd20159 Binary files /dev/null and b/pages/04.Contribute/02.git/en/git_branches.png differ diff --git a/pages/04.Contribute/02.git/en/global.config.png b/pages/04.Contribute/02.git/en/global.config.png new file mode 100755 index 00000000..b434a55d Binary files /dev/null and b/pages/04.Contribute/02.git/en/global.config.png differ diff --git a/pages/04.Contribute/07.Styleguide/de/Name_des_Verzeichnisses_voller_Mediendateien/Beispiel_1.png b/pages/04.Contribute/03.styleguide/de/Name_des_Verzeichnisses_voller_Mediendateien/Beispiel_1.png old mode 100644 new mode 100755 similarity index 100% rename from pages/04.Contribute/07.Styleguide/de/Name_des_Verzeichnisses_voller_Mediendateien/Beispiel_1.png rename to pages/04.Contribute/03.styleguide/de/Name_des_Verzeichnisses_voller_Mediendateien/Beispiel_1.png diff --git a/pages/04.Contribute/07.Styleguide/de/commodore.jpg b/pages/04.Contribute/03.styleguide/de/commodore.jpg old mode 100644 new mode 100755 similarity index 100% rename from pages/04.Contribute/07.Styleguide/de/commodore.jpg rename to pages/04.Contribute/03.styleguide/de/commodore.jpg diff --git a/pages/04.Contribute/07.Styleguide/de/licensing-pic.png b/pages/04.Contribute/03.styleguide/de/licensing-pic.png old mode 100644 new mode 100755 similarity index 100% rename from pages/04.Contribute/07.Styleguide/de/licensing-pic.png rename to pages/04.Contribute/03.styleguide/de/licensing-pic.png diff --git a/pages/04.Contribute/07.Styleguide/de/thing2.jpg b/pages/04.Contribute/03.styleguide/de/thing2.jpg old mode 100644 new mode 100755 similarity index 100% rename from pages/04.Contribute/07.Styleguide/de/thing2.jpg rename to pages/04.Contribute/03.styleguide/de/thing2.jpg diff --git a/pages/04.Contribute/07.Styleguide/docs.de.md b/pages/04.Contribute/03.styleguide/docs.de.md old mode 100644 new mode 100755 similarity index 100% rename from pages/04.Contribute/07.Styleguide/docs.de.md rename to pages/04.Contribute/03.styleguide/docs.de.md diff --git a/pages/04.Contribute/07.Styleguide/docs.en.md b/pages/04.Contribute/03.styleguide/docs.en.md old mode 100644 new mode 100755 similarity index 100% rename from pages/04.Contribute/07.Styleguide/docs.en.md rename to pages/04.Contribute/03.styleguide/docs.en.md diff --git a/pages/04.Contribute/07.Styleguide/en/commodore.jpg b/pages/04.Contribute/03.styleguide/en/commodore.jpg old mode 100644 new mode 100755 similarity index 100% rename from pages/04.Contribute/07.Styleguide/en/commodore.jpg rename to pages/04.Contribute/03.styleguide/en/commodore.jpg diff --git a/pages/04.Contribute/07.Styleguide/en/licensing-pic.png b/pages/04.Contribute/03.styleguide/en/licensing-pic.png old mode 100644 new mode 100755 similarity index 100% rename from pages/04.Contribute/07.Styleguide/en/licensing-pic.png rename to pages/04.Contribute/03.styleguide/en/licensing-pic.png diff --git a/pages/04.Contribute/07.Styleguide/en/name_of_folder_full_of_media_files/example_1.png b/pages/04.Contribute/03.styleguide/en/name_of_folder_full_of_media_files/example_1.png old mode 100644 new mode 100755 similarity index 100% rename from pages/04.Contribute/07.Styleguide/en/name_of_folder_full_of_media_files/example_1.png rename to pages/04.Contribute/03.styleguide/en/name_of_folder_full_of_media_files/example_1.png diff --git a/pages/04.Contribute/07.Styleguide/en/thing2.jpg b/pages/04.Contribute/03.styleguide/en/thing2.jpg old mode 100644 new mode 100755 similarity index 100% rename from pages/04.Contribute/07.Styleguide/en/thing2.jpg rename to pages/04.Contribute/03.styleguide/en/thing2.jpg diff --git a/pages/04.Contribute/contribute.jpg b/pages/04.Contribute/contribute.jpg new file mode 100755 index 00000000..959e207b Binary files /dev/null and b/pages/04.Contribute/contribute.jpg differ diff --git a/pages/04.Contribute/docs.en.md b/pages/04.Contribute/docs.en.md index 55d2756b..e81e344c 100755 --- a/pages/04.Contribute/docs.en.md +++ b/pages/04.Contribute/docs.en.md @@ -1,5 +1,5 @@ --- -title: How-to: Contribute +title: How-to Contribute published: true visible: true updated: @@ -14,15 +14,21 @@ page-toc: # Contribute -We think that knowledge is a collective construction. In other words, knowledge is the result of working together and cooperatively, as a community. +![](contribute.jpg) -Disroot platform cost money besides our most precious value: time. While the costs of maintaining all the services working on started being covered a few months ago thanks to donations, documentation requires time. -*"A lot of precious time..."* +We think that knowledge is a collective construction: the result of working together and cooperatively, as a community. And whether the contributions take the form of a donation, writing/translating a tutorial or reporting bugs, they are all essentially personal time devoted to others. A bit like love. + +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. + +So, for those of you who may want to contribute by donating your time and knowhow, we have tried to channel all the efforts through this section. -For those users who may want to contribute to Disroot by donating their time and knowhow, we've tried to channel all the efforts through this section. Here you'll find basic information and guidelines for different ways to contribute, from feedback to write a how-to or translate them to your language. -Thanks to all of you who support and collaborate with Disroot. +--- +# Table of Contents -![](contribute.png) +## · [Howto Procedure & Tools](procedure) +## · [Git: Configuration & set-up](git) +## · [Working with a text editor](git/editors) diff --git a/pages/04.Contribute/00.ways2contribute/docs.de.md b/pages/archive/Contribute.Old/00.ways2contribute/docs.de.md similarity index 100% rename from pages/04.Contribute/00.ways2contribute/docs.de.md rename to pages/archive/Contribute.Old/00.ways2contribute/docs.de.md diff --git a/pages/04.Contribute/00.ways2contribute/docs.en.md b/pages/archive/Contribute.Old/00.ways2contribute/docs.en.md similarity index 100% rename from pages/04.Contribute/00.ways2contribute/docs.en.md rename to pages/archive/Contribute.Old/00.ways2contribute/docs.en.md diff --git a/pages/04.Contribute/00.ways2contribute/docs.es.md b/pages/archive/Contribute.Old/00.ways2contribute/docs.es.md similarity index 100% rename from pages/04.Contribute/00.ways2contribute/docs.es.md rename to pages/archive/Contribute.Old/00.ways2contribute/docs.es.md diff --git a/pages/04.Contribute/00.ways2contribute/docs.pt.md b/pages/archive/Contribute.Old/00.ways2contribute/docs.pt.md similarity index 100% rename from pages/04.Contribute/00.ways2contribute/docs.pt.md rename to pages/archive/Contribute.Old/00.ways2contribute/docs.pt.md diff --git a/pages/04.Contribute/01.git/de/git.png b/pages/archive/Contribute.Old/01.git/de/git.png similarity index 100% rename from pages/04.Contribute/01.git/de/git.png rename to pages/archive/Contribute.Old/01.git/de/git.png diff --git a/pages/04.Contribute/01.git/de/gitlab.png b/pages/archive/Contribute.Old/01.git/de/gitlab.png similarity index 100% rename from pages/04.Contribute/01.git/de/gitlab.png rename to pages/archive/Contribute.Old/01.git/de/gitlab.png diff --git a/pages/04.Contribute/01.git/docs.de.md b/pages/archive/Contribute.Old/01.git/docs.de.md similarity index 100% rename from pages/04.Contribute/01.git/docs.de.md rename to pages/archive/Contribute.Old/01.git/docs.de.md diff --git a/pages/04.Contribute/01.git/docs.en.md b/pages/archive/Contribute.Old/01.git/docs.en.md similarity index 100% rename from pages/04.Contribute/01.git/docs.en.md rename to pages/archive/Contribute.Old/01.git/docs.en.md diff --git a/pages/04.Contribute/01.git/en/git.png b/pages/archive/Contribute.Old/01.git/en/git.png similarity index 100% rename from pages/04.Contribute/01.git/en/git.png rename to pages/archive/Contribute.Old/01.git/en/git.png diff --git a/pages/04.Contribute/01.git/en/gitlab.png b/pages/archive/Contribute.Old/01.git/en/gitlab.png similarity index 100% rename from pages/04.Contribute/01.git/en/gitlab.png rename to pages/archive/Contribute.Old/01.git/en/gitlab.png diff --git a/pages/04.Contribute/01.git/how-to-use-git/en/atom-branch1.gif b/pages/archive/Contribute.Old/01.git/how-to-use-git/de/atom-branch1.gif old mode 100755 new mode 100644 similarity index 100% rename from pages/04.Contribute/01.git/how-to-use-git/en/atom-branch1.gif rename to pages/archive/Contribute.Old/01.git/how-to-use-git/de/atom-branch1.gif diff --git a/pages/04.Contribute/01.git/how-to-use-git/en/atom-branch2.gif b/pages/archive/Contribute.Old/01.git/how-to-use-git/de/atom-branch2.gif old mode 100755 new mode 100644 similarity index 100% rename from pages/04.Contribute/01.git/how-to-use-git/en/atom-branch2.gif rename to pages/archive/Contribute.Old/01.git/how-to-use-git/de/atom-branch2.gif diff --git a/pages/04.Contribute/01.git/how-to-use-git/en/atom-commit.gif b/pages/archive/Contribute.Old/01.git/how-to-use-git/de/atom-commit.gif old mode 100755 new mode 100644 similarity index 100% rename from pages/04.Contribute/01.git/how-to-use-git/en/atom-commit.gif rename to pages/archive/Contribute.Old/01.git/how-to-use-git/de/atom-commit.gif diff --git a/pages/04.Contribute/06.Translations_procedure/de/atom-pull.gif b/pages/archive/Contribute.Old/01.git/how-to-use-git/de/atom-pull.gif similarity index 100% rename from pages/04.Contribute/06.Translations_procedure/de/atom-pull.gif rename to pages/archive/Contribute.Old/01.git/how-to-use-git/de/atom-pull.gif diff --git a/pages/04.Contribute/01.git/how-to-use-git/en/atom-pull_push.png b/pages/archive/Contribute.Old/01.git/how-to-use-git/de/atom-pull_push.png old mode 100755 new mode 100644 similarity index 100% rename from pages/04.Contribute/01.git/how-to-use-git/en/atom-pull_push.png rename to pages/archive/Contribute.Old/01.git/how-to-use-git/de/atom-pull_push.png diff --git a/pages/04.Contribute/01.git/how-to-use-git/en/atom-push.gif b/pages/archive/Contribute.Old/01.git/how-to-use-git/de/atom-push.gif similarity index 100% rename from pages/04.Contribute/01.git/how-to-use-git/en/atom-push.gif rename to pages/archive/Contribute.Old/01.git/how-to-use-git/de/atom-push.gif diff --git a/pages/04.Contribute/01.git/how-to-use-git/en/atom1.png b/pages/archive/Contribute.Old/01.git/how-to-use-git/de/atom1.png old mode 100755 new mode 100644 similarity index 100% rename from pages/04.Contribute/01.git/how-to-use-git/en/atom1.png rename to pages/archive/Contribute.Old/01.git/how-to-use-git/de/atom1.png diff --git a/pages/04.Contribute/01.git/how-to-use-git/en/atom_interface1.png b/pages/archive/Contribute.Old/01.git/how-to-use-git/de/atom_interface1.png old mode 100755 new mode 100644 similarity index 100% rename from pages/04.Contribute/01.git/how-to-use-git/en/atom_interface1.png rename to pages/archive/Contribute.Old/01.git/how-to-use-git/de/atom_interface1.png diff --git a/pages/04.Contribute/01.git/how-to-use-git/en/git-merge_chaos.gif b/pages/archive/Contribute.Old/01.git/how-to-use-git/de/git-merge_chaos.gif similarity index 100% rename from pages/04.Contribute/01.git/how-to-use-git/en/git-merge_chaos.gif rename to pages/archive/Contribute.Old/01.git/how-to-use-git/de/git-merge_chaos.gif diff --git a/pages/04.Contribute/06.Translations_procedure/de/git-merge_request.gif b/pages/archive/Contribute.Old/01.git/how-to-use-git/de/git-merge_request.gif similarity index 100% rename from pages/04.Contribute/06.Translations_procedure/de/git-merge_request.gif rename to pages/archive/Contribute.Old/01.git/how-to-use-git/de/git-merge_request.gif diff --git a/pages/04.Contribute/06.Translations_procedure/de/git-request_access.png b/pages/archive/Contribute.Old/01.git/how-to-use-git/de/git-request_access.png similarity index 100% rename from pages/04.Contribute/06.Translations_procedure/de/git-request_access.png rename to pages/archive/Contribute.Old/01.git/how-to-use-git/de/git-request_access.png diff --git a/pages/04.Contribute/06.Translations_procedure/de/howto-duplicate1.gif b/pages/archive/Contribute.Old/01.git/how-to-use-git/de/howto-duplicate1.gif similarity index 100% rename from pages/04.Contribute/06.Translations_procedure/de/howto-duplicate1.gif rename to pages/archive/Contribute.Old/01.git/how-to-use-git/de/howto-duplicate1.gif diff --git a/pages/04.Contribute/01.git/how-to-use-git/en/howto-fork.gif b/pages/archive/Contribute.Old/01.git/how-to-use-git/de/howto-fork.gif old mode 100755 new mode 100644 similarity index 100% rename from pages/04.Contribute/01.git/how-to-use-git/en/howto-fork.gif rename to pages/archive/Contribute.Old/01.git/how-to-use-git/de/howto-fork.gif diff --git a/pages/04.Contribute/01.git/how-to-use-git/en/note.png b/pages/archive/Contribute.Old/01.git/how-to-use-git/de/note.png similarity index 100% rename from pages/04.Contribute/01.git/how-to-use-git/en/note.png rename to pages/archive/Contribute.Old/01.git/how-to-use-git/de/note.png diff --git a/pages/04.Contribute/06.Translations_procedure/de/publish.png b/pages/archive/Contribute.Old/01.git/how-to-use-git/de/publish.png similarity index 100% rename from pages/04.Contribute/06.Translations_procedure/de/publish.png rename to pages/archive/Contribute.Old/01.git/how-to-use-git/de/publish.png diff --git a/pages/04.Contribute/01.git/how-to-use-git/de/template.txt b/pages/archive/Contribute.Old/01.git/how-to-use-git/de/template.txt similarity index 100% rename from pages/04.Contribute/01.git/how-to-use-git/de/template.txt rename to pages/archive/Contribute.Old/01.git/how-to-use-git/de/template.txt diff --git a/pages/04.Contribute/01.git/how-to-use-git/docs.de.md b/pages/archive/Contribute.Old/01.git/how-to-use-git/docs.de.md similarity index 100% rename from pages/04.Contribute/01.git/how-to-use-git/docs.de.md rename to pages/archive/Contribute.Old/01.git/how-to-use-git/docs.de.md diff --git a/pages/04.Contribute/01.git/how-to-use-git/docs.en.md b/pages/archive/Contribute.Old/01.git/how-to-use-git/docs.en.md similarity index 100% rename from pages/04.Contribute/01.git/how-to-use-git/docs.en.md rename to pages/archive/Contribute.Old/01.git/how-to-use-git/docs.en.md diff --git a/pages/04.Contribute/01.git/how-to-use-git/docs.es.md b/pages/archive/Contribute.Old/01.git/how-to-use-git/docs.es.md similarity index 100% rename from pages/04.Contribute/01.git/how-to-use-git/docs.es.md rename to pages/archive/Contribute.Old/01.git/how-to-use-git/docs.es.md diff --git a/pages/04.Contribute/01.git/how-to-use-git/docs.fr.md b/pages/archive/Contribute.Old/01.git/how-to-use-git/docs.fr.md similarity index 100% rename from pages/04.Contribute/01.git/how-to-use-git/docs.fr.md rename to pages/archive/Contribute.Old/01.git/how-to-use-git/docs.fr.md diff --git a/pages/04.Contribute/01.git/how-to-use-git/docs.pt.md b/pages/archive/Contribute.Old/01.git/how-to-use-git/docs.pt.md similarity index 100% rename from pages/04.Contribute/01.git/how-to-use-git/docs.pt.md rename to pages/archive/Contribute.Old/01.git/how-to-use-git/docs.pt.md diff --git a/pages/04.Contribute/06.Translations_procedure/en/branch_01.gif b/pages/archive/Contribute.Old/01.git/how-to-use-git/en/atom-branch1.gif similarity index 100% rename from pages/04.Contribute/06.Translations_procedure/en/branch_01.gif rename to pages/archive/Contribute.Old/01.git/how-to-use-git/en/atom-branch1.gif diff --git a/pages/archive/Contribute.Old/01.git/how-to-use-git/en/atom-branch2.gif b/pages/archive/Contribute.Old/01.git/how-to-use-git/en/atom-branch2.gif new file mode 100755 index 00000000..917dd695 Binary files /dev/null and b/pages/archive/Contribute.Old/01.git/how-to-use-git/en/atom-branch2.gif differ diff --git a/pages/04.Contribute/06.Translations_procedure/en/commit.gif b/pages/archive/Contribute.Old/01.git/how-to-use-git/en/atom-commit.gif similarity index 100% rename from pages/04.Contribute/06.Translations_procedure/en/commit.gif rename to pages/archive/Contribute.Old/01.git/how-to-use-git/en/atom-commit.gif diff --git a/pages/04.Contribute/06.Translations_procedure/en/atom-pull.gif b/pages/archive/Contribute.Old/01.git/how-to-use-git/en/atom-pull.gif similarity index 100% rename from pages/04.Contribute/06.Translations_procedure/en/atom-pull.gif rename to pages/archive/Contribute.Old/01.git/how-to-use-git/en/atom-pull.gif diff --git a/pages/04.Contribute/06.Translations_procedure/en/pull_push.png b/pages/archive/Contribute.Old/01.git/how-to-use-git/en/atom-pull_push.png similarity index 100% rename from pages/04.Contribute/06.Translations_procedure/en/pull_push.png rename to pages/archive/Contribute.Old/01.git/how-to-use-git/en/atom-pull_push.png diff --git a/pages/04.Contribute/06.Translations_procedure/en/push.gif b/pages/archive/Contribute.Old/01.git/how-to-use-git/en/atom-push.gif similarity index 100% rename from pages/04.Contribute/06.Translations_procedure/en/push.gif rename to pages/archive/Contribute.Old/01.git/how-to-use-git/en/atom-push.gif diff --git a/pages/04.Contribute/06.Translations_procedure/de/atom1.png b/pages/archive/Contribute.Old/01.git/how-to-use-git/en/atom1.png old mode 100644 new mode 100755 similarity index 100% rename from pages/04.Contribute/06.Translations_procedure/de/atom1.png rename to pages/archive/Contribute.Old/01.git/how-to-use-git/en/atom1.png diff --git a/pages/04.Contribute/06.Translations_procedure/de/atom_interface1.png b/pages/archive/Contribute.Old/01.git/how-to-use-git/en/atom_interface1.png old mode 100644 new mode 100755 similarity index 100% rename from pages/04.Contribute/06.Translations_procedure/de/atom_interface1.png rename to pages/archive/Contribute.Old/01.git/how-to-use-git/en/atom_interface1.png diff --git a/pages/04.Contribute/06.Translations_procedure/en/git-merge_chaos.gif b/pages/archive/Contribute.Old/01.git/how-to-use-git/en/git-merge_chaos.gif similarity index 100% rename from pages/04.Contribute/06.Translations_procedure/en/git-merge_chaos.gif rename to pages/archive/Contribute.Old/01.git/how-to-use-git/en/git-merge_chaos.gif diff --git a/pages/04.Contribute/06.Translations_procedure/en/git-merge_request.gif b/pages/archive/Contribute.Old/01.git/how-to-use-git/en/git-merge_request.gif similarity index 100% rename from pages/04.Contribute/06.Translations_procedure/en/git-merge_request.gif rename to pages/archive/Contribute.Old/01.git/how-to-use-git/en/git-merge_request.gif diff --git a/pages/04.Contribute/06.Translations_procedure/en/git-request_access.png b/pages/archive/Contribute.Old/01.git/how-to-use-git/en/git-request_access.png similarity index 100% rename from pages/04.Contribute/06.Translations_procedure/en/git-request_access.png rename to pages/archive/Contribute.Old/01.git/how-to-use-git/en/git-request_access.png diff --git a/pages/04.Contribute/06.Translations_procedure/en/howto-duplicate1.gif b/pages/archive/Contribute.Old/01.git/how-to-use-git/en/howto-duplicate1.gif similarity index 100% rename from pages/04.Contribute/06.Translations_procedure/en/howto-duplicate1.gif rename to pages/archive/Contribute.Old/01.git/how-to-use-git/en/howto-duplicate1.gif diff --git a/pages/archive/Contribute.Old/01.git/how-to-use-git/en/howto-fork.gif b/pages/archive/Contribute.Old/01.git/how-to-use-git/en/howto-fork.gif new file mode 100755 index 00000000..ecfece1d Binary files /dev/null and b/pages/archive/Contribute.Old/01.git/how-to-use-git/en/howto-fork.gif differ diff --git a/pages/04.Contribute/06.Translations_procedure/de/note.png b/pages/archive/Contribute.Old/01.git/how-to-use-git/en/note.png similarity index 100% rename from pages/04.Contribute/06.Translations_procedure/de/note.png rename to pages/archive/Contribute.Old/01.git/how-to-use-git/en/note.png diff --git a/pages/04.Contribute/06.Translations_procedure/en/publish.png b/pages/archive/Contribute.Old/01.git/how-to-use-git/en/publish.png similarity index 100% rename from pages/04.Contribute/06.Translations_procedure/en/publish.png rename to pages/archive/Contribute.Old/01.git/how-to-use-git/en/publish.png diff --git a/pages/archive/Contribute.Old/01.git/how-to-use-git/en/template.txt b/pages/archive/Contribute.Old/01.git/how-to-use-git/en/template.txt new file mode 100644 index 00000000..e80a1601 --- /dev/null +++ b/pages/archive/Contribute.Old/01.git/how-to-use-git/en/template.txt @@ -0,0 +1,26 @@ +--- +title: 'Template' +visible: false +page-toc: + active: true +published: true +taxonomy: + category: + - docs +--- + +--- + +|```Meta information```| +|:--:| +|```This howto was last updated on``` **date here** *(date format could be mm-dd-yy or yyyy-mm-dd, e.g: 01-04-19 or 2019-01-04)* ```and it refers to:```
**Software name: version 00.0.0-0 for GNU/Linux distro:**
| + +**NOTE:**```If the howto refers 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.```
**Disroot's** ```how-to documentation is a community driven procces. We try to keep it as updated as we can.``` + +--- +# Actual how to content comes here +--- + +
Creative Commons License
This work is licensed under a
Creative Commons Attribution-ShareAlike 4.0 International License.
+ +--- diff --git a/pages/04.Contribute/02.pad/docs.de.md b/pages/archive/Contribute.Old/02.pad/docs.de.md similarity index 100% rename from pages/04.Contribute/02.pad/docs.de.md rename to pages/archive/Contribute.Old/02.pad/docs.de.md diff --git a/pages/04.Contribute/02.pad/docs.en.md b/pages/archive/Contribute.Old/02.pad/docs.en.md similarity index 100% rename from pages/04.Contribute/02.pad/docs.en.md rename to pages/archive/Contribute.Old/02.pad/docs.en.md diff --git a/pages/04.Contribute/02.pad/docs.es.md b/pages/archive/Contribute.Old/02.pad/docs.es.md similarity index 100% rename from pages/04.Contribute/02.pad/docs.es.md rename to pages/archive/Contribute.Old/02.pad/docs.es.md diff --git a/pages/04.Contribute/02.pad/docs.pt.md b/pages/archive/Contribute.Old/02.pad/docs.pt.md similarity index 100% rename from pages/04.Contribute/02.pad/docs.pt.md rename to pages/archive/Contribute.Old/02.pad/docs.pt.md diff --git a/pages/04.Contribute/03.email/docs.de.md b/pages/archive/Contribute.Old/03.email/docs.de.md similarity index 100% rename from pages/04.Contribute/03.email/docs.de.md rename to pages/archive/Contribute.Old/03.email/docs.de.md diff --git a/pages/04.Contribute/03.email/docs.en.md b/pages/archive/Contribute.Old/03.email/docs.en.md similarity index 100% rename from pages/04.Contribute/03.email/docs.en.md rename to pages/archive/Contribute.Old/03.email/docs.en.md diff --git a/pages/04.Contribute/03.email/docs.es.md b/pages/archive/Contribute.Old/03.email/docs.es.md similarity index 100% rename from pages/04.Contribute/03.email/docs.es.md rename to pages/archive/Contribute.Old/03.email/docs.es.md diff --git a/pages/04.Contribute/03.email/docs.pt.md b/pages/archive/Contribute.Old/03.email/docs.pt.md similarity index 100% rename from pages/04.Contribute/03.email/docs.pt.md rename to pages/archive/Contribute.Old/03.email/docs.pt.md diff --git a/pages/04.Contribute/04.forum/docs.de.md b/pages/archive/Contribute.Old/04.forum/docs.de.md similarity index 100% rename from pages/04.Contribute/04.forum/docs.de.md rename to pages/archive/Contribute.Old/04.forum/docs.de.md diff --git a/pages/04.Contribute/04.forum/docs.en.md b/pages/archive/Contribute.Old/04.forum/docs.en.md similarity index 100% rename from pages/04.Contribute/04.forum/docs.en.md rename to pages/archive/Contribute.Old/04.forum/docs.en.md diff --git a/pages/04.Contribute/04.forum/docs.es.md b/pages/archive/Contribute.Old/04.forum/docs.es.md similarity index 100% rename from pages/04.Contribute/04.forum/docs.es.md rename to pages/archive/Contribute.Old/04.forum/docs.es.md diff --git a/pages/04.Contribute/04.forum/docs.pt.md b/pages/archive/Contribute.Old/04.forum/docs.pt.md similarity index 100% rename from pages/04.Contribute/04.forum/docs.pt.md rename to pages/archive/Contribute.Old/04.forum/docs.pt.md diff --git a/pages/04.Contribute/05.xmpp/docs.de.md b/pages/archive/Contribute.Old/05.xmpp/docs.de.md similarity index 100% rename from pages/04.Contribute/05.xmpp/docs.de.md rename to pages/archive/Contribute.Old/05.xmpp/docs.de.md diff --git a/pages/04.Contribute/05.xmpp/docs.en.md b/pages/archive/Contribute.Old/05.xmpp/docs.en.md similarity index 100% rename from pages/04.Contribute/05.xmpp/docs.en.md rename to pages/archive/Contribute.Old/05.xmpp/docs.en.md diff --git a/pages/04.Contribute/05.xmpp/docs.es.md b/pages/archive/Contribute.Old/05.xmpp/docs.es.md similarity index 100% rename from pages/04.Contribute/05.xmpp/docs.es.md rename to pages/archive/Contribute.Old/05.xmpp/docs.es.md diff --git a/pages/04.Contribute/05.xmpp/docs.pt.md b/pages/archive/Contribute.Old/05.xmpp/docs.pt.md similarity index 100% rename from pages/04.Contribute/05.xmpp/docs.pt.md rename to pages/archive/Contribute.Old/05.xmpp/docs.pt.md diff --git a/pages/04.Contribute/06.Translations_procedure/en/assign.gif b/pages/archive/Contribute.Old/06.Translations_procedure/de/assign.gif similarity index 100% rename from pages/04.Contribute/06.Translations_procedure/en/assign.gif rename to pages/archive/Contribute.Old/06.Translations_procedure/de/assign.gif diff --git a/pages/archive/Contribute.Old/06.Translations_procedure/de/atom-pull.gif b/pages/archive/Contribute.Old/06.Translations_procedure/de/atom-pull.gif new file mode 100644 index 00000000..821020b4 Binary files /dev/null and b/pages/archive/Contribute.Old/06.Translations_procedure/de/atom-pull.gif differ diff --git a/pages/04.Contribute/06.Translations_procedure/en/atom1.png b/pages/archive/Contribute.Old/06.Translations_procedure/de/atom1.png old mode 100755 new mode 100644 similarity index 100% rename from pages/04.Contribute/06.Translations_procedure/en/atom1.png rename to pages/archive/Contribute.Old/06.Translations_procedure/de/atom1.png diff --git a/pages/04.Contribute/06.Translations_procedure/en/atom_interface1.png b/pages/archive/Contribute.Old/06.Translations_procedure/de/atom_interface1.png old mode 100755 new mode 100644 similarity index 100% rename from pages/04.Contribute/06.Translations_procedure/en/atom_interface1.png rename to pages/archive/Contribute.Old/06.Translations_procedure/de/atom_interface1.png diff --git a/pages/archive/Contribute.Old/06.Translations_procedure/de/branch_01.gif b/pages/archive/Contribute.Old/06.Translations_procedure/de/branch_01.gif new file mode 100644 index 00000000..8c18f0b3 Binary files /dev/null and b/pages/archive/Contribute.Old/06.Translations_procedure/de/branch_01.gif differ diff --git a/pages/archive/Contribute.Old/06.Translations_procedure/de/commit.gif b/pages/archive/Contribute.Old/06.Translations_procedure/de/commit.gif new file mode 100644 index 00000000..4eb948cc Binary files /dev/null and b/pages/archive/Contribute.Old/06.Translations_procedure/de/commit.gif differ diff --git a/pages/archive/Contribute.Old/06.Translations_procedure/de/git-merge_request.gif b/pages/archive/Contribute.Old/06.Translations_procedure/de/git-merge_request.gif new file mode 100644 index 00000000..5bc4f3ba Binary files /dev/null and b/pages/archive/Contribute.Old/06.Translations_procedure/de/git-merge_request.gif differ diff --git a/pages/archive/Contribute.Old/06.Translations_procedure/de/git-request_access.png b/pages/archive/Contribute.Old/06.Translations_procedure/de/git-request_access.png new file mode 100644 index 00000000..6a9d392f Binary files /dev/null and b/pages/archive/Contribute.Old/06.Translations_procedure/de/git-request_access.png differ diff --git a/pages/archive/Contribute.Old/06.Translations_procedure/de/howto-duplicate1.gif b/pages/archive/Contribute.Old/06.Translations_procedure/de/howto-duplicate1.gif new file mode 100644 index 00000000..a05836e3 Binary files /dev/null and b/pages/archive/Contribute.Old/06.Translations_procedure/de/howto-duplicate1.gif differ diff --git a/pages/04.Contribute/06.Translations_procedure/en/note.png b/pages/archive/Contribute.Old/06.Translations_procedure/de/note.png similarity index 100% rename from pages/04.Contribute/06.Translations_procedure/en/note.png rename to pages/archive/Contribute.Old/06.Translations_procedure/de/note.png diff --git a/pages/archive/Contribute.Old/06.Translations_procedure/de/publish.png b/pages/archive/Contribute.Old/06.Translations_procedure/de/publish.png new file mode 100644 index 00000000..a0ac4d11 Binary files /dev/null and b/pages/archive/Contribute.Old/06.Translations_procedure/de/publish.png differ diff --git a/pages/archive/Contribute.Old/06.Translations_procedure/de/pull_push.png b/pages/archive/Contribute.Old/06.Translations_procedure/de/pull_push.png new file mode 100644 index 00000000..cd4bae92 Binary files /dev/null and b/pages/archive/Contribute.Old/06.Translations_procedure/de/pull_push.png differ diff --git a/pages/archive/Contribute.Old/06.Translations_procedure/de/push.gif b/pages/archive/Contribute.Old/06.Translations_procedure/de/push.gif new file mode 100644 index 00000000..a4deb946 Binary files /dev/null and b/pages/archive/Contribute.Old/06.Translations_procedure/de/push.gif differ diff --git a/pages/archive/Contribute.Old/06.Translations_procedure/docs.de.md b/pages/archive/Contribute.Old/06.Translations_procedure/docs.de.md new file mode 100644 index 00000000..9e679a02 --- /dev/null +++ b/pages/archive/Contribute.Old/06.Translations_procedure/docs.de.md @@ -0,0 +1,111 @@ +--- +title: Übersetzungsschema +published: true +visible: true +updated: +taxonomy: + category: + - docs + tags: + - contribute + - style + - mitwirkung + - Übersetzung + - Stil +page-toc: + active: true +--- + + +# Warum ein Übersetzungsschema? +Wir sind der Meinung, dass die Möglichkeit, allen Menschen in ihrer eigenen Sprache Zugriff auf Informationen zu ermöglichen, fundamental ist, um gemeinschaftliches Denken und Handeln zu fördern und zu beleben. Daher ist die Koordination der Menge an Informationen, die zu übersetzen sind, eine äußerst wichtige Aufgabe. + +Das Übersetzungsschema besteht aus **vier** übergeordneten Schritten. + +## Erstens: Einmalige Schritte +1. Erstelle Dir einen Account bei der [Disroot Git-Instanz](https://git.disroot.org/user/sign_up) +2. Öffne ein Terminal und starte git
+`git init`
+ +3. Konfiguriere den git-Benutzernamen und -email
+`git config --global user.email user@email`
+`git config --global user.name "User Name"`
+ + +## Zweitens: Einen zu übersetzenden Bereich auswählen +1. Melde Dich im [**Disroot-Übersetzungsboard**](https://board.disroot.org/project/fede-disroot-translations/timeline) an +2. Wähle das **Epic** (*ein Satz User Stories*), das zu der Sprache gehört, in die Du übersetzen möchtest +3. Wähle die **User Story** (*der zu übersetzende Bereich*) und ordne ihn Dir zu (**assign**)
+ +![](de/assign.gif) + +## Drittens: An der Übersetzung arbeiten +1. **Klone das Disroot How-to-Repository**
+ a. Wechsel in das Verzeichnis, in dem Du arbeiten möchtest
+ b. Klone das Repository
+ `git clone https://git.disroot.org/disroot/howto` +2. **Öffne den Atom-Texteditor**
+ a. Gehe zu **File**, wähle **Add Project Folder** und wähle das Verzeichnis aus, in welches das Projekt geklont wurde.
+![](de/atom_interface1.png)
+ b. Erstelle eine **Branch** (die Branchbezeichnung sollte dieses Format haben: Website_Bereich.zum.übersetzen_Sprache
+ Zum Beispiel:
+ howto_contribute_git_ES
+ howto_email_webmail_IT)
![](de/branch_01.gif)
+ c. Beginne mit der Arbeit an der Übersetzung
+ d. Speichere die Datei nach dem Benennungsmuster "Dateiname.Dein-Sprachcode.md"
+ Wenn Du zum Beispiel an einer deutschen Übersetzung einer Datei namens "docs.md" arbeitest, musst Du sie als "docs.de.md" abspeichern. + +3. **Sende die Übersetzung**
+ Wenn Du Deine Arbeit beendet hast, musst Du Deine Änderungen übersenden ("commit"). Ein commit ist ein Satz erstellter oder veränderter Dateien. Deine Änderungen übersendest Du wie folgt:
+ a. Stelle sicher, dass alle Dateien gespeichert sind
+ b. Nun musst Du alle Dateien, die Du übersetzt hast und an den Server übergeben willst, bereitstellen ("Stage")
+ c. Schreibe eine Übersendungsnachricht (eine kurze und knackige Zusammenfassung Deiner Änderungen)
+ d. Klicke den Button **Commit**
+ + ![](de/commit.gif)
+ + Wenn die Dateien übersendet sind, musst Du sie noch auf den Server schieben ("push"):
+ e. Öffne das **Push/Pull**-Popup-Fenster
+![](de/pull_push.png)
+ + f. Klicke auf **Push**
+ + ![](de/push.gif)
+ +## Viertens: Die Zusammenführung der Übersetzungen beantragen +Der letzte Schritt besteht darin, die Zusammenführung Deiner Arbeit in der Master-Branch zu beantragen. Das heißt, wenn Deine Arbeit beendet ist und Du die Übersetzung an den Server übergeben hast, musst Du das **Disroot Übersetzungsteam** bitten, Deine Änderungen zu überprüfen und der Website hinzuzufügen.
+![](de/note.png)
**WICHTIG!!!** + +Während Du an Deiner Branch arbeitest, kann es parallel zu weiteren Änderungen durch andere Nutzer kommen, insbesondere wenn Du bestehende Dateien bearbeitest. Wenn diese Änderungen anderer Nutzer bereits mit der Masterbranch zusammengeführt wurden, kann es passieren, dass diese Änderungen in Deiner Version noch nicht enthalten sind. Versuchst Du nun, Deine Änderungen der nun veralteten Dateien mit der Masterbranch zusammenführen zu lassen, kann es ziemlich chaotisch werden. + +![](en/git-merge_chaos.gif) + +Glücklicherweise ist git in der Lage, Versionen zu vergleichen und Deine Änderungen in die aktualisierten Dateien einzufügen. Dazu musst Du jedoch, bevor Du eine Zusammenführung beantragst (**Create Merge Request**), Deine Arbeitsbranch aktualisieren. Durch diese Vorgehensweise kannst Du den Admins und Dir selbst eine Menge unnötiger Arbeit ersparen: + + - Stelle zunächst sicher, dass alle Änderungen übergeben wurden + - Öffne ein Terminal (Linux) + - Wechsle in die **Master Branch**: ***git checkout master*** + - Aktualisiere Deine lokale **Master Branch**: ***git pull*** + - Wechsle zurück in Deine Arbeitsbranch: ***git checkout *** + - Aktualisiere die Arbeitsbranch aus der lokalen **Master Branch**: ***git rebase master*** + - Verifiziere alle Änderungen und übergib die Dateien an den Server + +Nun kannst Du loslegen mit den finalen Schritten, um Deine Dateien mit der **Master Branch** zusammenzuführen: + +- Stelle zunächst sicher, dass alle Änderungen übergeben wurden +- Log Dich in unsere [Git-Instanz](https://git.disroot.org) ein +- Wenn Du Änderungen zu unserer Branch geschoben hast, wirst Du in der rechten oberen Ecke einen **"Create Merge Request"**-Button sehen. Klicke ihn an, es öffnet sich ein Formular +- Füge einen Titel hinzu (falls er nicht automatisch eingefügt wurde) +- Füge eine Beschreibung hinzu (falls sie nicht automatisch hinzugefügt wurde) +- Überprüfe, dass die Quelle (**source branch**) diejenige ist, von der aus zusammengeführt werden soll (die Branch, in der Du gearbeitet hast) +- Überprüfe, dass das Ziel (**target branch**) die Branch ist, in der die Änderungen zusammengeführt werden sollen (normalerweise die **Master**-Branch) +- Die Checkbox **Delete source branch when merge request is accepted** auszuwählen ist eine gute Idee, wenn Du mit Deiner Arbeit an Deiner Branch vollständig fertig bist + +![](de/git-merge_request.gif) + +Wenn Du eine Zusammenführungsanfrage erstellt hast, wird sie durch die **Disroot**-Admins überprüft und, wenn alles in Ordnung ist, können sie Deine Übergabe genehmigen. Das heißt, dass Deine Änderungen mit der **Master**-Branch zusammengeführt werden und ab sofort auf der Website sichtbar sind. + +Wenn es irgendwelche Probleme gibt, können die Admins Dich bitten, etwas nachzuarbeiten. Wenn Du Deine Korrekturen erledigt hast und die Dokumentation den **Disroot**-Richtlinien entspricht, wird Die Übergabe Deiner Änderungen stattfinden. Es ist nicht nötig, dass Du eine neue Zusammenführungsanfrage erstellst. +
+ +Um einen besseren Überblick über die Arbeit mit git und Atom zu erhalten, schau Dir bitte auch [**dieses Tutorial**](https://howto.disroot.org/en/contribute/git/how-to-use-git) an. diff --git a/pages/04.Contribute/06.Translations_procedure/docs.en.md b/pages/archive/Contribute.Old/06.Translations_procedure/docs.en.md similarity index 100% rename from pages/04.Contribute/06.Translations_procedure/docs.en.md rename to pages/archive/Contribute.Old/06.Translations_procedure/docs.en.md diff --git a/pages/archive/Contribute.Old/06.Translations_procedure/en/assign.gif b/pages/archive/Contribute.Old/06.Translations_procedure/en/assign.gif new file mode 100644 index 00000000..cec73c17 Binary files /dev/null and b/pages/archive/Contribute.Old/06.Translations_procedure/en/assign.gif differ diff --git a/pages/archive/Contribute.Old/06.Translations_procedure/en/atom-pull.gif b/pages/archive/Contribute.Old/06.Translations_procedure/en/atom-pull.gif new file mode 100755 index 00000000..821020b4 Binary files /dev/null and b/pages/archive/Contribute.Old/06.Translations_procedure/en/atom-pull.gif differ diff --git a/pages/archive/Contribute.Old/06.Translations_procedure/en/atom1.png b/pages/archive/Contribute.Old/06.Translations_procedure/en/atom1.png new file mode 100755 index 00000000..b7024bb0 Binary files /dev/null and b/pages/archive/Contribute.Old/06.Translations_procedure/en/atom1.png differ diff --git a/pages/archive/Contribute.Old/06.Translations_procedure/en/atom_interface1.png b/pages/archive/Contribute.Old/06.Translations_procedure/en/atom_interface1.png new file mode 100755 index 00000000..a0172081 Binary files /dev/null and b/pages/archive/Contribute.Old/06.Translations_procedure/en/atom_interface1.png differ diff --git a/pages/archive/Contribute.Old/06.Translations_procedure/en/branch_01.gif b/pages/archive/Contribute.Old/06.Translations_procedure/en/branch_01.gif new file mode 100755 index 00000000..8c18f0b3 Binary files /dev/null and b/pages/archive/Contribute.Old/06.Translations_procedure/en/branch_01.gif differ diff --git a/pages/archive/Contribute.Old/06.Translations_procedure/en/commit.gif b/pages/archive/Contribute.Old/06.Translations_procedure/en/commit.gif new file mode 100755 index 00000000..4eb948cc Binary files /dev/null and b/pages/archive/Contribute.Old/06.Translations_procedure/en/commit.gif differ diff --git a/pages/archive/Contribute.Old/06.Translations_procedure/en/git-merge_chaos.gif b/pages/archive/Contribute.Old/06.Translations_procedure/en/git-merge_chaos.gif new file mode 100644 index 00000000..0849b626 Binary files /dev/null and b/pages/archive/Contribute.Old/06.Translations_procedure/en/git-merge_chaos.gif differ diff --git a/pages/archive/Contribute.Old/06.Translations_procedure/en/git-merge_request.gif b/pages/archive/Contribute.Old/06.Translations_procedure/en/git-merge_request.gif new file mode 100755 index 00000000..5bc4f3ba Binary files /dev/null and b/pages/archive/Contribute.Old/06.Translations_procedure/en/git-merge_request.gif differ diff --git a/pages/archive/Contribute.Old/06.Translations_procedure/en/git-request_access.png b/pages/archive/Contribute.Old/06.Translations_procedure/en/git-request_access.png new file mode 100755 index 00000000..6a9d392f Binary files /dev/null and b/pages/archive/Contribute.Old/06.Translations_procedure/en/git-request_access.png differ diff --git a/pages/archive/Contribute.Old/06.Translations_procedure/en/howto-duplicate1.gif b/pages/archive/Contribute.Old/06.Translations_procedure/en/howto-duplicate1.gif new file mode 100755 index 00000000..a05836e3 Binary files /dev/null and b/pages/archive/Contribute.Old/06.Translations_procedure/en/howto-duplicate1.gif differ diff --git a/pages/archive/Contribute.Old/06.Translations_procedure/en/note.png b/pages/archive/Contribute.Old/06.Translations_procedure/en/note.png new file mode 100644 index 00000000..e4ba6a4e Binary files /dev/null and b/pages/archive/Contribute.Old/06.Translations_procedure/en/note.png differ diff --git a/pages/archive/Contribute.Old/06.Translations_procedure/en/publish.png b/pages/archive/Contribute.Old/06.Translations_procedure/en/publish.png new file mode 100644 index 00000000..a0ac4d11 Binary files /dev/null and b/pages/archive/Contribute.Old/06.Translations_procedure/en/publish.png differ diff --git a/pages/archive/Contribute.Old/06.Translations_procedure/en/pull_push.png b/pages/archive/Contribute.Old/06.Translations_procedure/en/pull_push.png new file mode 100755 index 00000000..cd4bae92 Binary files /dev/null and b/pages/archive/Contribute.Old/06.Translations_procedure/en/pull_push.png differ diff --git a/pages/archive/Contribute.Old/06.Translations_procedure/en/push.gif b/pages/archive/Contribute.Old/06.Translations_procedure/en/push.gif new file mode 100644 index 00000000..a4deb946 Binary files /dev/null and b/pages/archive/Contribute.Old/06.Translations_procedure/en/push.gif differ diff --git a/pages/04.Contribute/06.Translations_procedure/state/Translations_Howto.pdf b/pages/archive/Contribute.Old/06.Translations_procedure/state/Translations_Howto.pdf similarity index 100% rename from pages/04.Contribute/06.Translations_procedure/state/Translations_Howto.pdf rename to pages/archive/Contribute.Old/06.Translations_procedure/state/Translations_Howto.pdf diff --git a/pages/04.Contribute/06.Translations_procedure/state/Translations_Website.pdf b/pages/archive/Contribute.Old/06.Translations_procedure/state/Translations_Website.pdf similarity index 100% rename from pages/04.Contribute/06.Translations_procedure/state/Translations_Website.pdf rename to pages/archive/Contribute.Old/06.Translations_procedure/state/Translations_Website.pdf diff --git a/pages/archive/Contribute.Old/07.Styleguide/de/Name_des_Verzeichnisses_voller_Mediendateien/Beispiel_1.png b/pages/archive/Contribute.Old/07.Styleguide/de/Name_des_Verzeichnisses_voller_Mediendateien/Beispiel_1.png new file mode 100644 index 00000000..d467524a Binary files /dev/null and b/pages/archive/Contribute.Old/07.Styleguide/de/Name_des_Verzeichnisses_voller_Mediendateien/Beispiel_1.png differ diff --git a/pages/archive/Contribute.Old/07.Styleguide/de/commodore.jpg b/pages/archive/Contribute.Old/07.Styleguide/de/commodore.jpg new file mode 100644 index 00000000..8f4f6216 Binary files /dev/null and b/pages/archive/Contribute.Old/07.Styleguide/de/commodore.jpg differ diff --git a/pages/archive/Contribute.Old/07.Styleguide/de/licensing-pic.png b/pages/archive/Contribute.Old/07.Styleguide/de/licensing-pic.png new file mode 100644 index 00000000..55fcd99b Binary files /dev/null and b/pages/archive/Contribute.Old/07.Styleguide/de/licensing-pic.png differ diff --git a/pages/archive/Contribute.Old/07.Styleguide/de/thing2.jpg b/pages/archive/Contribute.Old/07.Styleguide/de/thing2.jpg new file mode 100644 index 00000000..26996570 Binary files /dev/null and b/pages/archive/Contribute.Old/07.Styleguide/de/thing2.jpg differ diff --git a/pages/archive/Contribute.Old/07.Styleguide/docs.de.md b/pages/archive/Contribute.Old/07.Styleguide/docs.de.md new file mode 100644 index 00000000..22a18f04 --- /dev/null +++ b/pages/archive/Contribute.Old/07.Styleguide/docs.de.md @@ -0,0 +1,353 @@ +--- +title: How-to Mitwirken Gestaltungsrichtlinie +published: true +visible: true +updated: +taxonomy: + category: + - docs + tags: + - contribute + - style + - Mitwirken + - Gestaltung +page-toc: + active: true +--- + + +# Gestaltungsrichtlinie + +Dieser Bereich soll einige grundlegende Richtlinien bereitstellen, wie ein Tutorial oder How-to für die **Disroot**-[How-to Website](https://howto.disroot.org) geschrieben werden sollen. +Das Ziel ist hierbei, eine einheitliche Struktur in den How-to's zu erreichen und sicherzustellen, dass die How-to's die Beiträge enthält, welche die **Disroot**-Gemeinschaft (nach einigen Diskussionen) für wichtig hält. + +Wie wir bereits in den [git-Basics](/contribute/git/how-to-use-git) erläutert haben, arbeiten wir mit git, dem Atom-Texteditor und der Markdown Markup Sprache als Werkzeuge der Wahl. + +Wenn Du Dich mit diesen Werkzeugen nicht wohl fühlst, kannst Du natürlich auch jeden anderen Texteditor benutzen. Wir nehmen alles :smiley: + +## Seiten + +Aktuell gibt es zwei verschiedene Vorlagen für die How-to-Seiten, "docs.md" und "docsparent.md". "docparent.md" wird alle Nachfolger-Seiten indizieren, die im Header mit "indexed:true" markiert sind, und dadurch ein Menü der zugehörigen Seiten erstellen. Wenn im Verzeichnis der Nachfolger-Seite eine Bilddatei abgelegt ist, wird im Index ein Thumbnail (400x300) dargestellt. + +# Seiten-Header + +Der Seiten-Header ist die Stelle, an der Du alle Variablen für die Seite setzen kannst. Er erscheint über dem Seiteninhalt, eingeschlossen von drei Bindestrichen (---). + +Im Folgenden findest Du die Variablen, die im Header definiert werden können: + +*title*: Der Name der Seite. Er erscheint in Menüs und Indizes. +*subtitle*: Erscheint unter Items auf der Homepage. +*icon*: Fork-Awesome Icon, das auf der Homepage erscheint. +*visible*: Boolean. Wird dieser Wert Nachfolgern zweiten Grades auf false gesetzt, erscheinen diese nicht im Index. +*indexed*: Boolean. Wird dieser Wert auf true gesetzt, erscheint die Seite im Index der Eltern-Seite. Fügt ein Thumbnail der Bilddatei im Seiten-Verzeichnis (400x300) ein. +*updated*: Wenn definiert, werden die Metadaten auf der Seite angezeigt. +*published*: Boolean +*taxonomy*: Setzt Kategorien und Tags. Seiten mit der Kategorie 'topic' erscheinen als Hauptthema im Homepage-Menü. +*page-toc*: Boolean. Bestimmt, ob ein Inhaltsverzeichnis auf der Seite angezeigt wird. Wird normalerweise auf false gesetzt bei Index-Seiten (docsparent.md). + + +#### Beispiele: + + +``` +--- +title: Cloud +subtitle: "Basics, settings, syncing, clients" +icon: fa-cloud +updated: +________last_modified: "April 2019" +________app: Nextcloud +________app_version: 15 +published: true +taxonomy: +____category: +________- docs +________- topic +____tags: +________- cloud +page-toc: +____active: false +--- +``` +_docsparent.md_ + + +``` +--- +title: 'Cloud: Nextcloud Introduction' +published: true +visible: true +indexed: true +updated: +________last_modified: "April 2019" +________app: Nextcloud +________app_version: 15 +taxonomy: +____category: +________- docs +____tags: +_______- cloud +page-toc: +____active: true +--- +``` +_docs.md_ + + +## Metainformationen + +Metainformation werden automatisch erstellt, wenn sie im Seiten-Header unter 'updated' definiert sind: + +``` +updated: +________last_modified: "April 2019" +________app: Nextcloud +________app_version: 15 +``` + +# Inhalts-Richtlinien + +Wir sind der Meinung, dass die How-to-Texte der Übersichtlichkeit und Übertragbarkeit zuliebe so kurz wie möglich gehalten werden sollten. Im Idealfall enthalten sie nur die nötigsten Hintergrundinformationen, die grundlegenden Schritte und, wann immer möglich, visuelle Unterstützung (Screenshots, gifs), welche die erklärten Schritte verdeutlicht. + +Der Inhalt eines How-to sollte die folgenden Kriterien erfüllen: + +1. **Nutzung visueller Hilfen**: + - Screenshots + - Gif- / Video-Aufnahmen des Desktop oder Smartphones + +!! +!! Für Gif- / Video-Aufnahmen arbeiten wir normalerweise mit [**Peek**](https://github.com/phw/peek) +!! +!! Für mobile Endgeräte kannst Du [**ScreenCam**](https://f-droid.org/de/packages/com.orpheusdroid.screenrecorder/) nutzen + +2. **Einfach durch andere Projekte anzupassen**: +Um dies zu erreichen, sollten unserer Meinung nach Erwähnungen von **Disroot** und besonderer Identifizierungsmerkmale des **Disroot**-Projekts auf ein notwendiges Minimum beschränkt werden. Auf diese Weise ist für andere Projekte einfacher, die How-to's zu verwenden und anzupassen. + +3. **Prägnanter Inhalt**: +Schreibe nur, was notwendig ist, um eine Aufgabe oder eine Funktion zu beschreiben und weise auf wichtige Dinge hin, die ein Nutzer wissen sollte. + +4. **Vermeide lange Absätze** + +5. **Benutze Aufzählungen anstatt langer Absätze, wenn Du mehrere Schritte oder Funktionen beschreibst** + +6. **Vermeide Tabellen, es sei denn, sie dienen einem anderen Zweck als der Textformatierung** + +#### Notes: + +Starte eine Zeile mit !! um wichtige Hinweie zu formatieren. Füge das Ausrufezeichen-Bild mit \!\[]\(/home/icons/note.png) hinzu. + +Beispiel: + +!! ![](/home/icons/note.png) +!! **ACHTUNG!** + +Wenn Du Dein Passwort verlierst oder vergisst, hast Du **keine** Möglichkeit mehr, an Deine Dateien zu kommen, da diese verschlüsselt sind. Nicht mal die Server-Administratoren können den Inhalt Deiner Dateien sehen. + + +#### Inline-Bilder + +Bilder werden standardmäßig zentriert in der nächsten Zeile eingefügt. Um ein Inline-Bild zu erzeugen, also ein Bild in der selben Zeile wie dem Satz einzufügen, schreibe {.inline} direkt dahinter. So wie in diesem Beispiel: + +``` +![](de/07_share_button.png) {.inline} +``` +---------------------------------------------------------------------- + + +# Einige Formatierungshinweise + +**Disroot**'s [How-to Website](https://howto.disroot.org/) wurde mit [Grav](https://getgrav.org/) erstellt, und nutzt **Markdown** als Markup- / Formatierungs-Texterstellungssprache, weil dies eine einfache Möglichkeit darstellt. + +Wenn Du also ein How-To für **Disroot** erstellen möchtest und mit Markdown keine Erfahrung hast, wollen wir Dir hier ein paar Tipps und Empfehlungen zur Textformatierung eines Tutorials geben: + +## Titel + +Der How-To-Titel selbst steht im Seiten-Header. Du kannst ihn ändern, wenn Du git benutzt. + +Für die Titel der unterschiedlichen Bereiche oder Abschnitte in einem How-to kannst Du in Markdown das '#'-Symbol und ein Leerzeichen vor dem Titel selbst benutzen. Zum Beispiel: + +Schreibst Du dieses... +``` +# Titel 1 +## Titel 2 +### Titel 3 +#### Titel 4 +##### Titel 5 +``` +...wird es so angezeigt: + +# Titel 1 +## Titel 2 +### Titel 3 +#### Titel 4 +##### Titel 5 + +Je mehr `#` Du benutzt desto kleiner wird der Titel. + +Titel sind aus verschiedenen Gründen wichtig. Einer der Hauptgründe ist, dass Grav automatisch aus den Titeln die TOC (Table of Content, Inhaltsverzeichnis) der Seite generiert. Auf diese Weise können Titel genutzt werden, um bereits am Anfang der Seite einen Überblick über die verschiedenen Kapitel oder Bereiche der Seite zu geben. + +Kleinere Titel erscheinen als Unterkapitel in der TOC. Das kann sehr hilfreich sein, benötigt für die Ausführung natürlich eine gewisse Ordnung: + +Wir empfehlen, das einzelne `#` ein einziges Mal auf der Seite zu nutzen, nämlich für den Seitentitel, und zwei `#` für Unterkapitel. Du kannst Titel mit drei `#` für untergeordnete Überschriften im Text benutzen, die Du auch noch in der TOC erscheinen lassen willst, und noch kleinere Titel für Überschriften, die nicht in der TOC enthalten sein müssen. + + +## Listen + +Bitte, benutze Listen für schrittweise Erläuterungen oder Funktionsaufzählungen in einem How-to. + +Aufzählungszeichen zu erzeugen ist ganz einfach. Schreibst Du... +``` +Meine Liste: +- irgendwas 1 +1. Unterpunkt 1 +2. Unterpunkt 2 +- irgendwas 2 +``` +...wird das Ganze später so aussehen: + +Meine Liste: +- irgendwas 1 + 1. Unterpunkt 1 + 2. Unterpunkt 2 +- irgendwas 2 + + +## Fett + +Bitte benutze die "Fett"-Formatierung um folgendes hervorzuheben:
+- Wichtige Informationen +- Warnungen an den Benutzer +- Kleinere Titel innerhalb eines Bereichs, die nicht unbedingt in der TOC aufgeführt werden müssen. + +Um ein Wort oder eine Zeile "Fett" zu formatieren, füge zwei `**` vor und hinter dem zu formatierenden Text ein.
Wenn Du zum Beispiel schreibst... + +`**Irgendetwas**` + +wird es dargestellt als: + +**Irgendetwas** + + +## Kursiv + +Kursiv funktioniert genauso wie Fett. Du kannst einen `_` oder einen `*` vor und hinter dem zu formatierenden Text einfügen.
+Beispiele:
+Schreibst Du...
+ +`_Beispiel_`
+`*Beispiel*` + +...wird das so aussehen: + +_Beispiel_
+*Beispiel* + + +## Links + +Manchmal müssen wir Links zu anderen Seiten oder Websites einfügen. Dies kannst Du folgendermaßen erreichen: + +Schreibst Du `[Link zur Disroot-Website](disroot.org)` + +wird dies so aussehen: + +[link to Disroot website](disroot.org) + + +## Einbetten von Videos / gifs / Screenshots in die How-to's + +Wie wir schon erwähnt haben, wir lieben Bilder / Videos in den Tutorials. Du kannst sie folgendermaßen einbinden: + +- Erstens: Erstelle ein Verzeichnis, in welchem die Videos / gifs / Bilder gespeichert werden +- Zweitens: Benenne bzw. nummeriere die Dateien in der Reihenfolge, in der sie im Verlauf des How-to verwendet werden + +Dann erstellst Du einen Link mit dem Verzeichnispfad und dem Namen der fraglichen Datei.
+Wenn Du also schreibst... + +`![](Name_des_Verzeichnisses_voller_Mediendateien/Beispiel_1.png)` + +... erhältst Du dies: + +![](de/Name_des_Verzeichnisses_voller_Mediendateien/Beispiel_1.png) + +Wenn Du schreibst: + +`Text vorher ![](Name_des_Verzeichnisses_voller_Mediendateien/Beispiel_1.png) Text nachher` + +erhältst Du dies: + +Text vorher ![](de/Name_des_Verzeichnisses_voller_Mediendateien/Beispiel_1.png) Text nachher + +Mit der gleichen Vorgehensweise kannst Du auch gifs und .mp4-Videos einbetten. + + +## Code + +Wenn Du in Deinem Tutorial Terminal-Kommandos, Codezeilen, Anweisungen oder Beipiele aufführen musst, wie wir das in diesem Ratgeber die ganze Zeit machen, kannst Du das **`** vor und hinter den entsprechenden Text setzen.
+Zum Beispiel:
+ +Dies ist eine Komanndozeilen-Anweisung: `sudo apt update` + +# Terminologie + +Um die Tutorials kohärenter und außerdem die Adaption durch andere Gruppen einfacher zu gestalten, empfehlen wir die Anwendung der folgenden Regeln: + +- In einem How-to sollte **Disroot**'s Name sollte benannt werden als: **Disroot**, wobei der erste Buchstabe groß geschrieben und das ganze Wort Fett formatiert wird. + +- Die verschiedenen Services werden wie folgt benannt: + +|Service|Disroot-Name| +|-:|:-| +|Lufi|**Disroot Upload**| +|Forum/Discourse|**Disroot Forum**| +|Etherpad|**Disroot Pad**| +|EtherCalc|**Disroot Calc**| +|XMPP|**Disroot Chat**| +|Email services im Allgemeinen|**Disroot Email**| +|Rainloop|**Disroot Webmail**| +|Hubzilla Instanz|**DisHub**| +|Private Bin|**Disroot Bin**| +|Polls|**Disroot Polls**| +|Nextcloud:|**Disroot Cloud**| +|Nextcloud Kalender-App|**Disroot Calendar**| +|Nextcloud Notizen-App|**Disroot Notes**| +|Nextcloud Kontakt-App|**Disroot Contacts**| + +Auf diese Weise, wenn die Bezeichnungen den Regeln entsprechen, ist es einfacher zu "*suchen und ersetzen*" :wink: + + +# Video How-to's + +Im Bezug auf Video-How-to's denken wir, dass der Inhalt im Sinne der Klarheit ebenfalls **auf ein Minimum reduziert** und **kurz** genug gehalten werden sollte, damit der Benutzer in die Lage versetzt wird, seine Aktivitäten durchzuführen. + +WIe auch bei den Text-How-to's sollten die Video-Tutorials die folgende Struktur haben: + +1. **Metainformationen** +2. **Inhalt** +3. **Lizenzinformationen** + +Die Punkte **Metainformationen** and **Lizenzinformationen** werden durch die **Disroot**-Admins in der Videobeschreibung auf der Peertube-Instanz eingefügt, auf der die Videos gehostet werden. + +## Inhaltsbeschreibung + +Soweit möglich angeliefert werden mit: + +- Titel des How-to +- Kurze Beschreibung, worum es geht +- Softwareversion, auf die es sich bezieht + +Auf diese Weise können die **Disroot**-Admins diese Informationen in die Videobeschreibung auf der Peertube-Instanz einfügen. + +## Inhalt + +## Lizensierung von Video-How-to's + +Wie wir bereits zuvor erwähnt haben, werden die **Disroot**-Admins die Lizenzinformationen in die Videobeschreibung einfügen. + +Nichtsdestotrotz empfehlen wir, dass Du das folgende Bild am Ende Deines Videos für etwa 10 Sekunden mit einem fade in / fade out einsetzt: + +![](de/licensing-pic.png) + +Auf diese Weise sind die Lizenzinformationen immer noch vorhanden, wenn das Video heruntergeladen und an anderer Stelle wieder hochgeladen wird. + +--- diff --git a/pages/archive/Contribute.Old/07.Styleguide/docs.en.md b/pages/archive/Contribute.Old/07.Styleguide/docs.en.md new file mode 100644 index 00000000..9834ab3b --- /dev/null +++ b/pages/archive/Contribute.Old/07.Styleguide/docs.en.md @@ -0,0 +1,346 @@ +--- +title: How-to Contribute: Style guide +published: true +visible: true +updated: +taxonomy: + category: + - docs + tags: + - contribute + - style +page-toc: + active: true +--- + +# Style Guide + +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-to's, 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](/contribute/git/how-to-use-git), we work with Git, Atom text editor and Markdown Markup language as the tools to write them. + +But if you're not feeling comfortable with these tools you can just write a pad, email, etc. We'll take it all :smiley: + +## Pages + +There are currently two different templates for the howto pages, docs.md and docsparent.md. docparent.md will index all children pages that are marked indexed:true in the header, creating a menu of the related pages. If an image is placed in the folder of the child page, a thumbnail will show in the index (size 400x300) + +# Page headers + +The page header is the place where you set all the variables for the page. It appears above the content part enclosed between three dashes (---) + +Below you can find the variables that can be specified in each header and their purpose. + +*title*: The name of the page, it will appear is here in menus and indexes. +*subtitle*: Shows under items in the home page +*icon*: Fork-awesome icon that shows on the home pages +*visible*: Boolean. When set to false on second degree chldren, they will not appear in index. +*indexed*: Boolean. Posts set to true appear in parent pages indexes. add thumbnail in page directory 400x300px +*updated*: If specified, metadata information will show on page +*published*: Boolean +*taxonomy*: to set categories and tags. Posts with the category 'topic' appear as the main topics on the home page menu +*page-toc*: Boolean. Determines if Table of Content is visible on page or not. Usualy will be set false for index pages (docsparent.md) + + +#### Examples: + + +``` +--- +title: Cloud +subtitle: "Basics, settings, syncing, clients" +icon: fa-cloud +updated: +________last_modified: "April 2019" +________app: Nextcloud +________app_version: 15 +published: true +taxonomy: +____category: +________- docs +________- topic +____tags: +________- cloud +page-toc: +____active: false +--- +``` +_docsparent.md_ + + +``` +--- +title: 'Cloud: Nextcloud Introduction' +published: true +visible: true +indexed: true +updated: +________last_modified: "April 2019" +________app: Nextcloud +________app_version: 15 +taxonomy: +____category: +________- docs +____tags: +_______- cloud +page-toc: +____active: true +--- +``` +_docs.md_ + + +## Meta information + +Meta information is set automatically when specified in the page header under 'updated:' section + +``` +updated: +________last_modified: "April 2019" +________app: Nextcloud +________app_version: 15 +``` + +# Content guide lines + +We think that how-to's text content should be kept at the minimum for the clarity and portability 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: + +1. **Use of visual aids (if it's possible) like**: + - Screen shots + - Gif / video recording of the desktop or mobile + +!! +!! For gif / video recordings of a desktop we usually work with [**Peek**](https://github.com/phw/peek) +!! +!! For mobile devices you can use [**screenrecorder**](https://f-droid.org/en/packages/com.orpheusdroid.screenrecorder/) + +2. **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. + +3. **Concise text content**: Write only what is necessary to explain a task or a feature and warn about important things users should know. + +4. **Avoid long text paragraphs** + +5. **Use bullet points instead of a big paragraphs when describing several steps or features** + +6. **Avoid using tables, unless it serves a purpose other then text formating.** + +#### Notes: + +Start line with !! to format notices. Add exclamation mark image with \!\[]\(/home/icons/note.png) + +Example: + +!! ![](/home/icons/note.png) +!! **NOTE!** If you lose your password, you won't be able to retrieve your files on the cloud as they're encrypted, so even the server administrators can't see their content. + + +#### Inline images + +Images are centered by default in the next line. To use an image inline, so on the same line of a sentence use {.inline} right after. Like in this example: + +``` +![](en/07_share_button.png) {.inline} +``` +---------------------------------------------------------------------- + + +# 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. + +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. + +## Titles + +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: + +Writing this... +``` +# Title 1 +## Title 2 +### Title 3 +#### Title 4 +##### Title 5 +``` +...will be displayed as: + +# Title 1 +## Title 2 +### Title 3 +#### Title 4 +##### Title 5 + +The more `#` 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 (Table of Content) 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 `#` for the main page title and two `##` for sub chapters. You can use `###` titles for minor headers within the text, that you want to be in the TOC and even smaller titles for headers that do not need to be in the TOC. + + +## Lists + +Please, use lists to list steps or features in a howto. + +Making bullet points is easy. Writing... +``` +My List: +- something 1 +1. sub item 1 +2. sub item 2 +- something 2 +``` +...will show this: + +My List: +- something 1 + 1. sub item 1 + 2. sub item 2 +- something 2 + + +## Bold + +Please, use bold to highlight:
+- Important information +- Warnings to the user +- Or a smaller title inside a section that is not necessary to be listed in the TOC. + +To highlight a word or a line with bold, use two `*` symbol before and after the part it needed.
For example, if you write... + +`**Something**` + +it will be displayed as: + +**Something** + + +## Italic + +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.
+Examples:
+Writing...
+ +`_example_`
+`*example*` + +... will show this: + +_example_
+*example* + + +## Links + +Sometimes we need to insert links to some pages or websites. It can be done this way: + +Writing `[link to Disroot website](disroot.org)` + +will be displayed as: + +[link to Disroot website](disroot.org) + + +## Embedding videos / gifs / screenshots in the howto + +As we've mentioned, we like images / videos in the tutorials. You can embed them by doing the following: + +- First: Creating a folder where to put the videos / gifs / images +- Second: Naming the files by the order in which they will appear troughout the how-to + +Then create a link with the path to the folder and name of the file in question.
+So if you write... + +`![](name_of_folder_full_of_media_files/example_1.png)` + +... you will see this: + +![](en/name_of_folder_full_of_media_files/example_1.png) + +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 ![](en/name_of_folder_full_of_media_files/example_1.png) text after + +The structure described above also works to embed gifs and .mp4 videos. + + +## Code + +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.
+For example:
+ +This is a command line command: `sudo apt update` + +# Terminologies + +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 referred as: **Disroot**, starting with capital letter and bold type. + +- And the different services refered as follows: + +|Service|Disroot name| +|-:|:-| +|Lufi|**Disroot Upload**| +|Forum/Discourse|**Disroot Forum**| +|Etherpad|**Disroot Pad**| +|EtherCalc|**Disroot Calc**| +|XMPP|**Disroot Chat**| +|Email services in general|**Disroot Email**| +|Rainloop|**Disroot Webmail**| +|Hubzilla Instance|**DisHub**| +|Private Bin|**Disroot Bin**| +|Polls|**Disroot Polls**| +|Nextcloud:|**Disroot Cloud**| +|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: + + +# 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. + +Same as the text how-tos, the tutorials should have the following structure: + +1. **Meta information** +2. **Content** +3. **Licensing information** + +**Meta information** and **licensing information** will be placed by the **Disroot** admins in the video description of the Peertube instance where the videos will be hosted. + +## Description of Content + +To the extent possible, videos should go with: + +- Title of the how-to +- Brief description of what it is about +- Software version it refers to + +So that they can be placed by **Disroot** admins on the video description at the Peertube instance. + +## Content + +## Licensing of video how-to's + +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: + +![](en/licensing-pic.png) + +In this case if the video is downloaded and reuploaded somewhere else the license information is still there. + +--- diff --git a/pages/04.Contribute/07.Styleguide/docs.en.md.bak b/pages/archive/Contribute.Old/07.Styleguide/docs.en.md.bak similarity index 100% rename from pages/04.Contribute/07.Styleguide/docs.en.md.bak rename to pages/archive/Contribute.Old/07.Styleguide/docs.en.md.bak diff --git a/pages/archive/Contribute.Old/07.Styleguide/en/commodore.jpg b/pages/archive/Contribute.Old/07.Styleguide/en/commodore.jpg new file mode 100644 index 00000000..8f4f6216 Binary files /dev/null and b/pages/archive/Contribute.Old/07.Styleguide/en/commodore.jpg differ diff --git a/pages/archive/Contribute.Old/07.Styleguide/en/licensing-pic.png b/pages/archive/Contribute.Old/07.Styleguide/en/licensing-pic.png new file mode 100644 index 00000000..55fcd99b Binary files /dev/null and b/pages/archive/Contribute.Old/07.Styleguide/en/licensing-pic.png differ diff --git a/pages/archive/Contribute.Old/07.Styleguide/en/name_of_folder_full_of_media_files/example_1.png b/pages/archive/Contribute.Old/07.Styleguide/en/name_of_folder_full_of_media_files/example_1.png new file mode 100644 index 00000000..d467524a Binary files /dev/null and b/pages/archive/Contribute.Old/07.Styleguide/en/name_of_folder_full_of_media_files/example_1.png differ diff --git a/pages/archive/Contribute.Old/07.Styleguide/en/thing2.jpg b/pages/archive/Contribute.Old/07.Styleguide/en/thing2.jpg new file mode 100644 index 00000000..26996570 Binary files /dev/null and b/pages/archive/Contribute.Old/07.Styleguide/en/thing2.jpg differ diff --git a/pages/04.Contribute/contribute.png b/pages/archive/Contribute.Old/contribute.png similarity index 100% rename from pages/04.Contribute/contribute.png rename to pages/archive/Contribute.Old/contribute.png diff --git a/pages/04.Contribute/docs.de.md b/pages/archive/Contribute.Old/docs.de.md similarity index 100% rename from pages/04.Contribute/docs.de.md rename to pages/archive/Contribute.Old/docs.de.md diff --git a/pages/archive/Contribute.Old/docs.en.md b/pages/archive/Contribute.Old/docs.en.md new file mode 100755 index 00000000..55d2756b --- /dev/null +++ b/pages/archive/Contribute.Old/docs.en.md @@ -0,0 +1,28 @@ +--- +title: How-to: Contribute +published: true +visible: true +updated: +taxonomy: + category: + - docs + tags: + - contribute +page-toc: + active: false +--- + +# Contribute + +We think that knowledge is a collective construction. In other words, knowledge is the result of working together and cooperatively, as a community. + +Disroot platform cost money besides our most precious value: time. While the costs of maintaining all the services working on started being covered a few months ago thanks to donations, documentation requires time. +*"A lot of precious time..."* + +For those users who may want to contribute to Disroot by donating their time and knowhow, we've tried to channel all the efforts through this section. +Here you'll find basic information and guidelines for different ways to contribute, from feedback to write a how-to or translate them to your language. + +Thanks to all of you who support and collaborate with Disroot. + + +![](contribute.png) diff --git a/pages/04.Contribute/docs.es.md b/pages/archive/Contribute.Old/docs.es.md similarity index 100% rename from pages/04.Contribute/docs.es.md rename to pages/archive/Contribute.Old/docs.es.md diff --git a/pages/04.Contribute/docs.fr.md b/pages/archive/Contribute.Old/docs.fr.md similarity index 100% rename from pages/04.Contribute/docs.fr.md rename to pages/archive/Contribute.Old/docs.fr.md diff --git a/pages/04.Contribute/docs.pt.md b/pages/archive/Contribute.Old/docs.pt.md similarity index 100% rename from pages/04.Contribute/docs.pt.md rename to pages/archive/Contribute.Old/docs.pt.md