IntenseWebs/PeerTube
3
0
Fork 0
mirror of https://github.com/Chocobozzz/PeerTube.git synced 2025-02-25 18:55:32 -06:00
Code Issues Packages Projects Releases Wiki Activity

Move to new documentation links

Browse Source
This commit is contained in:
Chocobozzz
2023-02-22 16:15:14 +01:00
parent 6a160a0c9d
commit c5c95361e6
31 changed files with 125 additions and 125 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
support/doc/api/openapi.yaml
View File

@@ -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:

4
support/doc/docker.md
View File

@@ -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

8
support/doc/plugins/guide.md
View File

@@ -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

2
support/doc/production.md
View File

@@ -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

2
support/openapi/go/README.mustache
View File

@@ -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}}

2
support/openapi/python/README.mustache
View File

@@ -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}}