Browse Source

Added a README file

keep-around/bddccd077168bc2e7cf1c19fbf8539d7ec192613^2
Fede.- 2 years ago
parent
commit
88050821e4
  1. 79
      README.md
  2. BIN
      disroot_h2_title.png
  3. 2
      pages/04.Contribute/06.Translations_procedure/docs.de.md
  4. 8
      pages/04.Contribute/06.Translations_procedure/docs.en.md
  5. 0
      pages/04.Contribute/06.Translations_procedure/en/git-merge_chaos.gif

79
README.md

@ -0,0 +1,79 @@
![](disroot_h2_title.png)
# Disroot's How-tos & Translations
| [Disroot Howtos](https://howto.disroot.org) | [Disroot Website](https://disroot.org) |
----
This repository contains the **Disroot's Howto Project** files and the information to create, modify and translate those files.
The main objective of the **Disroot's Howto Project** is the creation, maintenance and accessibility of user guides, tutorials and configurations of the different services and software that the **Disroot** platform provides. And also provide the tools, instructions and procedures for anyone who wants to contribute by creating, modifying and translating these guides.
## Table of contents
* [Prerequisites](#prerequisites)
- Software required
- Gitlab account
- Request access to our repository
- Setting your username and email
* [Creating / Translating Howto's](#creating-translating-howtos)
- Cloning the repository
- Creating / Translating instructions
* [License](#license)
----
## Prerequisites
In order to get a copy of the project on your local machine and start to work, you should follow these instructions.
### 01. Software required:
First of all, you need to have installed the following software.
- **git**<br>
A version control system for tracking the changes that are implemented to the howtos and translations as they're being written.<br>
[**What is git?**](https://en.wikipedia.org/wiki/Git) / [**Download & installation instructions**](https://git-scm.com/downloads) / [**Disroot's Git Basics Howto**](https://howto.disroot.org/en/contribute/git/how-to-use-git)
- A text editor with markdown format files support<br>
Suggested software: **Atom Text Editor**, a source code editor with git version control integrated.<br>
[**Download & installation instructions**](https://flight-manual.atom.io/getting-started/sections/installing-atom/)
### 02. Gitlab account
In order to send changes you make to the howtos, whether translating, editing, or writing them, you need to have an account in the Gitlab instance we use.
To register an account at **India's FOSS Community**, where our repository is, go [**here**](https://git.fosscommunity.in/users/sign_in)
### 03. Request access to our repository
In order to be able to commit changes to **Disroot**'s git repository, you'll need to request access. This is done via our git project page
### 04. Setting your username and email
This is necessary to be able to send your work from your machine to the remote repository. To setup the git username and email
- open a terminal and start git<br>
`git init`<br>
- type and complete with your information the following commands:<br>
`git config --global user.email user@email`<br>
`git config --global user.name "User Name"`
## Creating / Translating Howto's
The process of creating or translating howtos is not difficult and requires only a bit of practice to learn.
The first thing to do is cloning the repository, this means making a local copy of the remote files. All the work will be done on this copy.
### Cloning the repository
A git repository is a project folder containing the files created or to be translated and the detailed track history of those changes.
To clone the repository, open a terminal in the directory you would like to clone the repository to. Once there you'll use the `git clone` command, an instruction to clone a repository by typing its address. In our case it would be:
`git clone https://git.fosscommunity.in/disroot/howto`
Once the repository has been copied to your hard drive you'll see a `howto` directory containing all the files of the project. It can be later moved to any place on your computer.
### Creating / Translating instructions
Once you have copied the repository to your machine, you can start creating, editing and/or translating by following the steps described in these guides:
- [Howto use git for **Disroot**'s Howtos](https://howto.disroot.org/en/contribute/git/how-to-use-git)<br>
- [**Disroot**'s Translation procedure](https://howto.disroot.org/en/contribute/translations_procedure)
## License
The **Disroot's Howto** documentation is licensed under a [Creative Commons Attribution-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-sa/4.0/)

BIN
disroot_h2_title.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB

2
pages/04.Contribute/06.Translations_procedure/docs.de.md

@ -78,7 +78,7 @@ Der letzte Schritt besteht darin, die Zusammenführung Deiner Arbeit in der Mast
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.
![](de/git-merge_chaos.gif)
![](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:

8
pages/04.Contribute/06.Translations_procedure/docs.en.md

@ -74,16 +74,16 @@ For the purposes of this guide, we will assume that either you know what **git**
## Fourth: Requesting the merge of the Translations
Final step is to request the merge of your work into the master branch. This means that once you finished and sent the translation, you need to request **Disroot Translation Team** to check if it's all right to finally add it to the site.<br>
![](en/note.png) <br>**NOTE!!!**
!! ![](en/note.png)**NOTE!!!**<br>
While you are working on your branch, other users possibly commit and merge their own changes, esp. if you are working on existing files. If those changes from the other users have already been merged to the **master branch**, the version of the files you changed may no longer be the actual ones and therefore the changes from other users may not be included in your files. In that state, if you want to let your changes be merged to the **master branch**, this process may be very chaotic.
While you're working on your branch, other users possibly commit and merge their own changes, especially if when working on existing files. If those changes from the other users have already been merged to the **master branch**, the version of the files you changed may no longer be the actual ones and therefore the changes from other users may not be included in your files. In those cases, if you want to let your changes be merged to the **master branch**, this process may be very chaotic.
![](en/git-merge_chaos.gif)
Luckily git is able to compare versions and to insert your changes into the updated file versions. To trigger this, you need to update your branch **before** you **Create** a **Merge Request**. By doing this you will spare the admins and yourself a lot of needless work:
One of **Git**'s main features is the ability to compare versions and to insert your changes into the updated file versions. To trigger this, you need to update your branch **before** you **Create** a **Merge Request**. By doing this you will spare the admins and yourself a lot of needless work:
- First of all is to make sure all the changes are committed
- Open Terminal (Linux)
- Open a terminal (GNU/Linux)
- Switch to **Master Branch**: ***git checkout master***
- Update **Master Branch**: ***git pull***
- Switch to working branch: ***git checkout <Branch_Name>***

0
pages/04.Contribute/06.Translations_procedure/de/git-merge_chaos.gif → pages/04.Contribute/06.Translations_procedure/en/git-merge_chaos.gif

Before

Width:  |  Height:  |  Size: 2.6 MiB

After

Width:  |  Height:  |  Size: 2.6 MiB

Loading…
Cancel
Save