From c5c95361e6adca439ae316066366e520797f9ec0 Mon Sep 17 00:00:00 2001 From: Chocobozzz Date: Wed, 22 Feb 2023 16:15:14 +0100 Subject: [PATCH] Move to new documentation links --- .github/CONTRIBUTING.md | 10 +- .../ISSUE_TEMPLATE/10-installation-issue.yml | 4 +- .../ISSUE_TEMPLATE/20-documentation-issue.yml | 2 +- .github/PULL_REQUEST_TEMPLATE.md | 2 +- CHANGELOG.md | 102 +++++++++--------- README.md | 16 +-- .../about-peertube.component.html | 6 +- .../edit-basic-configuration.component.html | 4 +- .../edit-vod-transcoding.component.html | 2 +- .../my-video-playlist-elements.component.html | 2 +- .../signup-success-after-email.component.html | 2 +- ...signup-success-before-email.component.html | 2 +- client/src/app/menu/menu.component.html | 2 +- .../modal/admin-welcome-modal.component.html | 12 +-- .../custom-markup-help.component.html | 2 +- .../live-documentation-link.component.html | 2 +- client/src/standalone/player/README.md | 2 +- config/default.yaml | 8 +- config/production.yaml.example | 8 +- packages/types/README.md | 2 +- server/middlewares/doc.ts | 2 +- server/middlewares/error.ts | 2 +- server/tests/api/check-params/videos.ts | 10 +- server/tests/api/server/follow-constraints.ts | 2 +- server/tools/README.md | 2 +- support/doc/api/openapi.yaml | 22 ++-- support/doc/docker.md | 4 +- support/doc/plugins/guide.md | 8 +- support/doc/production.md | 2 +- support/openapi/go/README.mustache | 2 +- support/openapi/python/README.mustache | 2 +- 31 files changed, 125 insertions(+), 125 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index e635969ad..fe00d172c 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -138,7 +138,7 @@ You can get a complete PeerTube development setup with Gitpod, a free one-click ### Server side -You can find a documentation of the server code/architecture [here](https://docs.joinpeertube.org/contribute-architecture?id=server-code). +You can find a documentation of the server code/architecture [here](https://docs.joinpeertube.org/contribute/architecture?id=server-code). To develop on the server-side: @@ -153,7 +153,7 @@ restart. ### Client side You can find a documentation of the client code/architecture -[here](https://docs.joinpeertube.org/contribute-architecture?id=client-code). +[here](https://docs.joinpeertube.org/contribute/architecture?id=client-code). To develop on the client side: @@ -242,7 +242,7 @@ To test emails with PeerTube: ### OpenAPI documentation -The [REST API documentation](https://docs.joinpeertube.org/api-rest-reference.html) is generated from `support/doc/api/openapi.yaml` file. +The [REST API documentation](https://docs.joinpeertube.org/api/rest-reference.html) is generated from `support/doc/api/openapi.yaml` file. To quickly get a preview of your changes, you can generate the documentation *on the fly* using the following command: ``` @@ -252,7 +252,7 @@ npx @redocly/cli preview-docs ./support/doc/api/openapi.yaml ### Environment variables PeerTube can be configured using environment variables. -See the list on https://docs.joinpeertube.org/maintain-configuration?id=environment-variables +See the list on https://docs.joinpeertube.org/maintain/configuration?id=environment-variables Additionally to these ones, we provide some environment for dev/test purpose: @@ -298,4 +298,4 @@ ffmpeg -stream_loop -1 -re -i any-video.mp4 -c copy -f flv rtmp://{RTMP URL}/liv ## Plugins & Themes -See the dedicated documentation: https://docs.joinpeertube.org/contribute-plugins +See the dedicated documentation: https://docs.joinpeertube.org/contribute/plugins diff --git a/.github/ISSUE_TEMPLATE/10-installation-issue.yml b/.github/ISSUE_TEMPLATE/10-installation-issue.yml index 7bc55b2bd..059135eff 100644 --- a/.github/ISSUE_TEMPLATE/10-installation-issue.yml +++ b/.github/ISSUE_TEMPLATE/10-installation-issue.yml @@ -5,8 +5,8 @@ body: attributes: value: | Please check the official documentation first: - - Classic installation: https://docs.joinpeertube.org/install-any-os - - Docker installation: https://docs.joinpeertube.org/install-docker + - Classic installation: https://docs.joinpeertube.org/install/any-os + - Docker installation: https://docs.joinpeertube.org/install/docker - type: markdown attributes: diff --git a/.github/ISSUE_TEMPLATE/20-documentation-issue.yml b/.github/ISSUE_TEMPLATE/20-documentation-issue.yml index 354749ad5..fc0cc6b4a 100644 --- a/.github/ISSUE_TEMPLATE/20-documentation-issue.yml +++ b/.github/ISSUE_TEMPLATE/20-documentation-issue.yml @@ -15,4 +15,4 @@ body: description: | Are you up to submit a pull request? Chances are, only a small edit is required, so give it a try: * Click "Edit this page" if on https://docs.joinpeertube.org - * Edit https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/api/openapi.yaml if on https://docs.joinpeertube.org/api-rest-reference.html + * Edit https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/api/openapi.yaml if on https://docs.joinpeertube.org/api/rest-reference.html diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index abc25477f..03a01ead5 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -10,7 +10,7 @@ ## Has this been tested? - + - [ ] 👍 yes, I added tests to the test suite - [ ] 💭 no, because this PR is a draft and still needs work diff --git a/CHANGELOG.md b/CHANGELOG.md index 0513356e3..771c78f19 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -41,7 +41,7 @@ ### Documentation - * Add [Monitoring/Observability documentation](https://docs.joinpeertube.org/maintain-observability) using PeerTube OpenTelemetry feature + * Add [Monitoring/Observability documentation](https://docs.joinpeertube.org/maintain/observability) using PeerTube OpenTelemetry feature ### Maintenance @@ -55,12 +55,12 @@ ### Plugins/Themes/Embed API - * Add server plugin hooks (https://docs.joinpeertube.org/api-plugins): + * Add server plugin hooks (https://docs.joinpeertube.org/api/plugins): * `filter:activity-pub.remote-video-comment.create.accept.result` * Add server plugin helpers * `socket.sendNotification` and `socket.sendVideoLiveNewState` [#5239](https://github.com/Chocobozzz/PeerTube/pull/5239) * Add ability for plugins to register a websocket route using `registerWebSocketRoute` - * Add client plugin hooks (https://docs.joinpeertube.org/api-plugins): + * Add client plugin hooks (https://docs.joinpeertube.org/api/plugins): * `filter:internal.player.p2p-media-loader.options.result` [#5318](https://github.com/Chocobozzz/PeerTube/pull/5318) ### CLI tools @@ -166,7 +166,7 @@ * Theme: * Removed unused `--secondaryColor` CSS variable - * Add client plugin hooks (https://docs.joinpeertube.org/api-plugins): + * Add client plugin hooks (https://docs.joinpeertube.org/api/plugins): * `filter:api.my-library.video-playlist-elements.list.params` & `filter:api.my-library.video-playlist-elements.list.result` [#5098](https://github.com/Chocobozzz/PeerTube/pull/5098) * `action:video-channel-create.init` * `action:video-channel-update.init` & `action:video-channel-update.video-channel.loaded` @@ -176,12 +176,12 @@ * `filter:share.video-embed-url.build.params` & `filter:share.video-embed-url.build.result` & `filter:share.video-playlist-embed-url.build.params` & `filter:share.video-playlist-embed-url.build.result` * `filter:share.video-url.build.params` & `filter:share.video-url.build.result` & `filter:share.video-playlist-url.build.params` & `filter:share.video-playlist-url.build.result` * `action:modal.share.shown` - * Add server plugin hooks (https://docs.joinpeertube.org/api-plugins): + * Add server plugin hooks (https://docs.joinpeertube.org/api/plugins): * `filter:job-queue.process.params` & `filter:job-queue.process.result` * `filter:transcoding.manual.resolutions-to-transcode.result` & `filter:transcoding.auto.resolutions-to-transcode.result` * `action:api.video-channel.created` & `action:api.video-channel.updated` & `action:api.video-channel.deleted` * `action:notifier.notification.created` - * Add HTML placeholder (https://docs.joinpeertube.org/contribute-plugins?id=html-placeholder-elements): + * Add HTML placeholder (https://docs.joinpeertube.org/contribute/plugins?id=html-placeholder-elements): * `share-modal-playlist-settings` & `share-modal-video-settings` ### Features @@ -324,9 +324,9 @@ * Classic installation: `cd /var/www/peertube/peertube-latest && sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production node dist/scripts/migrations/peertube-4.2.js` * Docker installation: `cd /var/www/peertube-docker && docker-compose exec -u peertube peertube node dist/scripts/migrations/peertube-4.2.js` * **Important** SQL migrations (in particular `0685-multiple-actor-images`) can take several minutes to complete - * **Important** You must update your nginx configuration to support video web editor: https://docs.joinpeertube.org/install-any-os?id=nginx + * **Important** You must update your nginx configuration to support video web editor: https://docs.joinpeertube.org/install/any-os?id=nginx * REST API: - * `PUT /api/v1/videos/{id}/watching` is deprecated, use `POST /api/v1/videos/videos/{id}/views` instead: https://docs.joinpeertube.org/api-rest-reference.html#operation/addView + * `PUT /api/v1/videos/{id}/watching` is deprecated, use `POST /api/v1/videos/videos/{id}/views` instead: https://docs.joinpeertube.org/api/rest-reference.html#operation/addView ### Maintenance @@ -348,7 +348,7 @@ * `filter:api.video-playlist.videos.list.params` and `filter:api.video-playlist.videos.list.result` * Support `getSettings()`, `isLoggedIn()` and `getAuthHeader()` client plugin helpers in embed * Player URL query parameters: - * Support `controlBar=0` to hide player control bar. See [the documentation](https://docs.joinpeertube.org/api-embed-player?id=url-parameters) for more information + * Support `controlBar=0` to hide player control bar. See [the documentation](https://docs.joinpeertube.org/api/embed-player?id=url-parameters) for more information ### Features @@ -429,8 +429,8 @@ ### Plugins/Themes/Embed API - * Introduce ability for plugins to create client pages: https://docs.joinpeertube.org/contribute-plugins?id=create-client-page - * Plugins that register custom video fields can choose in which tab they want to display them and can report errors: https://docs.joinpeertube.org/contribute-plugins?id=add-custom-fields-to-video-form + * Introduce ability for plugins to create client pages: https://docs.joinpeertube.org/contribute/plugins?id=create-client-page + * Plugins that register custom video fields can choose in which tab they want to display them and can report errors: https://docs.joinpeertube.org/contribute/plugins?id=add-custom-fields-to-video-form * Add new client plugin id selectors * Add `#plugin-selector-about-instance-moderation`, `#plugin-selector-about-instance-other-information`, `#plugin-selector-about-instance-features`, `#plugin-selector-about-instance-statistics`, `#plugin-selector-about-menu-instance`, `#plugin-selector-about-menu-peertube`, `#plugin-selector-about-menu-network` in about page [#4597](https://github.com/Chocobozzz/PeerTube/pull/4597) * Add `#plugin-selector-menu-user-dropdown-language-item` in menu [#4597](https://github.com/Chocobozzz/PeerTube/pull/4597) @@ -560,11 +560,11 @@ ### Plugins/Themes/Embed API -*Documentation: https://docs.joinpeertube.org/api-plugins* +*Documentation: https://docs.joinpeertube.org/api/plugins* * Add client plugin hooks: * `filter:api.video-watch.video-playlist-elements.get.params` and `filter:api.video-watch.video-playlist-elements.get.result` [#4387](https://github.com/Chocobozzz/PeerTube/pull/4387) - * Introduce plugin id selectors: https://docs.joinpeertube.org/contribute-plugins?id=plugin-selector-on-html-elements + * Introduce plugin id selectors: https://docs.joinpeertube.org/contribute/plugins?id=plugin-selector-on-html-elements * Add `#plugin-selector-login-form` to login form ### Docker @@ -576,7 +576,7 @@ ### CLI tools - * Add [create-move-video-storage-jobs](https://docs.joinpeertube.org/maintain-tools?id=create-move-video-storage-jobjs) script to move local video files in object storage [#4481](https://github.com/Chocobozzz/PeerTube/pull/4481) + * Add [create-move-video-storage-jobs](https://docs.joinpeertube.org/maintain/tools?id=create-move-video-storage-jobjs) script to move local video files in object storage [#4481](https://github.com/Chocobozzz/PeerTube/pull/4481) * Removed `peertube-repl` and `peertube-watch` scripts * Apply import interval only when reasonable [#4552](https://github.com/Chocobozzz/PeerTube/pull/4552) @@ -684,7 +684,7 @@ ### Plugins/Themes/Embed API -*Documentation: https://docs.joinpeertube.org/api-plugins* +*Documentation: https://docs.joinpeertube.org/api/plugins* * Server helpers * **Deprecate** `videoLanguageManager.addLanguage` and `videoLanguageManager.deleteLanguage`: use `videoLanguageManager.addConstant` and `videoLanguageManager.deleteConstant` instead @@ -698,7 +698,7 @@ ### Custom markup API -*Documentation: https://docs.joinpeertube.org/api-custom-client-markup* +*Documentation: https://docs.joinpeertube.org/api/custom-client-markup* * Add ability to only display VOD or live videos in `` element * `` fills all available width. Can be changed using `data-justify-content` attribute @@ -723,7 +723,7 @@ * Hide or display sensitive content * Choose to display all videos or only local videos * :tada: **Beta:** Add support for saving video files in object storage [#4290](https://github.com/Chocobozzz/PeerTube/pull/4290) - * Check the documentation: https://docs.joinpeertube.org/admin-remote-storage + * Check the documentation: https://docs.joinpeertube.org/admin/remote-storage * :tada: Add ability for instances to follow any actor (so specific accounts and channels) * Updated HLS.js (library to play HLS playlists in PeerTube player) to V1: * Remember last bandwidth to prevent resolution change at the beginning of the video @@ -776,7 +776,7 @@ ### IMPORTANT NOTES * **Important:** v3.2.0 introduced a `pg_dump` export bug in the auto upgrade script. v3.2.1 fixed this bug. To upgrade from v3.2.**0**: - * You can upgrade manually https://docs.joinpeertube.org/install-any-os?id=manually + * You can upgrade manually https://docs.joinpeertube.org/install/any-os?id=manually * Or you can apply the changes introduced in this commit: https://github.com/Chocobozzz/PeerTube/commit/86dc0b9cc9374cba7548bb613ff43d92f90570a8 and then use the auto upgrade script * **Important:** Due to a bug in ffmpeg, PeerTube is not compatible with ffmpeg 4.4. See https://github.com/Chocobozzz/PeerTube/issues/3990 @@ -794,16 +794,16 @@ * Add client helpers: * `getBaseRouterRoute()` [#4153](https://github.com/Chocobozzz/PeerTube/pull/4153) - * Add client plugin hooks (https://docs.joinpeertube.org/api-plugins): + * Add client plugin hooks (https://docs.joinpeertube.org/api/plugins): * `filter:left-menu.links.create.result` to add/remove left menu links * `filter:internal.player.videojs.options.result` to filter options sent to videojs player [#4126](https://github.com/Chocobozzz/PeerTube/pull/4126) - * Add server plugin hooks (https://docs.joinpeertube.org/api-plugins): + * Add server plugin hooks (https://docs.joinpeertube.org/api/plugins): * `action:api.video-playlist-element.created` ### Features - * :tada: Add ability to create a custom homepage using HTML, markdown and [custom HTML tags](https://docs.joinpeertube.org/api-custom-client-markup) [#4007](https://github.com/Chocobozzz/PeerTube/pull/4007) + * :tada: Add ability to create a custom homepage using HTML, markdown and [custom HTML tags](https://docs.joinpeertube.org/api/custom-client-markup) [#4007](https://github.com/Chocobozzz/PeerTube/pull/4007) * :tada: Add ability to search playlists in PeerTube instance and [SepiaSearch](https://sepiasearch.org/) * :tada: Shorter public URLs (old URLs are still supported): * Handle short UUID (`8r4jooaQpHp8tw1E1qpSeYq` instead of `3caf7bea-5ceb-4959-81a0-b44d184e897c`) for playlists and videos @@ -811,7 +811,7 @@ * Use `/a/:accountName` instead of `/accounts/:accountName` and `/c/:channelName` instead of `/video-channels/:channelName` [#4009](https://github.com/Chocobozzz/PeerTube/pull/4009) * Provide `/@:username` page that automatically redirect to the account or channel page [#4009](https://github.com/Chocobozzz/PeerTube/pull/4009) * :tada: Add RTL layout support - * Add ability to use HTML, markdown and [custom HTML tags](https://docs.joinpeertube.org/api-custom-client-markup) in instance description + * Add ability to use HTML, markdown and [custom HTML tags](https://docs.joinpeertube.org/api/custom-client-markup) in instance description * Default to dark theme (if available) if requested by the web browser * Add ability for admins to configure minimum age required in signup page [#4010](https://github.com/Chocobozzz/PeerTube/pull/4010) * Use a dedicated URL for each tab in publish page @@ -861,7 +861,7 @@ ### IMPORTANT NOTES * **Important:** v3.2.0 introduced a `pg_dump` export bug in the auto upgrade script. To upgrade from v3.2.0: - * You can upgrade manually https://docs.joinpeertube.org/install-any-os?id=manually + * You can upgrade manually https://docs.joinpeertube.org/install/any-os?id=manually * Or you can apply the changes introduced in this commit: https://github.com/Chocobozzz/PeerTube/commit/86dc0b9cc9374cba7548bb613ff43d92f90570a8 and then use the auto upgrade script ### Bug fixes @@ -880,9 +880,9 @@ * **Important:** Drop NodeJS 10 support * PeerTube is not compatible with NodeJS 16 yet * By default, HLS transcoding is now enabled and webtorrent is disabled. We suggest you to reflect this change. - See [the documentation](https://docs.joinpeertube.org/admin-configuration?id=webtorrent-transcoding-or-hls-transcoding) for more information + See [the documentation](https://docs.joinpeertube.org/admin/configuration?id=webtorrent-transcoding-or-hls-transcoding) for more information * PeerTube client now displays bigger video thumbnails. - To fix old thumbnails quality, run `regenerate-thumbnails` script after your PeerTube upgrade: https://docs.joinpeertube.org/maintain-tools?id=regenerate-thumbnailsjs + To fix old thumbnails quality, run `regenerate-thumbnails` script after your PeerTube upgrade: https://docs.joinpeertube.org/maintain/tools?id=regenerate-thumbnailsjs ### Docker @@ -903,9 +903,9 @@ * Theme: * `--submenuColor` becomes `--submenuBackgroundColor` - * Support HTML placeholders for plugins. See [the documentation](https://docs.joinpeertube.org/contribute-plugins?id=html-placeholder-elements) for more information + * Support HTML placeholders for plugins. See [the documentation](https://docs.joinpeertube.org/contribute/plugins?id=html-placeholder-elements) for more information * `player-next` next to the PeerTube player - * Support storing files for plugins in a dedicated directory. See [the documentation](https://docs.joinpeertube.org/contribute-plugins?id=storage) for more information + * Support storing files for plugins in a dedicated directory. See [the documentation](https://docs.joinpeertube.org/contribute/plugins?id=storage) for more information * Transcoding: * Add `inputOptions` option support for transcoding profile [#3917](https://github.com/Chocobozzz/PeerTube/pull/3917) * Add `scaleFilter.name` option support for transcoding profile [#3917](https://github.com/Chocobozzz/PeerTube/pull/3917) @@ -923,7 +923,7 @@ * `plugin.getBaseRouterRoute()` * `plugin.getDataDirectoryPath()` * `user.getAuthUser()` - * Add client plugin hooks (https://docs.joinpeertube.org/api-plugins): + * Add client plugin hooks (https://docs.joinpeertube.org/api/plugins): * `action:modal.video-download.shown` * `action:video-upload.init` * `action:video-url-import.init` @@ -932,7 +932,7 @@ * `action:auth-user.logged-in` & `action:auth-user.logged-out` * `action:auth-user.information-loaded` * `action:admin-plugin-settings.init` - * Add server plugin hooks (https://docs.joinpeertube.org/api-plugins): + * Add server plugin hooks (https://docs.joinpeertube.org/api/plugins): * `filter:api.download.video.allowed.result` & `filter:api.download.torrent.allowed.result` to forbid download * `filter:html.embed.video-playlist.allowed.result` & `filter:html.embed.video.allowed.result` to forbid embed * `filter:api.search.videos.local.list.params` & `filter:api.search.videos.local.list.result` @@ -1042,11 +1042,11 @@ ### Plugins/Themes/Embed API - * Add server plugin hooks (https://docs.joinpeertube.org/api-plugins): + * Add server plugin hooks (https://docs.joinpeertube.org/api/plugins): * `filter:api.user.me.videos.list.params` and `filter:api.user.me.videos.list.result` * Add server helpers: * `videos.loadByIdOrUUID` - * Add server transcoding helpers (https://docs.joinpeertube.org/contribute-plugins?id=add-new-transcoding-profiles): + * Add server transcoding helpers (https://docs.joinpeertube.org/contribute/plugins?id=add-new-transcoding-profiles): * `transcodingManager.addVODProfile` * `transcodingManager.addVODEncoderPriority` * `transcodingManager.addLiveProfile` @@ -1161,7 +1161,7 @@ ### Docker - * Fix [upgrade documentation](https://docs.joinpeertube.org/install-docker?id=upgrade) + * Fix [upgrade documentation](https://docs.joinpeertube.org/install/docker?id=upgrade) * Add live RTMP port in docker compose ### Bug fixes @@ -1195,13 +1195,13 @@ * Replace traefik by nginx in our docker-compose template: * Better consistency with our default setup (we now use the same stack) * Use our default nginx template enabling many optimizations - * Update the documentation to take into account this change: https://docs.joinpeertube.org/install-docker + * Update the documentation to take into account this change: https://docs.joinpeertube.org/install/docker ### Plugins/Themes/Embed API * Add ability for auth plugins to redirect user on logout [#32](https://framagit.org/framasoft/peertube/PeerTube/-/merge_requests/32) & [#33](https://framagit.org/framasoft/peertube/PeerTube/-/merge_requests/33) * Add `input-password` setting to plugins [#3375](https://github.com/Chocobozzz/PeerTube/issues/3375) - * Add server plugin hooks (https://docs.joinpeertube.org/api-plugins): + * Add server plugin hooks (https://docs.joinpeertube.org/api/plugins): * `filter:api.accounts.videos.list.params` * `filter:api.accounts.videos.list.result` * `filter:api.video-channels.videos.list.params` @@ -1352,16 +1352,16 @@ ### Plugins/Themes/Embed API - * Add embed API (https://docs.joinpeertube.org/api-embed-player): + * Add embed API (https://docs.joinpeertube.org/api/embed-player): * `playNextVideo` method * `playPreviousVideo` method * `getCurrentPosition` method * Embed URL parameters * Add ability to disable PeerTube link in embed using an URL param (`peertubeLink=0`) * Add plugins support in embed - * Add client plugin hooks (https://docs.joinpeertube.org/api-plugins): + * Add client plugin hooks (https://docs.joinpeertube.org/api/plugins): * `action:embed.player.loaded` (for embed) - * Add custom fields in video update/upload form using `registerVideoField` (https://docs.joinpeertube.org/contribute-plugins?id=add-custom-fields-to-video-form) + * Add custom fields in video update/upload form using `registerVideoField` (https://docs.joinpeertube.org/contribute/plugins?id=add-custom-fields-to-video-form) ### Features @@ -1571,7 +1571,7 @@ A new endpoint to report videos will be created in PeerTube 2.4 and will also al ### CLI tools - * Add redundancy CLI: https://docs.joinpeertube.org/maintain-tools?id=peertube-redundancyjs + * Add redundancy CLI: https://docs.joinpeertube.org/maintain/tools?id=peertube-redundancyjs * Add ability to pass remaining options to youtube-dl binary in peertube-import script ([@drzraf](https://github.com/drzraf)) ### Docker @@ -1581,19 +1581,19 @@ A new endpoint to report videos will be created in PeerTube 2.4 and will also al ### Maintenance - * Add nginx configuration to redirect videos to an S3 bucket ([@rigelk](https://github.com/rigelk)) and update of the [corresponding documentation](https://docs.joinpeertube.org/admin-remote-storage). + * Add nginx configuration to redirect videos to an S3 bucket ([@rigelk](https://github.com/rigelk)) and update of the [corresponding documentation](https://docs.joinpeertube.org/admin/remote-storage). ### Plugins/Themes/Embed API - * Add embed API (https://docs.joinpeertube.org/api-embed-player): + * Add embed API (https://docs.joinpeertube.org/api/embed-player): * `playbackState` can be `ended` * `playbackStatusUpdate` has a `duration` field * `setCaption` and `getCaptions` methods - * Add client plugin hooks (https://docs.joinpeertube.org/api-plugins): + * Add client plugin hooks (https://docs.joinpeertube.org/api/plugins): * `action:login.init` * `action:video-watch.video-threads.loaded` * `action:video-watch.video-thread-replies.loaded` ([@ipbc-dev](https://github.com/ipbc-dev)) - * Add server plugin hooks (https://docs.joinpeertube.org/api-plugins): + * Add server plugin hooks (https://docs.joinpeertube.org/api/plugins): * `filter:api.video.pre-import-url.accept.result` * `filter:api.video.pre-import-torrent.accept.result` * `filter:api.video.post-import-url.accept.result` @@ -1785,13 +1785,13 @@ A new endpoint to report videos will be created in PeerTube 2.4 and will also al We added some sections in the documentation website: - * S3 remote storage: https://docs.joinpeertube.org/admin-remote-storage - * Instances redundancy: https://docs.joinpeertube.org/admin-following-instances - * Moderate your instance: https://docs.joinpeertube.org/admin-moderation - * Customize your instance (install plugins & themes): https://docs.joinpeertube.org/admin-customize-instance - * PeerTube logs (standard log/audit log): https://docs.joinpeertube.org/admin-logs - * Mute accounts/instances: https://docs.joinpeertube.org/use-mute - * Controlled player embed API: https://docs.joinpeertube.org/api-embed-player + * S3 remote storage: https://docs.joinpeertube.org/admin/remote-storage + * Instances redundancy: https://docs.joinpeertube.org/admin/following-instances + * Moderate your instance: https://docs.joinpeertube.org/admin/moderation + * Customize your instance (install plugins & themes): https://docs.joinpeertube.org/admin/customize-instance + * PeerTube logs (standard log/audit log): https://docs.joinpeertube.org/admin/logs + * Mute accounts/instances: https://docs.joinpeertube.org/use/mute + * Controlled player embed API: https://docs.joinpeertube.org/api/embed-player ### Docker @@ -1826,7 +1826,7 @@ We added some sections in the documentation website: * PeerTube moved translations from Zanata to Weblate. Here is the new translations website URL: https://weblate.framasoft.org/projects/peertube/ * We now provide a JavaScript library to control a PeerTube embed: https://www.npmjs.com/package/@peertube/embed-api - * Add ability to generate HLS videos using `create-transcoding-job` script (see [the documentation](https://docs.joinpeertube.org/maintain-tools?id=create-transcoding-jobjs)) + * Add ability to generate HLS videos using `create-transcoding-job` script (see [the documentation](https://docs.joinpeertube.org/maintain/tools?id=create-transcoding-jobjs)) * Update nginx template: (you need to [update manually](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/production.md#nginx)) * Add streaming playlists endpoint * Add `client_body_temp_path` hint @@ -2095,7 +2095,7 @@ We added some sections in the documentation website: ### Features * :tada: Support Finnish, Greek and Scottish Gaelic languages - * :tada: Add basic plugins and themes support (**beta**): https://docs.joinpeertube.org/contribute-plugins + * :tada: Add basic plugins and themes support (**beta**): https://docs.joinpeertube.org/contribute/plugins * Install plugins or themes from the administration panel * Choose a default theme for your instance * Users can choose the theme they want among the list of themes their administrator installed diff --git a/README.md b/README.md index 5fe24a9f2..fd150042c 100644 --- a/README.md +++ b/README.md @@ -116,7 +116,7 @@ Be it as a user or an instance administrator, you can decide what your experienc

