From c5c95361e6adca439ae316066366e520797f9ec0 Mon Sep 17 00:00:00 2001 From: Chocobozzz Date: Wed, 22 Feb 2023 16:15:14 +0100 Subject: Move to new documentation links --- .github/CONTRIBUTING.md | 10 +++++----- .github/ISSUE_TEMPLATE/10-installation-issue.yml | 4 ++-- .github/ISSUE_TEMPLATE/20-documentation-issue.yml | 2 +- .github/PULL_REQUEST_TEMPLATE.md | 2 +- 4 files changed, 9 insertions(+), 9 deletions(-) (limited to '.github') 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 -- cgit v1.2.3