diff options
author | Chocobozzz <me@florianbigard.com> | 2023-02-22 16:15:14 +0100 |
---|---|---|
committer | Chocobozzz <me@florianbigard.com> | 2023-02-22 16:15:14 +0100 |
commit | c5c95361e6adca439ae316066366e520797f9ec0 (patch) | |
tree | febf82864951f04f6c71df51107fe2231a0c6a7a /support | |
parent | 6a160a0c9d46ee226fd0ca32ca0612e5b88881ec (diff) | |
download | PeerTube-c5c95361e6adca439ae316066366e520797f9ec0.tar.gz PeerTube-c5c95361e6adca439ae316066366e520797f9ec0.tar.zst PeerTube-c5c95361e6adca439ae316066366e520797f9ec0.zip |
Move to new documentation links
Diffstat (limited to 'support')
-rw-r--r-- | support/doc/api/openapi.yaml | 22 | ||||
-rw-r--r-- | support/doc/docker.md | 4 | ||||
-rw-r--r-- | support/doc/plugins/guide.md | 8 | ||||
-rw-r--r-- | support/doc/production.md | 2 | ||||
-rw-r--r-- | support/openapi/go/README.mustache | 2 | ||||
-rw-r--r-- | support/openapi/python/README.mustache | 2 |
6 files changed, 20 insertions, 20 deletions
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: | |||
21 | - [Go](https://framagit.org/framasoft/peertube/clients/go) | 21 | - [Go](https://framagit.org/framasoft/peertube/clients/go) |
22 | - [Kotlin](https://framagit.org/framasoft/peertube/clients/kotlin) | 22 | - [Kotlin](https://framagit.org/framasoft/peertube/clients/kotlin) |
23 | 23 | ||
24 | See the [REST API quick start](https://docs.joinpeertube.org/api-rest-getting-started) for a few | 24 | See the [REST API quick start](https://docs.joinpeertube.org/api/rest-getting-started) for a few |
25 | examples of using the PeerTube API. | 25 | examples of using the PeerTube API. |
26 | 26 | ||
27 | # Authentication | 27 | # Authentication |
@@ -33,7 +33,7 @@ info: | |||
33 | ## Roles | 33 | ## Roles |
34 | 34 | ||
35 | Accounts are given permissions based on their role. There are three roles on | 35 | Accounts are given permissions based on their role. There are three roles on |
36 | PeerTube: Administrator, Moderator, and User. See the [roles guide](https://docs.joinpeertube.org/admin-managing-users?id=roles) for a detail of their permissions. | 36 | PeerTube: Administrator, Moderator, and User. See the [roles guide](https://docs.joinpeertube.org/admin/managing-users?id=roles) for a detail of their permissions. |
37 | 37 | ||
38 | # Errors | 38 | # Errors |
39 | 39 | ||
@@ -46,7 +46,7 @@ info: | |||
46 | 46 | ||
47 | { | 47 | { |
48 | "detail": "Video not found", | 48 | "detail": "Video not found", |
49 | "docs": "https://docs.joinpeertube.org/api-rest-reference.html#operation/getVideo", | 49 | "docs": "https://docs.joinpeertube.org/api/rest-reference.html#operation/getVideo", |
50 | "status": 404, | 50 | "status": 404, |
51 | "title": "Not Found", | 51 | "title": "Not Found", |
52 | "type": "about:blank" | 52 | "type": "about:blank" |
@@ -63,10 +63,10 @@ info: | |||
63 | 63 | ||
64 | { | 64 | { |
65 | "detail": "Cannot get this video regarding follow constraints", | 65 | "detail": "Cannot get this video regarding follow constraints", |
66 | "docs": "https://docs.joinpeertube.org/api-rest-reference.html#operation/getVideo", | 66 | "docs": "https://docs.joinpeertube.org/api/rest-reference.html#operation/getVideo", |
67 | "status": 403, | 67 | "status": 403, |
68 | "title": "Forbidden", | 68 | "title": "Forbidden", |
69 | "type": "https://docs.joinpeertube.org/api-rest-reference.html#section/Errors/does_not_respect_follow_constraints" | 69 | "type": "https://docs.joinpeertube.org/api/rest-reference.html#section/Errors/does_not_respect_follow_constraints" |
70 | } | 70 | } |
71 | ``` | 71 | ``` |
72 | 72 | ||
@@ -84,7 +84,7 @@ info: | |||
84 | 84 | ||
85 | { | 85 | { |
86 | "detail": "Incorrect request parameters: id", | 86 | "detail": "Incorrect request parameters: id", |
87 | "docs": "https://docs.joinpeertube.org/api-rest-reference.html#operation/getVideo", | 87 | "docs": "https://docs.joinpeertube.org/api/rest-reference.html#operation/getVideo", |
88 | "instance": "/api/v1/videos/9c9de5e8-0a1e-484a-b099-e80766180", | 88 | "instance": "/api/v1/videos/9c9de5e8-0a1e-484a-b099-e80766180", |
89 | "invalid-params": { | 89 | "invalid-params": { |
90 | "id": { | 90 | "id": { |
@@ -149,7 +149,7 @@ info: | |||
149 | 149 | ||
150 | In addition, all routes serving ActivityPub are CORS-enabled for all origins. | 150 | In addition, all routes serving ActivityPub are CORS-enabled for all origins. |
151 | externalDocs: | 151 | externalDocs: |
152 | url: https://docs.joinpeertube.org/api-rest-reference.html | 152 | url: https://docs.joinpeertube.org/api/rest-reference.html |
153 | tags: | 153 | tags: |
154 | - name: Register | 154 | - name: Register |
155 | description: | | 155 | description: | |
@@ -204,7 +204,7 @@ tags: | |||
204 | information across its social graph by posting activities to actors' inbox | 204 | information across its social graph by posting activities to actors' inbox |
205 | endpoints. | 205 | endpoints. |
206 | externalDocs: | 206 | externalDocs: |
207 | url: https://docs.joinpeertube.org/admin-following-instances?id=instances-follows | 207 | url: https://docs.joinpeertube.org/admin/following-instances?id=instances-follows |
208 | - name: Instance Redundancy | 208 | - name: Instance Redundancy |
209 | description: > | 209 | description: > |
210 | Redundancy is part of the inter-server solidarity that PeerTube fosters. | 210 | Redundancy is part of the inter-server solidarity that PeerTube fosters. |
@@ -212,12 +212,12 @@ tags: | |||
212 | to the policy of video selection of your choice. Note that you have a similar functionality | 212 | to the policy of video selection of your choice. Note that you have a similar functionality |
213 | to mirror individual videos, see [video mirroring](#tag/Video-Mirroring). | 213 | to mirror individual videos, see [video mirroring](#tag/Video-Mirroring). |
214 | externalDocs: | 214 | externalDocs: |
215 | url: https://docs.joinpeertube.org/admin-following-instances?id=instances-redundancy | 215 | url: https://docs.joinpeertube.org/admin/following-instances?id=instances-redundancy |
216 | - name: Plugins | 216 | - name: Plugins |
217 | description: > | 217 | description: > |
218 | Managing plugins installed from a local path or from NPM, or search for new ones. | 218 | Managing plugins installed from a local path or from NPM, or search for new ones. |
219 | externalDocs: | 219 | externalDocs: |
220 | url: https://docs.joinpeertube.org/api-plugins | 220 | url: https://docs.joinpeertube.org/api/plugins |
221 | - name: Abuses | 221 | - name: Abuses |
222 | description: | | 222 | description: | |
223 | Abuses deal with reports of local or remote videos/comments/accounts alike. | 223 | Abuses deal with reports of local or remote videos/comments/accounts alike. |
@@ -5933,7 +5933,7 @@ components: | |||
5933 | Note that the __access token is valid for 1 day__ and is given | 5933 | Note that the __access token is valid for 1 day__ and is given |
5934 | along with a __refresh token valid for 2 weeks__. | 5934 | along with a __refresh token valid for 2 weeks__. |
5935 | 5935 | ||
5936 | [Generate]: https://docs.joinpeertube.org/api-rest-getting-started | 5936 | [Generate]: https://docs.joinpeertube.org/api/rest-getting-started |
5937 | type: oauth2 | 5937 | type: oauth2 |
5938 | flows: | 5938 | flows: |
5939 | password: | 5939 | 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; " | |||
119 | 119 | ||
120 | #### Administrator password | 120 | #### Administrator password |
121 | 121 | ||
122 | See the production guide ["Administrator" section](https://docs.joinpeertube.org/install-any-os?id=technologist-administrator) | 122 | See the production guide ["Administrator" section](https://docs.joinpeertube.org/install/any-os?id=technologist-administrator) |
123 | 123 | ||
124 | #### What now? | 124 | #### What now? |
125 | 125 | ||
126 | See the production guide ["What now" section](https://docs.joinpeertube.org/install-any-os?id=tada-what-now). | 126 | See the production guide ["What now" section](https://docs.joinpeertube.org/install/any-os?id=tada-what-now). |
127 | 127 | ||
128 | ## Upgrade | 128 | ## Upgrade |
129 | 129 | ||
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 ({ | |||
585 | } | 585 | } |
586 | ``` | 586 | ``` |
587 | 587 | ||
588 | See the [plugin API reference](https://docs.joinpeertube.org/api-plugins) to see the complete helpers list. | 588 | See the [plugin API reference](https://docs.joinpeertube.org/api/plugins) to see the complete helpers list. |
589 | 589 | ||
590 | ### Client API (themes & plugins) | 590 | ### Client API (themes & plugins) |
591 | 591 | ||
@@ -839,7 +839,7 @@ PeerTube provides some selectors (using `id` HTML attribute) on important blocks | |||
839 | 839 | ||
840 | For example `#plugin-selector-login-form` could be used to hide the login form. | 840 | For example `#plugin-selector-login-form` could be used to hide the login form. |
841 | 841 | ||
842 | See the complete list on https://docs.joinpeertube.org/api-plugins | 842 | See the complete list on https://docs.joinpeertube.org/api/plugins |
843 | 843 | ||
844 | #### HTML placeholder elements | 844 | #### HTML placeholder elements |
845 | 845 | ||
@@ -855,7 +855,7 @@ async function register (...) { | |||
855 | } | 855 | } |
856 | ``` | 856 | ``` |
857 | 857 | ||
858 | See the complete list on https://docs.joinpeertube.org/api-plugins | 858 | See the complete list on https://docs.joinpeertube.org/api/plugins |
859 | 859 | ||
860 | #### Add/remove left menu links | 860 | #### Add/remove left menu links |
861 | 861 | ||
@@ -1140,7 +1140,7 @@ $ npm deprecate peertube-plugin-xxx@"> 0.0.0" "explain here why you deprecate yo | |||
1140 | 1140 | ||
1141 | ## Plugin & Theme hooks/helpers API | 1141 | ## Plugin & Theme hooks/helpers API |
1142 | 1142 | ||
1143 | See the dedicated documentation: https://docs.joinpeertube.org/api-plugins | 1143 | See the dedicated documentation: https://docs.joinpeertube.org/api/plugins |
1144 | 1144 | ||
1145 | 1145 | ||
1146 | ## Tips | 1146 | ## 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 | |||
125 | 125 | ||
126 | Keys defined in `config/production.yaml` will override keys defined in `config/default.yaml`. | 126 | Keys defined in `config/production.yaml` will override keys defined in `config/default.yaml`. |
127 | 127 | ||
128 | **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. | 128 | **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. |
129 | 129 | ||
130 | ### :truck: Webserver | 130 | ### :truck: Webserver |
131 | 131 | ||
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 @@ | |||
1 | # Go API client for {{appName}} | 1 | # Go API client for {{appName}} |
2 | 2 | ||
3 | This Python package is automatically generated from [PeerTube's REST API](https://docs.joinpeertube.org/api-rest-reference.html), | 3 | This Python package is automatically generated from [PeerTube's REST API](https://docs.joinpeertube.org/api/rest-reference.html), |
4 | using the [OpenAPI Generator](https://openapi-generator.tech) project: | 4 | using the [OpenAPI Generator](https://openapi-generator.tech) project: |
5 | 5 | ||
6 | - API version: {{appVersion}} | 6 | - 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 @@ | |||
1 | # Python API client for {{appName}} | 1 | # Python API client for {{appName}} |
2 | 2 | ||
3 | This Python package is automatically generated from [PeerTube's REST API](https://docs.joinpeertube.org/api-rest-reference.html), | 3 | This Python package is automatically generated from [PeerTube's REST API](https://docs.joinpeertube.org/api/rest-reference.html), |
4 | using the [OpenAPI Generator](https://openapi-generator.tech) project: | 4 | using the [OpenAPI Generator](https://openapi-generator.tech) project: |
5 | 5 | ||
6 | - API version: {{appVersion}} | 6 | - API version: {{appVersion}} |