From: Chocobozzz <me@florianbigard.com>
Date: Mon, 5 Mar 2018 09:00:15 +0000 (+0100)
Subject: Refractor tools documentation
X-Git-Tag: v1.0.0-alpha.4~5
X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=358770dbbd88136b211090832b24cf3d5b648234;p=oweals%2Fpeertube.git

Refractor tools documentation
---

diff --git a/README.md b/README.md
index c15f838fc..efe94b15a 100644
--- a/README.md
+++ b/README.md
@@ -165,8 +165,8 @@ For now only on Github:
 
 ## Tools
 
- * [Import videos (YouTube, Dailymotion, Vimeo...)](/support/doc/import-videos.md)
- * [Upload videos from the CLI](/support/doc/upload-cli.md)
+ * [Import videos (YouTube, Dailymotion, Vimeo...)](/support/doc/tools.md)
+ * [Upload videos from the CLI](/support/doc/tools.md)
 
 ## Architecture
 
diff --git a/support/doc/import-videos.md b/support/doc/import-videos.md
deleted file mode 100644
index 4e495d8df..000000000
--- a/support/doc/import-videos.md
+++ /dev/null
@@ -1,63 +0,0 @@
-# Import videos guide
-
-You can use this script to import videos from all [supported sites of youtube-dl](https://rg3.github.io/youtube-dl/supportedsites.html) into PeerTube.  
-Be sure you own the videos or have the author's authorization to do so.
-
- - [Installation](#installation)
- - [Usage](#usage)
-
-## Installation
-
-## Prerequisites
-
-You need at least 512MB RAM to run the script.  
-Importation can be launched directly from a PeerTube server (in this case you already have dependencies installed :+1:) or from a separate server, even a dekstop PC.  
-
-### Dependencies
-
- * [PeerTube dependencies](dependencies.md)
-
-### Installation
-
-Clone the PeerTube repo to get the latest version:
-
-```
-git clone https://github.com/Chocobozzz/PeerTube.git
-CLONE="$(pwd)/PeerTube"
-```
-
-Run ``yarn install``
-```
-cd ${CLONE}
-yarn install
-```
-
-Build server tools:
-```
-cd ${CLONE}
-npm run build:server
-```
-
-
-## Usage
-
-You are now ready to run the script : 
-
-```
-cd ${CLONE}
-node dist/server/tools/import-videos.js -u "PEERTUBE_URL" -U "PEERTUBE_USER" --password "PEERTUBE_PASSWORD" -t "TARGET_URL"
-```
-
- * PEERTUBE_URL : the full URL of your PeerTube server where you want to import, eg: https://peertube.cpy.re/
- * PEERTUBE_USER : your PeerTube account where videos will be uploaded
- * PEERTUBE_PASSWORD : password of your PeerTube account
- * TARGET_URL : the target url you want to import. Examples:
-   * YouTube:
-     * Channel: https://www.youtube.com/channel/ChannelId
-     * User https://www.youtube.com/c/UserName or https://www.youtube.com/user/UserName
-     * Video https://www.youtube.com/watch?v=blabla
-   * Vimeo: https://vimeo.com/xxxxxx
-   * Dailymotion: https://www.dailymotion.com/xxxxx
-
- The script will get all public videos from Youtube, download them and upload to PeerTube.  
- Already downloaded videos will not be uploaded twice, so you can run and re-run the script in case of crash, disconnection...
diff --git a/support/doc/tools.md b/support/doc/tools.md
new file mode 100644
index 000000000..4e431b3d4
--- /dev/null
+++ b/support/doc/tools.md
@@ -0,0 +1,74 @@
+# CLI tools guide
+
+ - [Installation](#installation)
+ - [Usage](#usage)
+   - [import-videos.js](#import-videos.js)
+   - [upload.js](#upload)
+
+## Installation
+
+## Prerequisites
+
+You need at least 512MB RAM to run the script.  
+Scripts can be launched directly from a PeerTube server (in this case you already have dependencies installed :+1:) or from a separate server, even a dekstop PC.  
+
+### Dependencies
+
+Install the [PeerTube dependencies](dependencies.md).
+
+### Installation
+
+Clone the PeerTube repo to get the latest version:
+
+```
+git clone https://github.com/Chocobozzz/PeerTube.git
+CLONE="$(pwd)/PeerTube"
+```
+
+Run ``yarn install``
+```
+cd ${CLONE}
+yarn install
+```
+
+Build server tools:
+```
+cd ${CLONE}
+npm run build:server
+```
+
+## Tools 
+
+### import-videos.js
+
+You can use this script to import videos from all [supported sites of youtube-dl](https://rg3.github.io/youtube-dl/supportedsites.html) into PeerTube.  
+Be sure you own the videos or have the author's authorization to do so.
+
+
+```
+cd ${CLONE}
+node dist/server/tools/import-videos.js -u "PEERTUBE_URL" -U "PEERTUBE_USER" --password "PEERTUBE_PASSWORD" -t "TARGET_URL"
+```
+
+ * PEERTUBE_URL : the full URL of your PeerTube server where you want to import, eg: https://peertube.cpy.re/
+ * PEERTUBE_USER : your PeerTube account where videos will be uploaded
+ * PEERTUBE_PASSWORD : password of your PeerTube account
+ * TARGET_URL : the target url you want to import. Examples:
+   * YouTube:
+     * Channel: https://www.youtube.com/channel/ChannelId
+     * User https://www.youtube.com/c/UserName or https://www.youtube.com/user/UserName
+     * Video https://www.youtube.com/watch?v=blabla
+   * Vimeo: https://vimeo.com/xxxxxx
+   * Dailymotion: https://www.dailymotion.com/xxxxx
+
+ The script will get all public videos from Youtube, download them and upload to PeerTube.  
+ Already downloaded videos will not be uploaded twice, so you can run and re-run the script in case of crash, disconnection...
+
+### upload.js
+
+You can use this script to import videos directly from the CLI.
+
+```
+cd ${CLONE}
+node dist/server/tools/upload.js --help
+```
diff --git a/support/doc/upload-cli.md b/support/doc/upload-cli.md
deleted file mode 100644
index 1eff1f0af..000000000
--- a/support/doc/upload-cli.md
+++ /dev/null
@@ -1,16 +0,0 @@
-# Upload videos from CLI
-
- - [Installation](#installation)
- - [Usage](#usage)
-
-## Installation
-
-### Dependencies
-
- * [PeerTube dependencies](dependencies.md)
-
-## Usage
-
-```
-node dist/server/tools/upload.js --help
-```