Disroot Howto Site Repository https://howto.disroot.org/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
meaz 67c1512615 Merge branch 'use-git' of hucste/Howto into master 11 hours ago
pages Merge branch 'use-git' of hucste/Howto into master 11 hours ago
themes/grav-theme-howto Merge branch 'master' into howto-services 1 day ago
vagrant add relatedpages plugin in vagrant 1 week ago
.gitignore fixed gitignore file 3 months ago
README.md README file: Spanish translation and English update 4 months ago
README_ES.md README_ES 4 months ago
disroot_h2_title.png Added a README file 4 months ago
facss New howto theme 5 months ago

README.md

Disroot’s How-tos & Translations

| Disroot Howtos | Disroot Website |


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

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.

02. Gitea account

In order to send changes you make to the howtos, whether translating, editing, or writing them, you need to have an account in a Gitea instance.

To register an account at the instance where our repository is, go here.

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
    git init

  • type and complete with your information the following commands:
    git config --global user.email user@email
    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.disroot.org/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:

License

The Disroot’s Howto documentation is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License