From 4d9939356f85cf3a320b7fa65ca24ee8ba38d9fe Mon Sep 17 00:00:00 2001 From: Bnyro Date: Mon, 30 Oct 2023 17:55:41 +0100 Subject: [PATCH 1/3] chore: remove question issue template --- .github/ISSUE_TEMPLATE/question.yml | 16 ---------------- 1 file changed, 16 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/question.yml diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml deleted file mode 100644 index a77ce23f..00000000 --- a/.github/ISSUE_TEMPLATE/question.yml +++ /dev/null @@ -1,16 +0,0 @@ -name: Question -description: Ask questions about configuration and usage of Piped. -labels: [question] -body: - - type: markdown - attributes: - value: | - Please make sure to read the README.md before posting a question or asking for support. - - - type: textarea - id: question - attributes: - label: Describe your question - description: A clear description of what your doubt is. - validations: - required: true From 558e270eb8df087ecec51a22e4503d250b9d9eaa Mon Sep 17 00:00:00 2001 From: Bnyro Date: Mon, 30 Oct 2023 18:09:27 +0100 Subject: [PATCH 2/3] chore: add issue template for adding a new instance --- .github/ISSUE_TEMPLATE/new_instance.yml | 54 +++++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/new_instance.yml diff --git a/.github/ISSUE_TEMPLATE/new_instance.yml b/.github/ISSUE_TEMPLATE/new_instance.yml new file mode 100644 index 00000000..2d1d86d1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/new_instance.yml @@ -0,0 +1,54 @@ +name: New Instance +title: "New instance: " +description: Request to add a new instance to the official list +labels: ["new-instance"] +body: + - type: input + id: api-url + attributes: + label: Api Url + description: The backend url of the instance. + placeholder: https://pipedapi.kavin.rocks + validations: + required: true + + - type: input + id: location + attributes: + label: Instance location + description: The country the instance is located in. + placeholder: Germany, 🇩🇪 + validations: + required: true + + - type: checkboxes + id: cdn + attributes: + label: CDN + description: Whether the instances uses a [CDN](https://www.cloudflare.com/learning/cdn/what-is-a-cdn/). + options: + - label: My instance does use a CDN. + + - type: checkboxes + id: approval + attributes: + label: Instance owner + description: If you're not the owner of the instance, you must leave a proof that the instance owner agreed with adding the instance to the list of public instances. + options: + - label: I am the owner of the instance. + + - type: textarea + id: other + attributes: + label: Other details + + - type: markdown + attributes: + value: | + Thank you for hosting a public Piped instance! + + - type: markdown + attributes: + value: | + If you have any further questions, please join one of the communities that are linked in the README. + From c40848aed6ba3f87df34cfaaadf9c10578a085cd Mon Sep 17 00:00:00 2001 From: Bnyro Date: Mon, 30 Oct 2023 18:21:48 +0100 Subject: [PATCH 3/3] chore: improve readme section about getting help --- .github/ISSUE_TEMPLATE/new_instance.yml | 2 +- README.md | 13 ++++++------- 2 files changed, 7 insertions(+), 8 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/new_instance.yml b/.github/ISSUE_TEMPLATE/new_instance.yml index 2d1d86d1..ed4b3c68 100644 --- a/.github/ISSUE_TEMPLATE/new_instance.yml +++ b/.github/ISSUE_TEMPLATE/new_instance.yml @@ -24,7 +24,7 @@ body: - type: checkboxes id: cdn attributes: - label: CDN + label: CDN (not required) description: Whether the instances uses a [CDN](https://www.cloudflare.com/learning/cdn/what-is-a-cdn/). options: - label: My instance does use a CDN. diff --git a/README.md b/README.md index 4fcd569c..ae0f04ff 100644 --- a/README.md +++ b/README.md @@ -57,22 +57,21 @@ By using Piped, you can freely watch and listen to content without the fear of p | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | | ![Screenshot 1](https://cloudflare-ipfs.com/ipfs/bafybeiaxhsog7jzydr7xb3xhlemxilqksceqg5fraaiuojzclhocsqrcvq) | ![Screenshot 2](https://cloudflare-ipfs.com/ipfs/bafybeigafumvrgbfyufxjptvufobstrywrfv2kteyuuictfko6kvghjszu) | ![Screenshot 3](https://cloudflare-ipfs.com/ipfs/bafybeiehs5xjqmmq34gmewxoqm3j3b2ze3pve4sdmanz7ukrxwgrcmxnry) | -## Public Chat Rooms +## Having trouble? +If you have any general questions regarding how Piped works or trouble setting up your own instance, please consult the following public chat rooms and documentation for help. Please use these platforms exclusively for such cases and do NOT open an issue. + +### Public Chat Rooms/Communities - You can join us via Matrix at [#piped](https://matrix.to/#/#piped:matrix.org). -- You can also join us at the libera.chat IRC network which is bridged to the Matrix room at [#piped](https://web.libera.chat/#piped). - -## Public Communities - - You can join us on Lemmy on the [!piped@feddit.rocks](https://feddit.rocks/c/piped) community. -## Self-Hosting +### Self-Hosting See https://docs.piped.video/docs/self-hosting/ for more details. The source code of the documentation website is available at https://github.com/TeamPiped/Documentation. -## Documentation +### Documentation The documentation can be found at https://docs.piped.video (accessible via IPNS as well).