Communities that help each other

-In addition to visitors using WebTorrent to share the load among them, instances can help each other by caching one another's videos. This way even small instances have a way to show content to a wider audience, as they will be shouldered by friend instances (more about that in our redundancy guide). +In addition to visitors using WebTorrent to share the load among them, instances can help each other by caching one another's videos. This way even small instances have a way to show content to a wider audience, as they will be shouldered by friend instances (more about that in our redundancy guide).

Content creators can get help from their viewers in the simplest way possible: a support button showing a message linking to their donation accounts or really anything else. No more pay-per-view and advertisements that hurt visitors and alter creativity (more about that in our FAQ). @@ -147,7 +147,7 @@ Feel free to reach out if you have any questions or ideas! :speech_balloon: See the [production guide](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/production.md), which is the recommended way to install or upgrade PeerTube. For hardware requirements, see [Should I have a big server to run PeerTube?](https://joinpeertube.org/faq#should-i-have-a-big-server-to-run-peertube) in the FAQ. -See the [community packages](https://docs.joinpeertube.org/install-unofficial), which cover various platforms (including [YunoHost](https://install-app.yunohost.org/?app=peertube) and [Docker](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/docker.md)). +See the [community packages](https://docs.joinpeertube.org/install/unofficial), which cover various platforms (including [YunoHost](https://install-app.yunohost.org/?app=peertube) and [Docker](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/docker.md)). :book: Documentation ---------------------------------------------------------------- @@ -156,27 +156,27 @@ If you have a question, please try to find the answer in the [FAQ](https://joinp ### User documentation -See the [user documentation](https://docs.joinpeertube.org/use-setup-account). +See the [user documentation](https://docs.joinpeertube.org/use/setup-account). ### Admin documentation See [how to create your own instance](https://github.com/Chocobozzz/PeerTube/blob/develop/README.md#package-create-your-own-instance). -See the more general [admin documentation](https://docs.joinpeertube.org/admin-following-instances). +See the more general [admin documentation](https://docs.joinpeertube.org/admin/following-instances). ### Tools documentation -Learn how to import/upload videos from CLI or admin your PeerTube instance with the [tools documentation](https://docs.joinpeertube.org/maintain-tools). +Learn how to import/upload videos from CLI or admin your PeerTube instance with the [tools documentation](https://docs.joinpeertube.org/maintain/tools). ### Technical documentation -See the [architecture blueprint](https://docs.joinpeertube.org/contribute-architecture) for a more detailed explanation of the architectural choices. +See the [architecture blueprint](https://docs.joinpeertube.org/contribute/architecture) for a more detailed explanation of the architectural choices. See our REST API documentation: * OpenAPI 3.0.0 schema: [/support/doc/api/openapi.yaml](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/api/openapi.yaml) - * Spec explorer: [docs.joinpeertube.org/api-rest-reference.html](https://docs.joinpeertube.org/api-rest-reference.html) + * Spec explorer: [docs.joinpeertube.org/api-rest-reference.html](https://docs.joinpeertube.org/api/rest-reference.html) -See our [ActivityPub documentation](https://docs.joinpeertube.org/api-activitypub). +See our [ActivityPub documentation](https://docs.joinpeertube.org/api/activitypub). ## License diff --git a/client/src/app/+about/about-peertube/about-peertube.component.html b/client/src/app/+about/about-peertube/about-peertube.component.html index c0177fe6c..d1c3c678a 100644 --- a/client/src/app/+about/about-peertube/about-peertube.component.html +++ b/client/src/app/+about/about-peertube/about-peertube.component.html @@ -25,7 +25,7 @@

- Use PeerTube documentation + Use PeerTube documentation
@@ -37,7 +37,7 @@
- PeerTube Applications + PeerTube Applications
@@ -49,7 +49,7 @@
- Contribute on PeerTube + Contribute on PeerTube
diff --git a/client/src/app/+admin/config/edit-custom-config/edit-basic-configuration.component.html b/client/src/app/+admin/config/edit-custom-config/edit-basic-configuration.component.html index 2a9f9d69d..2a46e61df 100644 --- a/client/src/app/+admin/config/edit-custom-config/edit-basic-configuration.component.html +++ b/client/src/app/+admin/config/edit-custom-config/edit-basic-configuration.component.html @@ -280,7 +280,7 @@ i18n-labelText labelText="Allow import with HTTP URL (e.g. YouTube)" > - ⚠️ If enabled, we recommend to use a HTTP proxy to prevent private URL access from your PeerTube server + ⚠️ If enabled, we recommend to use a HTTP proxy to prevent private URL access from your PeerTube server
@@ -503,7 +503,7 @@
⚠️ This functionality requires a lot of attention and extra moderation.
- See the documentation for more information about the expected URL + See the documentation for more information about the expected URL diff --git a/client/src/app/+admin/config/edit-custom-config/edit-vod-transcoding.component.html b/client/src/app/+admin/config/edit-custom-config/edit-vod-transcoding.component.html index 1e7691f9e..531fa0cfe 100644 --- a/client/src/app/+admin/config/edit-custom-config/edit-vod-transcoding.component.html +++ b/client/src/app/+admin/config/edit-custom-config/edit-vod-transcoding.component.html @@ -10,7 +10,7 @@ - However, you may want to read our guidelines before tweaking the following values. + However, you may want to read our guidelines before tweaking the following values.
diff --git a/client/src/app/+my-library/my-video-playlists/my-video-playlist-elements.component.html b/client/src/app/+my-library/my-video-playlists/my-video-playlist-elements.component.html index 806dd6f48..8baa647fa 100644 --- a/client/src/app/+my-library/my-video-playlists/my-video-playlist-elements.component.html +++ b/client/src/app/+my-library/my-video-playlists/my-video-playlist-elements.component.html @@ -29,7 +29,7 @@
- See the documentation for more information. + See the documentation for more information.
diff --git a/client/src/app/+signup/shared/signup-success-after-email.component.html b/client/src/app/+signup/shared/signup-success-after-email.component.html index 1c3536ada..683e55525 100644 --- a/client/src/app/+signup/shared/signup-success-after-email.component.html +++ b/client/src/app/+signup/shared/signup-success-after-email.component.html @@ -15,7 +15,7 @@

Your email has been verified and your account has been created!

- If you need help to use PeerTube, you can have a look at the documentation. + If you need help to use PeerTube, you can have a look at the documentation.

diff --git a/client/src/app/+signup/shared/signup-success-before-email.component.html b/client/src/app/+signup/shared/signup-success-before-email.component.html index b9668ee82..8e2494b65 100644 --- a/client/src/app/+signup/shared/signup-success-before-email.component.html +++ b/client/src/app/+signup/shared/signup-success-before-email.component.html @@ -29,7 +29,7 @@

- If you need help to use PeerTube, you can have a look at the documentation. + If you need help to use PeerTube, you can have a look at the documentation.

diff --git a/client/src/app/menu/menu.component.html b/client/src/app/menu/menu.component.html index 0fb9897b9..6c5258010 100644 --- a/client/src/app/menu/menu.component.html +++ b/client/src/app/menu/menu.component.html @@ -142,7 +142,7 @@ Help FAQ Stats - API + API Keyboard shortcuts
diff --git a/client/src/app/modal/admin-welcome-modal.component.html b/client/src/app/modal/admin-welcome-modal.component.html index b74d73185..826b547c3 100644 --- a/client/src/app/modal/admin-welcome-modal.component.html +++ b/client/src/app/modal/admin-welcome-modal.component.html @@ -8,22 +8,22 @@
- - CLI + + CLI documentation
Upload or import videos, parse logs, prune storage directories, reset user password...
- - Administer + + Administer documentation
Managing users, following other instances, dealing with spammers...
- - Use + + Use documentation
Setup your account, managing video playlists, discover third-party applications...
diff --git a/client/src/app/shared/shared-custom-markup/custom-markup-help.component.html b/client/src/app/shared/shared-custom-markup/custom-markup-help.component.html index 0ca84ff78..73a2b4058 100644 --- a/client/src/app/shared/shared-custom-markup/custom-markup-help.component.html +++ b/client/src/app/shared/shared-custom-markup/custom-markup-help.component.html @@ -1,3 +1,3 @@ - Markdown compatible that also supports custom PeerTube HTML tags + Markdown compatible that also supports custom PeerTube HTML tags diff --git a/client/src/app/shared/shared-video-live/live-documentation-link.component.html b/client/src/app/shared/shared-video-live/live-documentation-link.component.html index 27248645f..fca3ca825 100644 --- a/client/src/app/shared/shared-video-live/live-documentation-link.component.html +++ b/client/src/app/shared/shared-video-live/live-documentation-link.component.html @@ -1,4 +1,4 @@

- See the documentation + See the documentation to learn how to use the PeerTube live streaming feature.

diff --git a/client/src/standalone/player/README.md b/client/src/standalone/player/README.md index 0639b4650..7b47e8f02 100644 --- a/client/src/standalone/player/README.md +++ b/client/src/standalone/player/README.md @@ -1,3 +1,3 @@ # @peertube/embed-api -See https://docs.joinpeertube.org/api-embed-player +See https://docs.joinpeertube.org/api/embed-player diff --git a/config/default.yaml b/config/default.yaml index bb4a823fa..6bb827d66 100644 --- a/config/default.yaml +++ b/config/default.yaml @@ -217,7 +217,7 @@ log: accept_client_log: true # Support of Open Telemetry metrics and tracing -# For more information: https://docs.joinpeertube.org/maintain-observability +# For more information: https://docs.joinpeertube.org/maintain/observability open_telemetry: metrics: enabled: false @@ -557,7 +557,7 @@ import: # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html http: # We recommend to use a HTTP proxy if you enable HTTP import to prevent private URL access from this server - # See https://docs.joinpeertube.org/maintain-configuration?id=security for more information + # See https://docs.joinpeertube.org/maintain/configuration?id=security for more information enabled: false youtube_dl_release: @@ -581,7 +581,7 @@ import: # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file) torrent: # We recommend to only enable magnet URI/torrent import if you trust your users - # See https://docs.joinpeertube.org/maintain-configuration?id=security for more information + # See https://docs.joinpeertube.org/maintain/configuration?id=security for more information enabled: false # Add ability for your users to synchronize their channels with external channels, playlists, etc @@ -741,7 +741,7 @@ search: search_index: enabled: false # URL of the search index, that should use the same search API and routes - # than PeerTube: https://docs.joinpeertube.org/api-rest-reference.html + # than PeerTube: https://docs.joinpeertube.org/api/rest-reference.html # You should deploy your own with https://framagit.org/framasoft/peertube/search-index, # and can use https://search.joinpeertube.org/ for tests, but keep in mind the latter is an unmoderated search index url: '' diff --git a/config/production.yaml.example b/config/production.yaml.example index f1ebf9095..4a80cfe5f 100644 --- a/config/production.yaml.example +++ b/config/production.yaml.example @@ -215,7 +215,7 @@ log: accept_client_log: true # Support of Open Telemetry metrics and tracing -# For more information: https://docs.joinpeertube.org/maintain-observability +# For more information: https://docs.joinpeertube.org/maintain/observability open_telemetry: metrics: enabled: false @@ -567,7 +567,7 @@ import: # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html http: # We recommend to use a HTTP proxy if you enable HTTP import to prevent private URL access from this server - # See https://docs.joinpeertube.org/maintain-configuration?id=security for more information + # See https://docs.joinpeertube.org/maintain/configuration?id=security for more information enabled: false youtube_dl_release: @@ -591,7 +591,7 @@ import: # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file) torrent: # We recommend to only enable magnet URI/torrent import if you trust your users - # See https://docs.joinpeertube.org/maintain-configuration?id=security for more information + # See https://docs.joinpeertube.org/maintain/configuration?id=security for more information enabled: false # Add ability for your users to synchronize their channels with external channels, playlists, etc. @@ -751,7 +751,7 @@ search: search_index: enabled: false # URL of the search index, that should use the same search API and routes - # than PeerTube: https://docs.joinpeertube.org/api-rest-reference.html + # than PeerTube: https://docs.joinpeertube.org/api/rest-reference.html # You should deploy your own with https://framagit.org/framasoft/peertube/search-index, # and can use https://search.joinpeertube.org/ for tests, but keep in mind the latter is an unmoderated search index url: '' diff --git a/packages/types/README.md b/packages/types/README.md index adeca48e5..f01a5b926 100644 --- a/packages/types/README.md +++ b/packages/types/README.md @@ -16,4 +16,4 @@ yarn add --dev @peertube/peertube-types ## Usage -> See [contribute-plugins](https://docs.joinpeertube.org/contribute-plugins?id=typescript) **Typescript** section of the doc. +> See [contribute-plugins](https://docs.joinpeertube.org/contribute/plugins?id=typescript) **Typescript** section of the doc. diff --git a/server/middlewares/doc.ts b/server/middlewares/doc.ts index eef76acaa..c43f41977 100644 --- a/server/middlewares/doc.ts +++ b/server/middlewares/doc.ts @@ -5,7 +5,7 @@ function openapiOperationDoc (options: { operationId?: string }) { return (req: express.Request, res: express.Response, next: express.NextFunction) => { - res.locals.docUrl = options.url || 'https://docs.joinpeertube.org/api-rest-reference.html#operation/' + options.operationId + res.locals.docUrl = options.url || 'https://docs.joinpeertube.org/api/rest-reference.html#operation/' + options.operationId if (next) return next() } diff --git a/server/middlewares/error.ts b/server/middlewares/error.ts index 96a85012a..7b116eb57 100644 --- a/server/middlewares/error.ts +++ b/server/middlewares/error.ts @@ -28,7 +28,7 @@ function apiFailMiddleware (req: express.Request, res: express.Response, next: e detail: message, type: type - ? `https://docs.joinpeertube.org/api-rest-reference.html#section/Errors/${type}` + ? `https://docs.joinpeertube.org/api/rest-reference.html#section/Errors/${type}` : undefined }, extension) diff --git a/server/tests/api/check-params/videos.ts b/server/tests/api/check-params/videos.ts index 572ca8997..2a83143e2 100644 --- a/server/tests/api/check-params/videos.ts +++ b/server/tests/api/check-params/videos.ts @@ -421,9 +421,9 @@ describe('Test videos API validator', function () { const error = body as unknown as PeerTubeProblemDocument if (mode === 'legacy') { - expect(error.docs).to.equal('https://docs.joinpeertube.org/api-rest-reference.html#operation/uploadLegacy') + expect(error.docs).to.equal('https://docs.joinpeertube.org/api/rest-reference.html#operation/uploadLegacy') } else { - expect(error.docs).to.equal('https://docs.joinpeertube.org/api-rest-reference.html#operation/uploadResumableInit') + expect(error.docs).to.equal('https://docs.joinpeertube.org/api/rest-reference.html#operation/uploadResumableInit') } expect(error.type).to.equal('about:blank') @@ -680,7 +680,7 @@ describe('Test videos API validator', function () { const res = await makePutBodyRequest({ url: server.url, path: path + video.shortUUID, token: server.accessToken, fields }) const error = res.body as PeerTubeProblemDocument - expect(error.docs).to.equal('https://docs.joinpeertube.org/api-rest-reference.html#operation/putVideo') + expect(error.docs).to.equal('https://docs.joinpeertube.org/api/rest-reference.html#operation/putVideo') expect(error.type).to.equal('about:blank') expect(error.title).to.equal('Bad Request') @@ -729,7 +729,7 @@ describe('Test videos API validator', function () { const body = await server.videos.get({ id: 'hi', expectedStatus: HttpStatusCode.BAD_REQUEST_400 }) const error = body as unknown as PeerTubeProblemDocument - expect(error.docs).to.equal('https://docs.joinpeertube.org/api-rest-reference.html#operation/getVideo') + expect(error.docs).to.equal('https://docs.joinpeertube.org/api/rest-reference.html#operation/getVideo') expect(error.type).to.equal('about:blank') expect(error.title).to.equal('Bad Request') @@ -835,7 +835,7 @@ describe('Test videos API validator', function () { const body = await server.videos.remove({ id: 'hello', expectedStatus: HttpStatusCode.BAD_REQUEST_400 }) const error = body as PeerTubeProblemDocument - expect(error.docs).to.equal('https://docs.joinpeertube.org/api-rest-reference.html#operation/delVideo') + expect(error.docs).to.equal('https://docs.joinpeertube.org/api/rest-reference.html#operation/delVideo') expect(error.type).to.equal('about:blank') expect(error.title).to.equal('Bad Request') diff --git a/server/tests/api/server/follow-constraints.ts b/server/tests/api/server/follow-constraints.ts index ff5332858..704d6fc96 100644 --- a/server/tests/api/server/follow-constraints.ts +++ b/server/tests/api/server/follow-constraints.ts @@ -146,7 +146,7 @@ describe('Test follow constraints', function () { const body = await servers[0].videos.get({ id: video2UUID, expectedStatus: HttpStatusCode.FORBIDDEN_403 }) const error = body as unknown as PeerTubeProblemDocument - const doc = 'https://docs.joinpeertube.org/api-rest-reference.html#section/Errors/does_not_respect_follow_constraints' + const doc = 'https://docs.joinpeertube.org/api/rest-reference.html#section/Errors/does_not_respect_follow_constraints' expect(error.type).to.equal(doc) expect(error.code).to.equal(ServerErrorCode.DOES_NOT_RESPECT_FOLLOW_CONSTRAINTS) diff --git a/server/tools/README.md b/server/tools/README.md index 449c57ce1..dab61e73e 100644 --- a/server/tools/README.md +++ b/server/tools/README.md @@ -1,3 +1,3 @@ # PeerTube CLI -See https://docs.joinpeertube.org/maintain-tools?id=remote-tools +See https://docs.joinpeertube.org/maintain/tools?id=remote-tools diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml index 79417e34f..568a0ba0d 100644 --- a/support/doc/api/openapi.yaml +++ b/support/doc/api/openapi.yaml @@ -21,7 +21,7 @@ info: - [Go](https://framagit.org/framasoft/peertube/clients/go) - [Kotlin](https://framagit.org/framasoft/peertube/clients/kotlin) - See the [REST API quick start](https://docs.joinpeertube.org/api-rest-getting-started) for a few + See the [REST API quick start](https://docs.joinpeertube.org/api/rest-getting-started) for a few examples of using the PeerTube API. # Authentication @@ -33,7 +33,7 @@ info: ## Roles Accounts are given permissions based on their role. There are three roles on - PeerTube: Administrator, Moderator, and User. See the [roles guide](https://docs.joinpeertube.org/admin-managing-users?id=roles) for a detail of their permissions. + PeerTube: Administrator, Moderator, and User. See the [roles guide](https://docs.joinpeertube.org/admin/managing-users?id=roles) for a detail of their permissions. # Errors @@ -46,7 +46,7 @@ info: { "detail": "Video not found", - "docs": "https://docs.joinpeertube.org/api-rest-reference.html#operation/getVideo", + "docs": "https://docs.joinpeertube.org/api/rest-reference.html#operation/getVideo", "status": 404, "title": "Not Found", "type": "about:blank" @@ -63,10 +63,10 @@ info: { "detail": "Cannot get this video regarding follow constraints", - "docs": "https://docs.joinpeertube.org/api-rest-reference.html#operation/getVideo", + "docs": "https://docs.joinpeertube.org/api/rest-reference.html#operation/getVideo", "status": 403, "title": "Forbidden", - "type": "https://docs.joinpeertube.org/api-rest-reference.html#section/Errors/does_not_respect_follow_constraints" + "type": "https://docs.joinpeertube.org/api/rest-reference.html#section/Errors/does_not_respect_follow_constraints" } ``` @@ -84,7 +84,7 @@ info: { "detail": "Incorrect request parameters: id", - "docs": "https://docs.joinpeertube.org/api-rest-reference.html#operation/getVideo", + "docs": "https://docs.joinpeertube.org/api/rest-reference.html#operation/getVideo", "instance": "/api/v1/videos/9c9de5e8-0a1e-484a-b099-e80766180", "invalid-params": { "id": { @@ -149,7 +149,7 @@ info: In addition, all routes serving ActivityPub are CORS-enabled for all origins. externalDocs: - url: https://docs.joinpeertube.org/api-rest-reference.html + url: https://docs.joinpeertube.org/api/rest-reference.html tags: - name: Register description: | @@ -204,7 +204,7 @@ tags: information across its social graph by posting activities to actors' inbox endpoints. externalDocs: - url: https://docs.joinpeertube.org/admin-following-instances?id=instances-follows + url: https://docs.joinpeertube.org/admin/following-instances?id=instances-follows - name: Instance Redundancy description: > Redundancy is part of the inter-server solidarity that PeerTube fosters. @@ -212,12 +212,12 @@ tags: to the policy of video selection of your choice. Note that you have a similar functionality to mirror individual videos, see [video mirroring](#tag/Video-Mirroring). externalDocs: - url: https://docs.joinpeertube.org/admin-following-instances?id=instances-redundancy + url: https://docs.joinpeertube.org/admin/following-instances?id=instances-redundancy - name: Plugins description: > Managing plugins installed from a local path or from NPM, or search for new ones. externalDocs: - url: https://docs.joinpeertube.org/api-plugins + url: https://docs.joinpeertube.org/api/plugins - name: Abuses description: | Abuses deal with reports of local or remote videos/comments/accounts alike. @@ -5933,7 +5933,7 @@ components: Note that the __access token is valid for 1 day__ and is given along with a __refresh token valid for 2 weeks__. - [Generate]: https://docs.joinpeertube.org/api-rest-getting-started + [Generate]: https://docs.joinpeertube.org/api/rest-getting-started type: oauth2 flows: password: diff --git a/support/doc/docker.md b/support/doc/docker.md index 6fc443c8e..5e018e486 100644 --- a/support/doc/docker.md +++ b/support/doc/docker.md @@ -119,11 +119,11 @@ peertube._domainkey.mydomain.tld. IN TXT ( "v=DKIM1; h=sha256; k=rsa; " #### Administrator password -See the production guide ["Administrator" section](https://docs.joinpeertube.org/install-any-os?id=technologist-administrator) +See the production guide ["Administrator" section](https://docs.joinpeertube.org/install/any-os?id=technologist-administrator) #### What now? -See the production guide ["What now" section](https://docs.joinpeertube.org/install-any-os?id=tada-what-now). +See the production guide ["What now" section](https://docs.joinpeertube.org/install/any-os?id=tada-what-now). ## Upgrade diff --git a/support/doc/plugins/guide.md b/support/doc/plugins/guide.md index f82dbd15b..2cc544f1c 100644 --- a/support/doc/plugins/guide.md +++ b/support/doc/plugins/guide.md @@ -585,7 +585,7 @@ async function register ({ } ``` -See the [plugin API reference](https://docs.joinpeertube.org/api-plugins) to see the complete helpers list. +See the [plugin API reference](https://docs.joinpeertube.org/api/plugins) to see the complete helpers list. ### Client API (themes & plugins) @@ -839,7 +839,7 @@ PeerTube provides some selectors (using `id` HTML attribute) on important blocks For example `#plugin-selector-login-form` could be used to hide the login form. -See the complete list on https://docs.joinpeertube.org/api-plugins +See the complete list on https://docs.joinpeertube.org/api/plugins #### HTML placeholder elements @@ -855,7 +855,7 @@ async function register (...) { } ``` -See the complete list on https://docs.joinpeertube.org/api-plugins +See the complete list on https://docs.joinpeertube.org/api/plugins #### Add/remove left menu links @@ -1140,7 +1140,7 @@ $ npm deprecate peertube-plugin-xxx@"> 0.0.0" "explain here why you deprecate yo ## Plugin & Theme hooks/helpers API -See the dedicated documentation: https://docs.joinpeertube.org/api-plugins +See the dedicated documentation: https://docs.joinpeertube.org/api/plugins ## Tips diff --git a/support/doc/production.md b/support/doc/production.md index 3a71a1a80..7ea313e7d 100644 --- a/support/doc/production.md +++ b/support/doc/production.md @@ -125,7 +125,7 @@ Then edit the `config/production.yaml` file according to your webserver and data Keys defined in `config/production.yaml` will override keys defined in `config/default.yaml`. -**PeerTube does not support webserver host change**. Even though [PeerTube CLI can help you to switch hostname](https://docs.joinpeertube.org/maintain-tools?id=update-hostjs) there's no official support for that since it is a risky operation that might result in unforeseen errors. +**PeerTube does not support webserver host change**. Even though [PeerTube CLI can help you to switch hostname](https://docs.joinpeertube.org/maintain/tools?id=update-hostjs) there's no official support for that since it is a risky operation that might result in unforeseen errors. ### :truck: Webserver diff --git a/support/openapi/go/README.mustache b/support/openapi/go/README.mustache index d0fc0fa33..d58657b5b 100644 --- a/support/openapi/go/README.mustache +++ b/support/openapi/go/README.mustache @@ -1,6 +1,6 @@ # Go API client for {{appName}} -This Python package is automatically generated from [PeerTube's REST API](https://docs.joinpeertube.org/api-rest-reference.html), +This Python package is automatically generated from [PeerTube's REST API](https://docs.joinpeertube.org/api/rest-reference.html), using the [OpenAPI Generator](https://openapi-generator.tech) project: - API version: {{appVersion}} diff --git a/support/openapi/python/README.mustache b/support/openapi/python/README.mustache index 93dcd5ab6..de41970e8 100644 --- a/support/openapi/python/README.mustache +++ b/support/openapi/python/README.mustache @@ -1,6 +1,6 @@ # Python API client for {{appName}} -This Python package is automatically generated from [PeerTube's REST API](https://docs.joinpeertube.org/api-rest-reference.html), +This Python package is automatically generated from [PeerTube's REST API](https://docs.joinpeertube.org/api/rest-reference.html), using the [OpenAPI Generator](https://openapi-generator.tech) project: - API version: {{appVersion}} -- 2.41.0