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 /.github | |
parent | 6a160a0c9d46ee226fd0ca32ca0612e5b88881ec (diff) | |
download | PeerTube-c5c95361e6adca439ae316066366e520797f9ec0.tar.gz PeerTube-c5c95361e6adca439ae316066366e520797f9ec0.tar.zst PeerTube-c5c95361e6adca439ae316066366e520797f9ec0.zip |
Move to new documentation links
Diffstat (limited to '.github')
-rw-r--r-- | .github/CONTRIBUTING.md | 10 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/10-installation-issue.yml | 4 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/20-documentation-issue.yml | 2 | ||||
-rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 2 |
4 files changed, 9 insertions, 9 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 | |||
138 | 138 | ||
139 | ### Server side | 139 | ### Server side |
140 | 140 | ||
141 | You can find a documentation of the server code/architecture [here](https://docs.joinpeertube.org/contribute-architecture?id=server-code). | 141 | You can find a documentation of the server code/architecture [here](https://docs.joinpeertube.org/contribute/architecture?id=server-code). |
142 | 142 | ||
143 | To develop on the server-side: | 143 | To develop on the server-side: |
144 | 144 | ||
@@ -153,7 +153,7 @@ restart. | |||
153 | ### Client side | 153 | ### Client side |
154 | 154 | ||
155 | You can find a documentation of the client code/architecture | 155 | You can find a documentation of the client code/architecture |
156 | [here](https://docs.joinpeertube.org/contribute-architecture?id=client-code). | 156 | [here](https://docs.joinpeertube.org/contribute/architecture?id=client-code). |
157 | 157 | ||
158 | 158 | ||
159 | To develop on the client side: | 159 | To develop on the client side: |
@@ -242,7 +242,7 @@ To test emails with PeerTube: | |||
242 | 242 | ||
243 | ### OpenAPI documentation | 243 | ### OpenAPI documentation |
244 | 244 | ||
245 | The [REST API documentation](https://docs.joinpeertube.org/api-rest-reference.html) is generated from `support/doc/api/openapi.yaml` file. | 245 | The [REST API documentation](https://docs.joinpeertube.org/api/rest-reference.html) is generated from `support/doc/api/openapi.yaml` file. |
246 | To quickly get a preview of your changes, you can generate the documentation *on the fly* using the following command: | 246 | To quickly get a preview of your changes, you can generate the documentation *on the fly* using the following command: |
247 | 247 | ||
248 | ``` | 248 | ``` |
@@ -252,7 +252,7 @@ npx @redocly/cli preview-docs ./support/doc/api/openapi.yaml | |||
252 | ### Environment variables | 252 | ### Environment variables |
253 | 253 | ||
254 | PeerTube can be configured using environment variables. | 254 | PeerTube can be configured using environment variables. |
255 | See the list on https://docs.joinpeertube.org/maintain-configuration?id=environment-variables | 255 | See the list on https://docs.joinpeertube.org/maintain/configuration?id=environment-variables |
256 | 256 | ||
257 | Additionally to these ones, we provide some environment for dev/test purpose: | 257 | Additionally to these ones, we provide some environment for dev/test purpose: |
258 | 258 | ||
@@ -298,4 +298,4 @@ ffmpeg -stream_loop -1 -re -i any-video.mp4 -c copy -f flv rtmp://{RTMP URL}/liv | |||
298 | 298 | ||
299 | ## Plugins & Themes | 299 | ## Plugins & Themes |
300 | 300 | ||
301 | See the dedicated documentation: https://docs.joinpeertube.org/contribute-plugins | 301 | 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: | |||
5 | attributes: | 5 | attributes: |
6 | value: | | 6 | value: | |
7 | Please check the official documentation first: | 7 | Please check the official documentation first: |
8 | - Classic installation: https://docs.joinpeertube.org/install-any-os | 8 | - Classic installation: https://docs.joinpeertube.org/install/any-os |
9 | - Docker installation: https://docs.joinpeertube.org/install-docker | 9 | - Docker installation: https://docs.joinpeertube.org/install/docker |
10 | 10 | ||
11 | - type: markdown | 11 | - type: markdown |
12 | attributes: | 12 | 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: | |||
15 | description: | | 15 | description: | |
16 | Are you up to submit a pull request? Chances are, only a small edit is required, so give it a try: | 16 | Are you up to submit a pull request? Chances are, only a small edit is required, so give it a try: |
17 | * Click "Edit this page" if on https://docs.joinpeertube.org | 17 | * Click "Edit this page" if on https://docs.joinpeertube.org |
18 | * Edit https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/api/openapi.yaml if on https://docs.joinpeertube.org/api-rest-reference.html | 18 | * 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 @@ | |||
10 | ## Has this been tested? | 10 | ## Has this been tested? |
11 | 11 | ||
12 | <!-- Put an `x` in the box that applies: --> | 12 | <!-- Put an `x` in the box that applies: --> |
13 | <!-- Check the unit test guide: https://docs.joinpeertube.org/contribute-getting-started?id=unit-tests --> | 13 | <!-- Check the unit test guide: https://docs.joinpeertube.org/contribute/getting-started?id=unit-tests --> |
14 | 14 | ||
15 | - [ ] 👍 yes, I added tests to the test suite | 15 | - [ ] 👍 yes, I added tests to the test suite |
16 | - [ ] 💭 no, because this PR is a draft and still needs work | 16 | - [ ] 💭 no, because this PR is a draft and still needs work |