diff options
author | Chocobozzz <me@florianbigard.com> | 2018-01-12 18:55:45 +0100 |
---|---|---|
committer | Chocobozzz <me@florianbigard.com> | 2018-01-12 18:55:45 +0100 |
commit | afe817679974cec47f5bea1699cee3fe58cd5ada (patch) | |
tree | 1134780b1dc24191d0f8a66e3ff8f206e1ca2d36 /support/doc/development | |
parent | 63bfad7ec984dad1e9a96de1f191db5cc78db5bf (diff) | |
download | PeerTube-afe817679974cec47f5bea1699cee3fe58cd5ada.tar.gz PeerTube-afe817679974cec47f5bea1699cee3fe58cd5ada.tar.zst PeerTube-afe817679974cec47f5bea1699cee3fe58cd5ada.zip |
Some markdown fixes
Diffstat (limited to 'support/doc/development')
-rw-r--r-- | support/doc/development/client/code.md | 4 | ||||
-rw-r--r-- | support/doc/development/server/code.md | 12 |
2 files changed, 8 insertions, 8 deletions
diff --git a/support/doc/development/client/code.md b/support/doc/development/client/code.md index 749783c29..f84c7b998 100644 --- a/support/doc/development/client/code.md +++ b/support/doc/development/client/code.md | |||
@@ -17,7 +17,7 @@ The client is a HTML/CSS/JavaScript web application (single page application -> | |||
17 | ## Files | 17 | ## Files |
18 | 18 | ||
19 | The client files are in the `client` directory. The Webpack 2 configurations files are in `client/config` and the source files in `client/src`. | 19 | The client files are in the `client` directory. The Webpack 2 configurations files are in `client/config` and the source files in `client/src`. |
20 | The client modules description are in the [client/package.json](https://github.com/Chocobozzz/PeerTube/blob/master/client/package.json). There are many modules that are used to compile the web application in development or production mode. | 20 | The client modules description are in the [client/package.json](/client/package.json). There are many modules that are used to compile the web application in development or production mode. |
21 | Here is the description of the useful `client` files directory: | 21 | Here is the description of the useful `client` files directory: |
22 | 22 | ||
23 | tslint.json -> TypeScript linter rules | 23 | tslint.json -> TypeScript linter rules |
@@ -60,7 +60,7 @@ If you are not familiar with Angular I recommend you to read the [quickstart gui | |||
60 | 60 | ||
61 | ## Components tree | 61 | ## Components tree |
62 | 62 | ||
63 | ![Components tree](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/client/components-tree.png) | 63 | ![Components tree](/support/doc/client/development/components-tree.png) |
64 | 64 | ||
65 | ## Newcomers | 65 | ## Newcomers |
66 | 66 | ||
diff --git a/support/doc/development/server/code.md b/support/doc/development/server/code.md index ddb93119b..a8793e807 100644 --- a/support/doc/development/server/code.md +++ b/support/doc/development/server/code.md | |||
@@ -15,9 +15,9 @@ The server is a web server developed with [TypeScript](https://www.typescriptlan | |||
15 | 15 | ||
16 | ## Files | 16 | ## Files |
17 | 17 | ||
18 | The server main file is [server.ts](https://github.com/Chocobozzz/PeerTube/blob/master/server.ts). | 18 | The server main file is [server.ts](/server.ts). |
19 | The server modules description are in the [package.json](https://github.com/Chocobozzz/PeerTube/blob/master/package.json) at the project root. | 19 | The server modules description are in the [package.json](/package.json) at the project root. |
20 | All other server files are in the [server](https://github.com/Chocobozzz/PeerTube/tree/master/server) directory: | 20 | All other server files are in the [server](/server) directory: |
21 | 21 | ||
22 | server.ts -> app initilization, main routes configuration (static routes...) | 22 | server.ts -> app initilization, main routes configuration (static routes...) |
23 | config -> server YAML configurations (for tests, production...) | 23 | config -> server YAML configurations (for tests, production...) |
@@ -45,7 +45,7 @@ The server is composed by: | |||
45 | 45 | ||
46 | A video is seeded by the server with the [WebSeed](http://www.bittorrent.org/beps/bep_0019.html) protocol (HTTP). | 46 | A video is seeded by the server with the [WebSeed](http://www.bittorrent.org/beps/bep_0019.html) protocol (HTTP). |
47 | 47 | ||
48 | ![Architecture scheme](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/server/upload-video.png) | 48 | ![Architecture scheme](/support/doc/development/server/upload-video.png) |
49 | 49 | ||
50 | When a user uploads a video, the rest API create the torrent file and then adds it to its database. | 50 | When a user uploads a video, the rest API create the torrent file and then adds it to its database. |
51 | 51 | ||
@@ -53,5 +53,5 @@ If a user wants to watch the video, the tracker will indicate all other users th | |||
53 | 53 | ||
54 | ## Newcomers | 54 | ## Newcomers |
55 | 55 | ||
56 | The server entrypoint is [server.ts](https://github.com/Chocobozzz/PeerTube/blob/master/server.ts). You can begin to look at this file. | 56 | The server entrypoint is [server.ts](/server.ts). You can begin to look at this file. |
57 | Then you can try to understand the [controllers](https://github.com/Chocobozzz/PeerTube/tree/master/server/controllers): they are the entrypoint of each API request. | 57 | Then you can try to understand the [controllers](/server/controllers): they are the entrypoint of each API request. |