updated docs

Author: mickvandijke

README.md

@@ -1,17 +1,32 @@
 # Torrust Documentation
 
 ## Introduction
+Torrust is an open source project that brings you all the tools you need to host your own (private) online torrent database.
 
-Torrust is an open source BitTorrent tracker developed using the Rust language. With Torrust, you can upload torrents and supply additional information (such as a description and images) for other users to view and download.
+### Project structure
+Torrust is split up into three separate applications.
 
-### Repositories
+- [__Torrust Backend__](https://github.com/torrust/torrust-web-backend): A REST API written in Rust with the Actix web framework that acts as a backend for the Torrust Frontend.
+- [__Torrust Frontend__](https://github.com/torrust/torrust-web-frontend): A Vue application where torrents can be uploaded and downloaded.
+- [__Torrust Tracker__](https://github.com/torrust/torrust-tracker): A UDP based torrent tracker built with Rust.
 
-* <a href="https://github.com/torrust/docs">https://github.com/torrust/docs</a> - Torrust Documentation.
-* <a href="https://github.com/torrust/torrust">https://github.com/torrust/torrust</a> - Torrust RESTful API.
-* <a href="https://github.com/torrust/torrust-web">https://github.com/torrust/torrust-web</a> - Torrust Web.
+### Features
+- [X] Email / Password authentication
+- [X] Self-hosted Private Tracker
+- [X] Torrent Uploading / Downloading
+- [X] No external services needed
+- [X] Completely written in Rust
 
-## Installation
+### Screenshots
+![Web UI Category page](docs/img/web-ui.png)
+![Web UI Torrent page](docs/img/web-ui-torrent.png)
 
+# Installation
+
+## Torrust web + tracker
+Please follow our [guide](https://torrust.github.io/torrust-documentation/installation/).
+
+## Torrust Documentation site
 ### Prerequisites (installed)
 
 - [Python](https://www.python.org/)
@@ -27,7 +42,7 @@ Clone repo:
 git clone https://github.com/torrust/docs.git
 ```
 
-## Usage
+# Usage
 
 ### Run Development
 
@@ -50,3 +65,7 @@ mkdocs build
 ```
 
 Publish the newly built docs/site folder using NGINX or Apache.
+
+## Contributing
+Please report any bugs you find to our issue tracker. Ideas and feature requests are welcome as well!
+Any pull request targeting existing issues would be very much appreciated.

docs/img/web-ui-torrent.png

@@ -1,8 +1,7 @@
 # About
 
 ## Introduction
-Torrust is an open source BitTorrent tracker developed using the Rust language. 
-With Torrust, you can upload torrents and supply additional information (such as a description and images) for other users to view and download.
+Torrust is an open source project that brings you all the tools you need to host your own (private) online torrent database.
 
 ## Project structure
 Torrust is split up into three separate applications.
@@ -13,14 +12,15 @@ Torrust is split up into three separate applications.
 
 ## Features
 - [X] Email / Password authentication
-- [X] E-mail verification
+- [X] Self-hosted Private Tracker
 - [X] Torrent Uploading / Downloading
 - [X] No external services needed
 - [X] Completely written in Rust
 
 ## Screenshots
-![Web UI Category page](img/web-ui.png){ align=center }
+![Web UI Category page](img/web-ui.png)
+![Web UI Torrent page](img/web-ui-torrent.png)
 
 ## Contributing
 Please report any bugs you find to our issue tracker. Ideas and feature requests are welcome as well!
-Any pull request targeting existing issues would be very much appreciated.
+Any pull request targeting existing issues would be very much appreciated.

docs/img/web-ui.png

@@ -10,17 +10,7 @@ This guide walks you through how to install Torrust on a Linux system. Make sure
 - [Node.js](https://nodejs.org/en/) - A JavaScript runtime
 - [NPM](https://www.npmjs.com/) - Package manager for Node/JavaScript
 
-
-## Cloning repositories
-To get the code of all the applications, execute the following commands.
-These will download the repositories to the directory you're currently in.
-```bash
-git clone https://github.com/torrust/torrust-web-frontend
-git clone https://github.com/torrust/torrust-web-backend
-git clone https://github.com/torrust/torrust-tracker
-```
-
-## Setting up the Torrust Web Frontend
+## Setting up Nginx
 ### Installing Nginx
 The frontend can't run on it's own and needs and external webserver like apache or nginx.
 In this guide we will be using nginx, so lets install that first.
@@ -36,9 +26,9 @@ Create a file in `/etc/nginx/sites-available/` called `torrust.conf` with the fo
 ```nginx
 server {
     listen 80;
-    server_name torrust.dutchbits.nl;
+    server_name torrust.dutchbits.nl; # set your own domain name here!!
 
-    root /opt/torrust/torrust-web/dist/;
+    root /opt/torrust/torrust-web-frontend/dist/;
 
     location / {
         try_files $uri $uri/ /index.html;
@@ -54,31 +44,22 @@ Enable the configuration by making a symlink to the config in the `sites-enabled
 ln -s /etc/nginx/sites-available/torrust.conf /etc/nginx/sites-enabled/
 ```
 
-After this you can test the validity of the config by executing `nginx -t`, 
+After this you can test the validity of the config by executing `nginx -t`,
 if the config is valid you can safely reload Nginx to make the new configuration active.
 ```bash
 systemctl reload nginx
 ```
 
-### Building the Frontend
-Next up is building the frontend, we'll first install all of the dependecies.
-```bash
-cd /opt/torrust-web-frontend
-npm i
-```
+## Setting up the Torrust Tracker
+### Getting the sources
+If you prefer to just download the compiled binaries, you can get the [latest release here](https://github.com/torrust/torrust-tracker/releases). Else:
 
-Edit the `.env.production` file to look like this, and after that we can start the build.
-```env
-VUE_APP_API_BASE_URL=/api
-```
+While in `/opt/torrust`:
 ```bash
-npm run build
+git clone https://github.com/torrust/torrust-tracker.git
 ```
-After this command succesfully completed a built version of the frontend is in the `dist` folder.
-These files are served by Nginx as specified by the `root` directive in the created config.
 
-## Setting up Torrust Tracker
-### Building
+### Building (Skip if you downloaded the binaries)
 Build the application by running the following. The binary can be found in `target/release/` after completion.
 ```bash
 cd /opt/torrust/torrust-tracker
@@ -96,7 +77,7 @@ torrust_api = "<your randomly generated string>"
 ```
 
 ### Running the Tracker
-After building and configuring the Tracker it's ready to be run. 
+After building and configuring the Tracker it's ready to be run.
 It's recommended to either run it in a screen / tmux session or to create a systemd service for it.
 
 ```bash
@@ -106,7 +87,15 @@ tmux # open a new tmux session
 > Press `CTRL+B D` to exit the tmux session without killing it.
 
 ## Setting up the Torrust Backend
-### Building
+### Getting the sources
+If you prefer to just download the compiled binaries, you can get the [latest release here](https://github.com/torrust/torrust-web-backend/releases). Else:
+
+While in `/opt/torrust`:
+```bash
+git clone https://github.com/torrust/torrust-web-backend.git
+```
+
+### Building (Skip if you downloaded the binaries)
 Before building we have to create the SQLite database and run the migrations. Install the `sqlx-cli` and setup the database.
 ```bash
 cd /opt/torrust/torrust-web-backend
@@ -150,4 +139,30 @@ Just like the Tracker it should be run in a screen / tmux session or as a system
 tmux # open a new tmux session
 ./target/release/torrust-web-backend
 ```
-> Press `CTRL+B D` to exit the tmux session without killing it.
+> Press `CTRL+B D` to exit the tmux session without killing it.
+
+## Setting up the Torrust Web Frontend
+## Getting the sources
+```bash
+git clone https://github.com/torrust/torrust-web-frontend
+```
+
+### Building the Frontend
+Next up is building the frontend, we'll first install all of the dependecies.
+
+While in `/opt/torrust`:
+```bash
+cd /opt/torrust-web-frontend
+npm i
+```
+
+Edit the `.env.production` file to look like this, and after that we can start the build.
+```env
+VUE_APP_API_BASE_URL=/api
+```
+```bash
+npm run build
+```
+After this command succesfully completed a built version of the frontend is in the `dist` folder.
+These files are served by Nginx as specified by the `root` directive in the created config.
+

docs/index.md

@@ -1,7 +1,6 @@
 # Torrust Tracker
 
-[![Torrust - torrust-website-backend](https://img.shields.io/static/v1?label=Torrust&message=torrust-tracker&color=blue&logo=github)](https://github.com/Torrust/torrust-website-backend)
-[![Build Status](https://app.travis-ci.com/torrust/torrust-tracker.svg?branch=master)](https://app.travis-ci.com/torrust/torrust-tracker)
+[![Torrust - torrust-website-backend](https://img.shields.io/static/v1?label=Torrust&message=torrust-tracker&color=blue&logo=github)](https://github.com/torrust/torrust-website-backend)
 
 __Torrust Tracker__ is a feature rich UDP based torrent tracker built with Rust.
 

docs/installation.md

@@ -5,19 +5,16 @@
 - [Rust](https://www.rust-lang.org/) - Compiler toolchain & Package Manager (cargo)
 
 ### Getting the sources
+If you prefer to just download the compiled binaries, you can get the [latest release here](https://github.com/torrust/torrust-tracker/releases). Else:
+
 ```bash
 git clone https://github.com/torrust/torrust-tracker.git
 ```
 
-If you prefer to just download the code, you can get the [latest codebase here](https://github.com/torrust/torrust-tracker/archive/master.zip).
-
-### Building
-This step will download all required dependencies (from [crates.io](https://crates.io/)) and build them as well. 
-
-Building should always be done with the latest Rust compiler.
-
+### Building (Skip if you downloaded the binaries)
+Build the application by running the following. The binary can be found in `target/release/` after completion.
 ```bash
-cd torrust-tracker
+cd /opt/torrust/torrust-tracker
 cargo build --release
 ```
 

docs/torrust-tracker/about.md

@@ -1,7 +1,6 @@
 # About
 
 [![Torrust - torrust-website-backend](https://img.shields.io/static/v1?label=Torrust&message=torrust-website-backend&color=blue&logo=github)](https://github.com/Torrust/torrust-website-backend)
-[![Build Status](https://app.travis-ci.com/torrust/torrust.svg?branch=master)](https://app.travis-ci.com/torrust/torrust)
 
 Torrust Backend is a REST API written in Rust with the Actix Web framework. 
 It handles all of the logic for the Torrust Frontend application.

docs/torrust-tracker/build.md

@@ -1,10 +1,10 @@
 site_name: Torrust Documentation
-site_url: https://docs.torrust.com/
+site_url: https://torrust.com/
 site_author: Torrust Developers
 site_description: Torrust Documentation
 
 repo_name: torrust/docs
-repo_url: https://github.com/torrust/docs
+repo_url: https://github.com/torrust/torrust-documentation
 
 theme:
   palette:
@@ -16,28 +16,28 @@ theme:
 nav:
   - Introduction: index.md
   - 'Installing Torrust': installation.md
+  - 'Torrust Tracker':
+    - About: torrust-tracker/about.md
+    - Usage: torrust-tracker/usage.md
+    - Building: torrust-tracker/build.md
+    - Config: torrust-tracker/config.md
+    - 'Tracking Modes': torrust-tracker/tracking_modes.md
+    - API: torrust-tracker/api.md
   - 'Torrust Web Backend':
     - About: torrust-web-backend/about.md
     - Usage: torrust-web-backend/usage.md
     - Building: torrust-web-backend/build.md
     - Config: torrust-web-backend/config.md
-    - API: 
+    - API:
       - Overview: torrust-web-backend/api.md
       - 'User routes': torrust-web-backend/user_api.md
       - 'Torrent routes': torrust-web-backend/torrent_api.md
       - 'Category routes': torrust-web-backend/category_api.md
-  - 'Torrust Tracker':
-    - About: torrust-tracker/about.md
-    - Usage: torrust-tracker/usage.md
-    - Building: torrust-tracker/build.md
-    - Config: torrust-tracker/config.md
-    - 'Tracking Modes': torrust-tracker/tracking_modes.md
-    - API: torrust-tracker/api.md
   - 'Torrust Web Frontend':
     - About: torrust-web-frontend/about.md
 
 
 markdown_extensions:
   - attr_list
   - pymdownx.tasklist:
-      custom_checkbox: true
+      custom_checkbox: true