diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index fe00d172c..4b62a7a30 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#server). 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#client). To develop on the client side: @@ -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#environment-variables Additionally to these ones, we provide some environment for dev/test purpose: diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 03a01ead5..e9621ff89 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 771c78f19..53f17a587 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -181,7 +181,7 @@ * `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#html-placeholder-elements): * `share-modal-playlist-settings` & `share-modal-video-settings` ### Features @@ -324,7 +324,7 @@ * 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#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 @@ -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#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#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#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) @@ -564,7 +564,7 @@ * 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#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#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) @@ -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#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 @@ -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#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#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#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#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#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) @@ -1046,7 +1046,7 @@ * `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#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#upgrade) * Add live RTMP port in docker compose ### Bug fixes @@ -1361,7 +1361,7 @@ * Add plugins support in embed * 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#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#peertube-redundancyjs * Add ability to pass remaining options to youtube-dl binary in peertube-import script ([@drzraf](https://github.com/drzraf)) ### 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#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 diff --git a/README.md b/README.md index fd150042c..8f3de1c97 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). 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 2a46e61df..8399b5d56 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 531fa0cfe..de9e7253e 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 8baa647fa..df4687ce9 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/shared/shared-video-live/live-documentation-link.component.html b/client/src/app/shared/shared-video-live/live-documentation-link.component.html index fca3ca825..9e5195e74 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/config/default.yaml b/config/default.yaml index 6bb827d66..d2bfae2aa 100644 --- a/config/default.yaml +++ b/config/default.yaml @@ -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#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#security for more information enabled: false # Add ability for your users to synchronize their channels with external channels, playlists, etc diff --git a/config/production.yaml.example b/config/production.yaml.example index 4a80cfe5f..0c942c5ec 100644 --- a/config/production.yaml.example +++ b/config/production.yaml.example @@ -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#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#security for more information enabled: false # Add ability for your users to synchronize their channels with external channels, playlists, etc. diff --git a/packages/types/README.md b/packages/types/README.md index f01a5b926..3151be344 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#typescript) **Typescript** section of the doc. diff --git a/server/tools/README.md b/server/tools/README.md index dab61e73e..d7ecd4004 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#remote-tools diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml index 568a0ba0d..fa50e8f17 100644 --- a/support/doc/api/openapi.yaml +++ b/support/doc/api/openapi.yaml @@ -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#roles) for a detail of their permissions. # Errors @@ -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#instances-follows - name: Instance Redundancy description: > Redundancy is part of the inter-server solidarity that PeerTube fosters. @@ -212,7 +212,7 @@ 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#instances-redundancy - name: Plugins description: > Managing plugins installed from a local path or from NPM, or search for new ones. diff --git a/support/doc/docker.md b/support/doc/docker.md index 5e018e486..e3f9b5477 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#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#what-now). ## Upgrade diff --git a/support/doc/production.md b/support/doc/production.md index 7ea313e7d..74bd3a673 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#update-host-js) there's no official support for that since it is a risky operation that might result in unforeseen errors. ### :truck: Webserver