From 46e9407c60650fefd0c0a3358da22d81dabe6f09 Mon Sep 17 00:00:00 2001 From: Chocobozzz Date: Thu, 23 May 2019 14:58:34 +0200 Subject: Update URLs to point to new documentation site --- support/doc/api/openapi.yaml | 4 +- support/doc/api/quickstart.md | 2 +- support/doc/development/client/code.md | 67 --------------------- support/doc/development/client/components-tree.png | Bin 22104 -> 0 bytes support/doc/development/client/components-tree.svg | 2 - support/doc/development/client/components-tree.xml | 1 - support/doc/development/server/code.md | 58 ------------------ .../server/peertube-architecture-server.xml | 1 - support/doc/development/server/upload-video.png | Bin 34643 -> 0 bytes 9 files changed, 3 insertions(+), 132 deletions(-) delete mode 100644 support/doc/development/client/code.md delete mode 100644 support/doc/development/client/components-tree.png delete mode 100644 support/doc/development/client/components-tree.svg delete mode 100644 support/doc/development/client/components-tree.xml delete mode 100644 support/doc/development/server/code.md delete mode 100644 support/doc/development/server/peertube-architecture-server.xml delete mode 100644 support/doc/development/server/upload-video.png (limited to 'support') diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml index 9963e1d26..3c7688a7c 100644 --- a/support/doc/api/openapi.yaml +++ b/support/doc/api/openapi.yaml @@ -38,7 +38,7 @@ info: } ``` externalDocs: - url: https://docs.joinpeertube.org/api.html + url: https://docs.joinpeertube.org/#/api-rest-reference.html tags: - name: Accounts description: > @@ -1739,7 +1739,7 @@ components: - Have an account with sufficient authorization levels - - [Generate](https://docs.joinpeertube.org/lang/en/devdocs/rest.html) a + - [Generate](https://docs.joinpeertube.org/#/api-rest-getting-started) a Bearer Token - Make Authenticated Requests diff --git a/support/doc/api/quickstart.md b/support/doc/api/quickstart.md index 00874a1c9..2222be741 100644 --- a/support/doc/api/quickstart.md +++ b/support/doc/api/quickstart.md @@ -47,7 +47,7 @@ $ curl -H 'Authorization: Bearer 90286a0bdf0f7315d9d3fe8dabf9e1d2be9c97d0' https ``` -### List videos +## List videos ```bash $ curl https://peertube.example.com/api/v1/videos diff --git a/support/doc/development/client/code.md b/support/doc/development/client/code.md deleted file mode 100644 index 235116e78..000000000 --- a/support/doc/development/client/code.md +++ /dev/null @@ -1,67 +0,0 @@ -# Client code documentation - -The client is a HTML/CSS/JavaScript web application (single page application -> SPA) developed with [TypeScript](https://www.typescriptlang.org/)/[Angular](https://angular.io/). - - -## Technologies - - * [TypeScript](https://www.typescriptlang.org/) -> Language - * [Angular](https://angular.io) -> JavaScript framework - * [SASS](http://sass-lang.com/) -> CSS framework - * [Webpack](https://webpack.js.org/) -> Source builder (compile TypeScript, SASS files, bundle them...) - * [Bootstrap](http://getbootstrap.com/) -> CSS framework - * [WebTorrent](https://webtorrent.io/) -> JavaScript library to make P2P in the browser - * [VideoJS](http://videojs.com/) -> JavaScript player framework - - -## Files - -The client files are in the `client` directory. The Webpack 2 configurations files are in `client/config` and the source files in `client/src`. -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. -Here is the description of the useful `client` files directory: - - tslint.json -> TypeScript linter rules - tsconfig.json -> TypeScript configuration for the compilation - .bootstraprc -> Bootstrap configuration file (which module we need) - config -> Webpack configuration files - src - |__ app -> TypeScript files for Angular application - |__ assets -> static files (images...) - |__ sass -> SASS files that are global for the application - |__ standalone -> files outside the Angular application (embed HTML page...) - |__ index.html -> root HTML file for our Angular application - |__ main.ts -> Main TypeScript file that boostraps our Angular application - |__ polyfills.ts -> Polyfills imports (ES 2015...) - -Details of the Angular application file structure. It tries to follow [the official Angular styleguide](https://angular.io/docs/ts/latest/guide/style-guide.html). - - app - |__ +admin -> Admin components (followers, users...) - |__ account -> Account components (password change...) - |__ core -> Core components/services - |__ header -> Header components (logo, search...) - |__ login -> Login component - |__ menu -> Menu component (on the left) - |__ shared -> Shared components/services (search component, REST services...) - |__ signup -> Signup form - |__ videos -> Video components (list, watch, upload...) - |__ app.component.{html,scss,ts} -> Main application component - |__ app-routing.module.ts -> Main Angular routes - |__ app.module.ts -> Angular root module that imports all submodules we need - -## Conventions - -Uses [TSLint](https://palantir.github.io/tslint/) for TypeScript linting and [Angular styleguide](https://angular.io/docs/ts/latest/guide/style-guide.html). - -## Concepts - -In a Angular application, we create components that we put together. Each component is defined by an HTML structure, a TypeScript file and optionally a SASS file. -If you are not familiar with Angular I recommend you to read the [quickstart guide](https://angular.io/docs/ts/latest/quickstart.html). - -## Components tree - -![Components tree](/support/doc/development/client/components-tree.svg) - -## Newcomers - -The main client component is `app.component.ts`. You can begin to look at this file. Then you could navigate in the different submodules to see how components are built. diff --git a/support/doc/development/client/components-tree.png b/support/doc/development/client/components-tree.png deleted file mode 100644 index 09582d742..000000000 Binary files a/support/doc/development/client/components-tree.png and /dev/null differ diff --git a/support/doc/development/client/components-tree.svg b/support/doc/development/client/components-tree.svg deleted file mode 100644 index fd6951d93..000000000 --- a/support/doc/development/client/components-tree.svg +++ /dev/null @@ -1,2 +0,0 @@ - -
App component
App component
Videos 
Videos 
Edit (upload/update)

