-
Notifications
You must be signed in to change notification settings - Fork 59
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
GitHub Discussions for questions and translations (#1572)
### What kind of change does this PR introduce? * Migrates the Question/Support Issue Template to a GitHub Discussion Template * Adds a new page for coordinating translation efforts * Added a link to PAVICS for PAVICS-specific questions. Once we have a `Discourse` up and running, we'll be able to funnel all PAVICS-specific question there. ### Does this PR introduce a breaking change? Not really. This makes it so that the following can happen more easily: - Answered support requests will more easily be found by users with similar usage questions. This will make it simpler for users as `answering` a discussion post does not hide the post like `closing` an issue does. - Translation efforts can now more easily be coordinated outside of Pull Requests for users wishing to contribute translations in languages other than English or French. In a previous attempt, the major translation effort was performed in a Pull Request with 100+ comments in it and was impossible to navigate near the end. I've noticed similar translation efforts (using GitHub Discussions) organized in other projects, such as `FastAPI` (https://github.com/tiangolo/fastapi/discussions/categories/translations). ### Other information: https://docs.github.com/en/discussions/managing-discussions-for-your-community/creating-discussion-category-forms
- Loading branch information
Showing
9 changed files
with
146 additions
and
94 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
name: "[Questions] Questions and/or support" | ||
description: Ask for help from the developers | ||
labels: [ "support" ] | ||
|
||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thanks for opening this discussion! | ||
Before you submit, please make sure you have read our [Code of Conduct](https://github.com/Ouranosinc/xclim/blob/master/CODE_OF_CONDUCT.md). | ||
- type: textarea | ||
id: setup-information | ||
attributes: | ||
label: Setup Information | ||
description: | | ||
What xclim version are you running? | ||
value: | | ||
* Xclim version: | ||
- type: textarea | ||
id: description | ||
attributes: | ||
label: Context | ||
description: Describe what you were trying to get done. Tell us what happened, what went wrong, and what you expected to happen. | ||
- type: textarea | ||
id: steps-to-reproduce | ||
attributes: | ||
label: Steps To Reproduce | ||
description: Paste the command(s) you ran and the output. If there was a crash, please include the traceback below. | ||
value: | | ||
``` | ||
$ pip install foo --bar | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
name: "[Translations] Translation request/coordination" | ||
description: Coordinate translations of the Xclim documentation | ||
labels: [ "docs" ] | ||
|
||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thanks for taking the time to help translate Xclim's documentation! | ||
Before you submit, please make sure you have read our [Code of Conduct](https://github.com/Ouranosinc/xclim/blob/master/CODE_OF_CONDUCT.md). | ||
- type: textarea | ||
id: language | ||
attributes: | ||
label: Language | ||
description: What language are you translating to? | ||
- type: textarea | ||
id: translation | ||
attributes: | ||
label: Translation | ||
description: | | ||
Please paste your translation here. | ||
If you are translating a file, please paste the file contents here. | ||
Remember that you can use Markdown formatting in this text box. | ||
value: | | ||
<!-- If translating Indicators, consider the following approach: | ||
1. Copy the structure of `fr.json` from the `xclim/data` directory for the Indicators you wish to translate. | ||
2. Translate the fields to the language of your choice. | ||
3. Paste the translated docstrings below. | ||
4. Edit this post as needed, reflecting comments and suggestions from the maintainers and other contributors. | ||
5. When the translation effort feels concluded, submit a Pull Request with your changes. | ||
Please paste your translation below. --> |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,11 @@ | ||
blank_issues_enabled: true | ||
contact_links: | ||
- name: Questions and/or support | ||
about: "For questions or support, please use the Discussions tab" | ||
url: https://www.github.com/Ouranosinc/xclim/discussions/categories/questions | ||
- name: Translation requests | ||
about: "For coordinating translation requests, please use the Discussions tab" | ||
url: https://www.github.com/Ouranosinc/xclim/discussions/categories/translations | ||
- name: PAVICS-related questions | ||
about: "For questions related to PAVICS, the Platform for the Analysis and Visualization of Climate Science, please use the PAVICS email: [email protected]" | ||
url: https://pavics.ouranos.ca/index.html |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.