diff options
author | 2023-02-15 20:05:34 +0100 | |
---|---|---|
committer | 2023-02-16 09:40:30 +0530 | |
commit | 362282fe801c9994eae4b6518550beca9c806d0b (patch) | |
tree | 8439d361e904dc0be7345d7ad15d9833d74baa14 | |
parent | docs: reorder issues templates (diff) | |
download | ferdium-app-362282fe801c9994eae4b6518550beca9c806d0b.tar.gz ferdium-app-362282fe801c9994eae4b6518550beca9c806d0b.tar.zst ferdium-app-362282fe801c9994eae4b6518550beca9c806d0b.zip |
docs: fix dead links
-rw-r--r-- | .github/ISSUE_TEMPLATE/app_bug_report.yml | 7 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/app_feature_request.yml | 9 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/recipe_bug_report.yml | 14 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/recipe_request.yml | 16 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/something_else_open_issue.yml | 3 |
5 files changed, 20 insertions, 29 deletions
diff --git a/.github/ISSUE_TEMPLATE/app_bug_report.yml b/.github/ISSUE_TEMPLATE/app_bug_report.yml index 022266e65..5e4afeacd 100644 --- a/.github/ISSUE_TEMPLATE/app_bug_report.yml +++ b/.github/ISSUE_TEMPLATE/app_bug_report.yml | |||
@@ -5,15 +5,16 @@ body: | |||
5 | - type: markdown | 5 | - type: markdown |
6 | attributes: | 6 | attributes: |
7 | value: | | 7 | value: | |
8 | 1. Please remember to read the [self-help documentation](https://github.com/ferdium/ferdium-app#troubleshooting-recipes-self-help) - in case it helps you unblock yourself for issues related to old recipes. | 8 | 1. Please fill our form below, this way we can analyse and fix the problem as fast as possible. |
9 | 2. If you are adding screenshots and/or videos, please do add it in English so that a wider group of people can understand and help with resolution. | 9 | 2. If you are adding screenshots and/or videos, please do add it in English so that a wider group of people can understand and help with resolution. |
10 | 3. Please fill our form below, this way we can analyse and fix the problem as fast as possible. | ||
11 | - type: checkboxes | 10 | - type: checkboxes |
12 | attributes: | 11 | attributes: |
13 | label: Avoid duplicates | 12 | label: Avoid duplicates |
14 | description: Please ensure you've completed the following | 13 | description: Please ensure you've completed the following |
15 | options: | 14 | options: |
16 | - label: I have searched the [issues tracker](https://github.com/ferdium/ferdium-app/issues) for a bug report similar to mine, in vain | 15 | - label: I agree to follow the [Code of Conduct](https://github.com/ferdium/ferdium-app/blob/HEAD/CODE_OF_CONDUCT.md) that this project adheres to. |
16 | required: true | ||
17 | - label: I have searched the [issues tracker](https://github.com/ferdium/ferdium-app/issues?q=is%3Aopen+is%3Aissue+label%3A%22bug+%3Abeetle%3A%22) for a bug report similar to mine, in vain | ||
17 | required: true | 18 | required: true |
18 | - type: input | 19 | - type: input |
19 | attributes: | 20 | attributes: |
diff --git a/.github/ISSUE_TEMPLATE/app_feature_request.yml b/.github/ISSUE_TEMPLATE/app_feature_request.yml index f96d88d0a..0b7706ace 100644 --- a/.github/ISSUE_TEMPLATE/app_feature_request.yml +++ b/.github/ISSUE_TEMPLATE/app_feature_request.yml | |||
@@ -5,19 +5,18 @@ body: | |||
5 | - type: markdown | 5 | - type: markdown |
6 | attributes: | 6 | attributes: |
7 | value: | | 7 | value: | |
8 | 1. Please remember to read the [self-help documentation](https://github.com/ferdium/ferdium-app#troubleshooting-recipes-self-help) - in case it helps you unblock yourself for issues related to old recipes. | 8 | 1. Please fill our form below, this way we can analyse and fix the problem as fast as possible. |
9 | 2. If you are adding screenshots and/or videos, please do add it in English so that a wider group of people can understand and help with resolution. | 9 | 2. If you are adding screenshots and/or videos, please do add it in English so that a wider group of people can understand and help with resolution. |
10 | 3. Please fill our form below, this way we can analyse and fix the problem as fast as possible. | ||
11 | - type: checkboxes | 10 | - type: checkboxes |
12 | attributes: | 11 | attributes: |
13 | label: Preflight Checklist | 12 | label: Preflight Checklist |
14 | description: Please ensure you've completed all of the following. | 13 | description: Please ensure you've completed all of the following. |
15 | options: | 14 | options: |
16 | - label: I have read the [Contributing Guidelines](https://github.com/ferdium/ferdium-app/blob/develop/CONTRIBUTING.md) for this project. | 15 | - label: I have read the [Contributing Guidelines](https://github.com/ferdium/ferdium-app/blob/HEAD/CONTRIBUTING.md) for this project. |
17 | required: true | 16 | required: true |
18 | - label: I agree to follow the [Code of Conduct](https://github.com/ferdium/ferdium-app/blob/develop/CODE_OF_CONDUCT.md) that this project adheres to. | 17 | - label: I agree to follow the [Code of Conduct](https://github.com/ferdium/ferdium-app/blob/HEAD/CODE_OF_CONDUCT.md) that this project adheres to. |
19 | required: true | 18 | required: true |
20 | - label: I have searched the [issue tracker](https://github.com/ferdium/ferdium-app/issues) for a feature request that matches the one I want to file, without success. | 19 | - label: I have searched the [issue tracker](https://github.com/ferdium/ferdium-app/issues?q=is%3Aopen+is%3Aissue+label%3A%22enhancement+%3Asparkles%3A%22) for a feature request that matches the one I want to file, without success. |
21 | required: true | 20 | required: true |
22 | - type: textarea | 21 | - type: textarea |
23 | attributes: | 22 | attributes: |
diff --git a/.github/ISSUE_TEMPLATE/recipe_bug_report.yml b/.github/ISSUE_TEMPLATE/recipe_bug_report.yml index 8e71af482..c02382866 100644 --- a/.github/ISSUE_TEMPLATE/recipe_bug_report.yml +++ b/.github/ISSUE_TEMPLATE/recipe_bug_report.yml | |||
@@ -5,20 +5,16 @@ body: | |||
5 | - type: markdown | 5 | - type: markdown |
6 | attributes: | 6 | attributes: |
7 | value: | | 7 | value: | |
8 | 1. Please remember that if you are logging a bug for some service that has *stopped working*, please log the bug [here](https://github.com/ferdium/ferdium-recipes/issues) | 8 | 1. Please fill our form below, this way we can analyse and fix the problem as fast as possible. |
9 | 2. If you are requesting support for a new service in Ferdium, please log it [here](https://github.com/ferdium/ferdium-recipes/issues/new/choose) | 9 | 2. If you are adding screenshots and/or videos, please do add it in English so that a wider group of people can understand and help with resolution. |
10 | 3. Please remember to read the [self-help documentation](https://github.com/ferdium/ferdium-app#troubleshooting-recipes-self-help) - in case it helps you unblock yourself for issues related to old recipes. | ||
11 | 4. Please fill our form below, this way we can analyse and fix the problem as fast as possible. | ||
12 | - type: checkboxes | 10 | - type: checkboxes |
13 | attributes: | 11 | attributes: |
14 | label: Preflight Checklist | 12 | label: Preflight Checklist |
15 | description: Please ensure you've completed all of the following. | 13 | description: Please ensure you've completed all of the following. |
16 | options: | 14 | options: |
17 | - label: I have read the [Contributing Guidelines](https://github.com/ferdium/ferdium-app/blob/develop/CONTRIBUTING.md) for this project. | 15 | - label: I agree to follow the [Code of Conduct](https://github.com/ferdium/ferdium-recipes/blob/HEAD/CODE_OF_CONDUCT.md) that Ferdium Recipes adheres to. |
18 | required: true | 16 | required: true |
19 | - label: I agree to follow the [Code of Conduct](https://github.com/ferdium/ferdium-recipes/blob/main/CODE_OF_CONDUCT.md) that this project adheres to. | 17 | - label: I have searched the [issue tracker](https://github.com/ferdium/ferdium-app/issues?q=is%3Aopen+is%3Aissue+label%3A%22recipe+%3Abookmark_tabs%3A%22+label%3A%22bug+%3Abeetle%3A%22+) for a bug report that matches the one I want to file, without success. |
20 | required: true | ||
21 | - label: I have searched the [issue tracker](https://github.com/ferdium/ferdium-recipes/issues) for a feature request that matches the one I want to file, without success. | ||
22 | required: true | 18 | required: true |
23 | - type: input | 19 | - type: input |
24 | attributes: | 20 | attributes: |
@@ -31,7 +27,7 @@ body: | |||
31 | attributes: | 27 | attributes: |
32 | label: Recipe Name | 28 | label: Recipe Name |
33 | description: What is the name of the specific recipe you are using? | 29 | description: What is the name of the specific recipe you are using? |
34 | placeholder: 1.0.0 | 30 | placeholder: WhatsApp |
35 | validations: | 31 | validations: |
36 | required: true | 32 | required: true |
37 | - type: input | 33 | - type: input |
diff --git a/.github/ISSUE_TEMPLATE/recipe_request.yml b/.github/ISSUE_TEMPLATE/recipe_request.yml index 9380fff29..e87a62c63 100644 --- a/.github/ISSUE_TEMPLATE/recipe_request.yml +++ b/.github/ISSUE_TEMPLATE/recipe_request.yml | |||
@@ -5,27 +5,23 @@ body: | |||
5 | - type: markdown | 5 | - type: markdown |
6 | attributes: | 6 | attributes: |
7 | value: | | 7 | value: | |
8 | Before creating a new recipe request please check if you can add it yourself. | 8 | Before creating a new recipe request, please check if you can add it yourself. |
9 | If you add a recipe yourself it will be added faster than having to go through other contributors to do this job for you. | 9 | If you add a recipe yourself it will be added faster than having to go through other contributors to do this job for you. |
10 | 10 | ||
11 | As a first option to adding a service we recommend you search if someone already created such a recipe. For this, please search for your service name plus "Franz" on Github (e.g "WhatsApp Franz"), optionally you can also add "recipe" to the search query (e.g. "WhatsApp Franz recipe"). If you find a recipe (e.g. https://github.com/meetfranz/recipe-whatsapp), please check that its license allows us to add it to the repository. For this, open the "package.json" file of the project and look at the specified license. In most cases this will be '"license": "MIT"': The MIT License allows us to add the recipe! Please also check that the recipe is working (e.g. by adding it as a dev recipe to your Ferdium installation or looking if there are existing issues on the repository) and that it contains your desired features (e.g. look at the README). Another good indicator for if the recipe supports notifications is if there is code inside the "webview.js" file. | 11 | As a first option to adding a service we recommend you search if someone already created such a recipe. For this, please search for your service name plus "Ferdium" or "Ferdi" on Github (e.g "WhatsApp Ferdium"), optionally you can also add "recipe" to the search query (e.g. "WhatsApp Ferdium recipe"). |
12 | After finding a recipe you can let our fetch script add it to the repository for you. For this, please fork this repository on GitHub and follow the instructions on https://github.com/ferdium/ferdium-recipes#importing-recipes-from-github. After adding the recipe, please create a PR back to this repository. | 12 | If you find a recipe (e.g. https://github.com/meetfranz/recipe-whatsapp), please check that its license allows us to add it to the repository. For this, open the `package.json`` file of the project and look at the specified license. In most cases this will be `"license": "MIT"``: The MIT License allows us to add the recipe! Please also check that the recipe is working (e.g. by adding it as a dev recipe to your Ferdium installation or looking if there are existing issues on the repository) and that it contains your desired features (e.g. look at the README). Another good indicator for if the recipe supports notifications is if there is code inside the `webview.js`` file. |
13 | 13 | ||
14 | If there is no repository on GitHub you can also create one yourself - this often only takes 10-20 minutes and makes it much more likely that your service will get added! To create a recipe please look at this guide from Franz: https://github.com/meetfranz/plugins/blob/master/docs/integration.md. | 14 | If there is no existing recipe, you can also create one yourself - this often only takes 10-20 minutes and makes it much more likely that your service will get added! To create a recipe please look at [our guide](https://github.com/ferdium/ferdium-recipes/blob/main/docs/integration.md). |
15 | 15 | ||
16 | IF YOU ARE NOT FAMILIAR WITH JAVASCRIPT: Please still search for a recipe using the guide above and add it to your request. | 16 | IF YOU ARE NOT FAMILIAR WITH JAVASCRIPT: Please still search for a recipe using the guide above and add it to your request. |
17 | |||
18 | 1. Please remember to read the [self-help documentation](https://github.com/ferdium/ferdium-app#troubleshooting-recipes-self-help) - in case it helps you unblock yourself for issues related to old recipes. | ||
19 | - type: checkboxes | 17 | - type: checkboxes |
20 | attributes: | 18 | attributes: |
21 | label: Preflight Checklist | 19 | label: Preflight Checklist |
22 | description: Please ensure you've completed all of the following. | 20 | description: Please ensure you've completed all of the following. |
23 | options: | 21 | options: |
24 | - label: I have read the [Contributing Guidelines](https://github.com/ferdium/ferdium-recipes/blob/develop/CONTRIBUTING.md) for Ferdium Recipes. | 22 | - label: I agree to follow the [Code of Conduct](https://github.com/ferdium/ferdium-recipes/blob/HEAD/CODE_OF_CONDUCT.md) that Ferdium Recipes adheres to. |
25 | required: true | ||
26 | - label: I agree to follow the [Code of Conduct](https://github.com/ferdium/ferdium-recipes/blob/develop/CODE_OF_CONDUCT.md) that Ferdium Recipes adheres to. | ||
27 | required: true | 23 | required: true |
28 | - label: I have searched the [issue tracker](https://github.com/ferdium/ferdium-app/issues) for a recipes request that matches the one I want to file, without success. | 24 | - label: I have searched the [issue tracker](https://github.com/ferdium/ferdium-app/issues?q=is%3Aopen+is%3Aissue+label%3A%22recipe+request+%3Asparkles%3A%22) for a recipe request that matches the one I want to file, without success. |
29 | required: true | 25 | required: true |
30 | - type: input | 26 | - type: input |
31 | attributes: | 27 | attributes: |
diff --git a/.github/ISSUE_TEMPLATE/something_else_open_issue.yml b/.github/ISSUE_TEMPLATE/something_else_open_issue.yml index 4c8296f90..4951f41cc 100644 --- a/.github/ISSUE_TEMPLATE/something_else_open_issue.yml +++ b/.github/ISSUE_TEMPLATE/something_else_open_issue.yml | |||
@@ -6,8 +6,7 @@ body: | |||
6 | value: | | 6 | value: | |
7 | 1. Please remember that if you are logging a bug for some service that has *stopped working*, please log the bug [here](https://github.com/ferdium/ferdium-app/issues) by selecting the related issue category | 7 | 1. Please remember that if you are logging a bug for some service that has *stopped working*, please log the bug [here](https://github.com/ferdium/ferdium-app/issues) by selecting the related issue category |
8 | 2. If you are requesting support for a new service in Ferdium, please log it [here](https://github.com/ferdium/ferdium-app/issues) by selecting the related issue category | 8 | 2. If you are requesting support for a new service in Ferdium, please log it [here](https://github.com/ferdium/ferdium-app/issues) by selecting the related issue category |
9 | 3. Please remember to read the [self-help documentation](https://github.com/ferdium/ferdium-app#troubleshooting-recipes-self-help) - in case it helps you unblock yourself for issues related to old recipes. | 9 | 3. If you are adding screenshots and/or videos, please do add it in English so that a wider group of people can understand and help with resolution. |
10 | 4. If you are adding screenshots and/or videos, please do add it in English so that a wider group of people can understand and help with resolution. | ||
11 | - type: textarea | 10 | - type: textarea |
12 | attributes: | 11 | attributes: |
13 | label: "Your issue" | 12 | label: "Your issue" |