Edit (upload/update)<div><br></div>
List
List
Watch
Watch
Account
Account
Login
Login
Admin
Admin
Follows
Follows
Video abuses
Video abuses
Users
Users
About
About
Page Not Found
<div>Page Not Found</div>
My Account
<div>My Account</div>
Video Channels
Video Channels \ No newline at end of file diff --git a/support/doc/development/client/components-tree.xml b/support/doc/development/client/components-tree.xml deleted file mode 100644 index 5a37c48bc..000000000 --- a/support/doc/development/client/components-tree.xml +++ /dev/null @@ -1 +0,0 @@ -7Zpbb5swFMc/TaTtZQLMLY9d1nYP2zSp2u3RwQ54dTAypkn36WeDSSCmVdcR3FTpQwXHN/z7G59zHGZgsd5ec1hknxnCdOY5aDsDH2aeFzuB/K8M943Bd93GkHKCGlPHcEP+YG10tLUiCJe9ioIxKkjRNyYsz3EiejbIOdv0q60Y7Y9awBQbhpsEUtP6gyCRaasbzvcFHzFJMz107EVNwRImtylnVa7Hm3lgVf81xWvY9qUnWmYQsU3HBC5nYMEZE83VervAVKFtsTXtrh4o3T03x7l4SgNPT6gU9+3cMZIo9C3jImMpyyG93Fvf1/PDqgdH3mViTeWlKy/xloifyvwu0He/2pJc8PtOkbr9pTsoBeTiQqkmDTnLcWu7IpTqOjhHbY2EwrIkSWPUVdQQv7EQ93opwUowado//ifGCl1vxXKhq7nq3kSmKZas4omG4ulFCHmKdS1NTuHqNNOYrzFbYzlHWYFjCgW5668sqBdouqu3F0leaJ2GNQPOWbNnahZb08w9a/ZMzSJrmnlnzZ6pGbCmWTymZk/F9rC2gxyeRTSaiKAfvFKCPpiKYGiF4CO7yBR0/f+kq5t+ZUQO7Dk6k5jPdbCjEwm3DX7aLppn0K0ONNo9xtNkG3XreEyOl/RSTLWt6LHvIK10pxdFUWdw60K6Na1eDz6lMt1TkDcZEfimgPU8NjLh7KM+dFor6fcWjDJe9wOwiwIc1X6Ts1vcKZmHEYDhY27uDnOBt4+6MF0K/P5CbRO8TSd9bG1ZN3N0RmA76obz8Ko7hWAEmGs8tBWMtKHrOYD8Z80Ca5qN6wVe27vk29IFGP7jO0GYlTMvhGvlEPJlWewmdgQ3giCOV8mQGwmTGC9XI7mR+CDeaaOSKfyIbzC+REQFY2+qgjKIZPuqQFDgt5I6lQO/R+ROXqainnxjWvJDi2zWq3csgQIcI39IoNhbgnAkPx8c+vkofBcYEsUDCgUjKBQYCn0i5fFCp2mQ+laRhgbSH1Ak2YkzNcLRSZlGBtOLJJE+8tRXauBa3J1j891nKclPHOnu1wwbSHdBzznYa3/O6gZ77Wq3EIV70whz6pnTkGiuLdHARMcQr1A0YC3fnZuuGq2P6VUmSaNsZlHtrtlBesUoVd+knDZU9zCkBAbU+VBAGY3A1DWY1um/6nZZlfjk0Xr22AIzqfxWYn7qSA8DyyGkg/nPGEgHEqAlq15A+mPwG6D8INLQt3k4ZZ4ADpxCfVUf9nnOF6aOra7q7/Be6CnUfykRRTaVMM8JB5T4rB53l/a/Qg3mjk0NzB2mdYiLDOY5pkfcvyfB6zoTngzI2/03t823A/vvmsHlXw== \ No newline at end of file diff --git a/support/doc/development/server/code.md b/support/doc/development/server/code.md deleted file mode 100644 index 3894c2542..000000000 --- a/support/doc/development/server/code.md +++ /dev/null @@ -1,58 +0,0 @@ -# Server code documentation - -The server is a web server developed with [TypeScript](https://www.typescriptlang.org/)/[Express](http://expressjs.com). - - -## Technologies - - * [TypeScript](https://www.typescriptlang.org/) -> Language - * [PostgreSQL](https://www.postgresql.org/) -> Database - * [Redis](https://redis.io/) -> Job queue/cache - * [Express](http://expressjs.com) -> Web server framework - * [Sequelize](http://docs.sequelizejs.com/en/v3/) -> SQL ORM - * [WebTorrent](https://webtorrent.io/) -> BitTorrent tracker and torrent creation - * [Mocha](https://mochajs.org/) -> Test framework - - -## Files - -The server main file is [server.ts](/server.ts). -The server modules description are in the [package.json](/package.json) at the project root. -All other server files are in the [server](/server) directory: - - server.ts -> app initialization, main routes configuration (static routes...) - config -> server YAML configurations (for tests, production...) - scripts -> Scripts files for npm run - server - |__ controllers -> API routes/controllers files - |__ helpers -> functions used by different part of the project (logger, utils...) - |__ initializers -> functions used at the server startup (installer, database, constants...) - |__ lib -> library function (WebTorrent, OAuth2, ActivityPub...) - |__ middlewares -> middlewares for controllers (requests validators, requests pagination...) - |__ models -> Sequelize models for each SQL tables (videos, users, accounts...) - |__ tests -> API tests and real world simulations (to test the decentralized feature...) - - -## Conventions - -Uses [JavaScript Standard Style](http://standardjs.com/). - -## Architecture - -The server is composed by: - - * a REST API (relying on the Express framework) documented on http://docs.joinpeertube.org/api.html - * a WebTorrent Tracker (slightly custom version of [webtorrent/bittorrent-tracker](https://github.com/webtorrent/bittorrent-tracker#server)) - -A video is seeded by the server with the [WebSeed](http://www.bittorrent.org/beps/bep_0019.html) protocol (HTTP). - -![Architecture scheme](/support/doc/development/server/upload-video.png) - -When a user uploads a video, the REST API creates the torrent file and then adds it to its database. - -If a user wants to watch the video, the tracker will indicate all other users that are watching the video + the HTTP url for the WebSeed. - -## Newcomers - -The server entrypoint is [server.ts](/server.ts). Looking at this file is a good start. -Then you can try to understand the [controllers](/server/controllers): they are the entrypoints of each API request. diff --git a/support/doc/development/server/peertube-architecture-server.xml b/support/doc/development/server/peertube-architecture-server.xml deleted file mode 100644 index 3299307a1..000000000 --- a/support/doc/development/server/peertube-architecture-server.xml +++ /dev/null @@ -1 +0,0 @@ -3VpRc5s4EP41nmkekgGEwH6M3aS9md5Mpnbby6MA2dBgxIHs2P31J4EECGGbxLhNzu1MYLXC0re7364Wj8BsvfuUoTT8mwQ4HllGsBuBjyPLMm3LGvH/RrAvJeOxWQpWWRQIpVowj35hITSEdBMFOFcUKSExjVJV6JMkwT5VZCjLyLOqtiSx+q0pWmFNMPdRrEt/RAENxS4sp5Z/xtEqlN9sOpNyxEP+0yojm0R838gCy+JTDq+RfJbYaB6igDw3ROBuBGYZIbS8Wu9mOObYStjKefcHRqt1ZzihfSaAcsIWxRssV1ysi+4lFsVuMNc3R2D6HEYUz1Pk89FnZn0mC+k6FsPLKI5nJCZZMVfuHUxzmpEn3Bgxig8b0VcsNrHFGcW7hkjs4BMma0yzPVMRo7YAUzgbELfPteVcqRI2rGZPhBAJb1lVT64RYxcCtG4AbQ3AbznOmMQcFsixj32/C0hvDG04EJCmpSLpmjqUlU4TSmcAJOEhJAd2yd+CJJzAP4ckGGuI4YDxm7glGQ3JiiQovqul0xpTQ8UP7yL6DxffQHH3KJQYPNm+HLKgvH8U03KKMnrLuZgJEpJgKbuP+MLFAwKp4ccozyO/FAoV/pifmNK9SBBoQwkT1ev/QkgqrUwSKtRM85gNc7LJfIGKIG22qhWWWsJuHLCjhs5wjGi0VRPGWUwinawOgFmGEWV5kC0xxEUOzIr9sIwWMaNZTsxWPQ2iLbtc8cvbIKi1tyyHkmIWz8SIIg/l1SS2msY8zV+Ym1PVDTKcR7+QVyhw26UkSmixXTgdwY9MguJolXBTsiWywAVTHi4RS6q3YmAdBUHhazHycDytUmVXwjhtT+nlWlBWZYFYrZJau4LVuDEhtJR4vRa83tvK4uEPHJWGClkuc+ZabTeo1tDLMyaaY3y9my+Y5PbhL81yL2PDAOJxYHex4djygOMMw4aTsZqg3Q4ydOCFyNC5PBmaKhm6ChkabTKsqa7Jh+Yb4EOZpJqEODgfFlPZNtG+oSDYRA+kncyfjuJCjtuqa1v6zhge02cX5QpeG5J2V+Gs03H+lBfHD17GpBhn/O7DD+x9Xcyuupl4GtFFxfJpRnwSv0tydoYi52vGzsBUCcR6Q+QsY6bhCczAlQ01n1hkDFpe1/bKwy9jc2wyPne72HziuAANxOaOc5rOJ5dic0ODaBA2tw7SeXXzWNH+eyhtTdk2aVC5/SaoHMDW0cgelpqBXkffY+qHVV3sx1FJryhNY0aBNCLJu+RYyTwDFMAGtNQEe+2Y55GsXJB0xL28b7HAICQM9B7BILTgHq7y/j+08MdOvGbHiVfGJgOOhY446eYdefRDYTCLfYnxMy//0nCz9hIUxfnNzc2B+urMDMti0+ruHgWO58CBMixo9eE6D0zuhbpHpt7SlFB6NYqlgPugAqfz74bIgeu88M5bpmDZ6a4elE+Z42yrVELl49SvYGLvBW0K1S4iCptGFKL+XN3lIIRpL+MijEOmh5OB7A5PdrJNo8PscIjKytXM/rChdTdpk8YEcbqsG0v8JDPHOLjqCE9lrl/0sfhUqtbFJ2LzMhz+Lnga6jwN+tZvjZMTdCdqWpcvQi5b40G3dWBzjtR42uzW+xz7EhWDqb9u4PUYM3GHM38hK56LLpFPIP/XlU+c4jMMr1iGWnJXJNIgFjDpIBZzkITiaFB/K8iEP7emk3bsd0XgS19LaG8legWfrcfepGfoNQCFR4j63KJaDZC2kcq9iDnHmmTqY9qVebl/7TGvCDaJ6KV7sH0puZcXgA4G7ukFQ5HrOSci+Hsgfw/JFHQE9Ntoa7fz5Mm2NrxwW9vSqLrunTDv4ERmGaLs4xXg58Xi4UrztPfQPJH5f5AG9dh1Fbtcn9k8GbY5oh/ovosK/vQpuyrYZzJTc9VLHa6xc+Bw7U68oX4tBEGPw3XXKesVtRC7rX/LVZqu/sEcuPsP \ No newline at end of file diff --git a/support/doc/development/server/upload-video.png b/support/doc/development/server/upload-video.png deleted file mode 100644 index 7edc06792..000000000 Binary files a/support/doc/development/server/upload-video.png and /dev/null differ -- cgit v1.2.3