Disroot/Howto
Disroot
/
Howto
19
23
Fork 11
Code Issues 76 Pull Requests Projects 6 Releases Wiki Activity

Fixes on H2 WIP merge

This commit is contained in:
Fede.- 2022-01-02 16:22:16 -03:00
parent b0d7944e79
commit 254521e579
1 changed files with 4 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
pages/04.Contribute/02.git/docs.en.md
View File

@ -18,19 +18,16 @@ page-toc:
# Git?
Yes, **Git**. It is a control version system, a software that allows you to track modifications to files, keeping a record of all the changes made, so if you need to revert to a specific version you can do it in a relatively easy way. It is also a powerful collaboration tool, since it allows many people working on the same files of a project.
<<<<<<< HEAD
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 does not 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.<br>
=======
To learn the basics of Git and to work with it can be not only a 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.<br>
>>>>>>> fa6512ecbc6aa44051ee902481567ca84ea22828
So the aim of the following tutorial 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.
@ -39,7 +36,7 @@ If you get more interested about Git, there are lots of in-depth tutorials and d
![](en/git.png)
<<<<<<< HEAD
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.
@ -61,23 +58,19 @@ The process will then begin and in a few minutes, depending on our internet conn
![](en/cloning.png)
Once the repository is cloned to your hard drive you will see a `Howto` (or a `Website`) directory that content all the files of the site.
Once the repository is cloned to your hard drive you will see a `Howto` (or a `Website`) directory that content all the files of the site. You can later move that directory to any place you want on your computer.
You can later move that directory to any place you want on your computer.
=======
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"), the default project folder where is the "final" code, the one is online or in "production".
When a tutorial needs to be modified (e.g., 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, this way we can work locally on the files. This procedure is called **cloning** and once it is done, all Git operations are managed from our local repository.
>>>>>>> fa6512ecbc6aa44051ee902481567ca84ea22828
Next step will be to create a new **branch**, a fork of the main branch on which we can make modifications without compromising the original code.
![](en/git_branches.png)
<<<<<<< HEAD
But before we really get to work, let's setup our identity so we can move forward without distractions.
## Setting your identity
@ -92,7 +85,6 @@ In order to be able to send your work from your machine to the remote repository
You will not need to enter this information again.
## Requesting access to the Disroot repository
=======
But before we really get to work, let's setup your **Gitea** account so we can move forward without distractions.
## Setting your Gitea account
@ -107,7 +99,6 @@ In order to be able to send your work from your machine to the remote repository
You will not need to enter this information again.
>>>>>>> fa6512ecbc6aa44051ee902481567ca84ea22828
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*" your changes to the server.
@ -115,8 +106,7 @@ Once admins grant you the access, you will be able to "*push*" your changes to t
!! **NOTE**<br>
!! You can start working without access granted as all the changes happen on your local computer.
<<<<<<< HEAD
=======
## Cloning the **Howto Disroot** repository
Ok, now we need to get a copy of all files within the project onto our local hard drive. This process is called "**to clone**" a repository. And once we have the clone (the copy) of the repo, all modifications will be done on this copy in our local machine (most of the work is done offline).<br>
When we have decided that the changes (new tutorial, translation) are finished we can sent/sync them back to the repository on the server, this action is called **push**.
@ -135,5 +125,4 @@ Once the repository is copied to your hard drive you will see a `Howto` (or a `W
You can later move that directory to any place you want on your computer.
>>>>>>> fa6512ecbc6aa44051ee902481567ca84ea22828
Ok. Now we finally can start to work.