Templates (like issue templates) for discussions #2838
-
|
2023-01-23 Edit: This feature is now supported and released! 🎉 Read the blog post by GitHub: https://github.blog/2023-01-09-github-discussions-just-got-better-with-category-forms/ Read the docs: https://docs.github.com/en/discussions/managing-discussions-for-your-community/creating-discussion-category-forms There's an example in the docs here: https://docs.github.com/en/discussions/managing-discussions-for-your-community/syntax-for-discussion-category-forms ...but as of now, the YAML syntax in that example in the docs is broken. Here's that same official example with the syntax fixed: title: "[General] "
labels: ["General Introduction"]
body:
- type: markdown
attributes:
value: |
This is text that will show up in the template!
- type: textarea
id: improvements
attributes:
label: Top 3 improvements
description: "What are the top 3 improvements we could make to this project?"
value: |
1.
2.
3.
...
render: bash
validations:
required: true
- type: markdown
attributes:
value: |
## Markdown header
And some more markdown
- type: input
id: has-id
attributes:
label: Suggestions
description: A description about suggestions to help you
validations:
required: true
- type: dropdown
id: download
attributes:
label: Which area of this project could be most improved?
options:
- Documentation
- Pull request review time
- Bug fix time
- Release cadence
validations:
required: true
- type: checkboxes
attributes:
label: Check that box!
options:
- label: This one!
required: true
- label: I won't stop you if you check this one, too
- type: markdown
attributes:
value: |
### The thrilling conclusion
_to our template_Hey! 👋 I really like the idea of discussions. I have been working around not having them with issues marked as questions and some tricks. Most of the issues I have are actually questions, and that's what ends up consuming most of the time. Now that I have discussions available in https://github.com/tiangolo/fastapi, I see that there's no way to set up templates for a new discussion. Having templates for issues has helped a lot in handling questions, as it helps encourage users to think through the problem and provide a replicable example of what they want to achieve and what is not working. Before that, the repo was filling with cryptic issues saying only "it's not working!" and similar. It would be awesome to be able to have templates for the questions in discussions. |
Beta Was this translation helpful? Give feedback.
Replies: 24 comments 57 replies
-
|
I'd also find this useful - for example, separate templates for 'help request' and 'RFC' |
Beta Was this translation helpful? Give feedback.
-
|
came to suggest the very same thing. like template verbiage on questions advising to search for answers already existing in the repo or ways to structure the inquiry +1 |
Beta Was this translation helpful? Give feedback.
-
|
Just started using Discussions and I already love it, but having template would be an additional helpful thing to keep many things structured. In my case I develop a library for different platforms (.net desktop, javascript,..) and for the Q&A section multiple things are relevant like this platform and version of the library they use. Just like it is also relevant for a bug report (issue with template) it might be also relevant to answer a question correctly. |
Beta Was this translation helpful? Give feedback.
-
|
We just enabled Discussions for Thanos and want to move feature requests from issues to discussions. We have a pretty nice template for feature requests and it'd be a shame to not also use it for discussions. |
Beta Was this translation helpful? Give feedback.
-
|
Hi all, thanks for all the feedback here! Category templates for Discussions is on our roadmap, so stay tuned and I'll update here once the feature is available. |
Beta Was this translation helpful? Give feedback.
-
|
@evi-liu @natalierjackson same here please! For both https://github.com/withfig/autocomplete and https://github.com/withfig/fig! |
Beta Was this translation helpful? Give feedback.
-
|
Hi all, just following up on Evi's answer here. I've taken over from her on GitHub Discussions, and we recently released Category Forms, which is what we've called this templating feature. Read about it here! https://github.blog/2023-01-09-github-discussions-just-got-better-with-category-forms/ |
Beta Was this translation helpful? Give feedback.
-
|
@abhinavvadrevu Hi! Sorry I couldn't find anything in the documentation; isn't there any way to include polls in templates for discussions with the 'poll' format? Also, when you convert an issue to a poll discussion, you can't add a poll to it afterwards; when clicking on the edit button, the poll configuration area that should appear under the text box just doesn't show up: |
Beta Was this translation helpful? Give feedback.
-
|
Was this ever added? |
Beta Was this translation helpful? Give feedback.
-
|
Sort of... |
Beta Was this translation helpful? Give feedback.
-
|
Very much would like to see this feature added. We have templates for different types of discussions and would like copy-and-paste to not be the state of the art. |
Beta Was this translation helpful? Give feedback.
-
|
We use discussions to capture the Agenda for weekly meetings. It would be great to have a discussion template for each type of discussion. That way when someone wants to start a new Agenda for the next meeting all the routine info can be prepopulated. This would be especially helpful for bringing new members into the weekly meeting so that each meeting has the expectations laid out. |
Beta Was this translation helpful? Give feedback.
-
|
We see the same. It's a recurring thing that we have to ask for more information. I think the current placeholder " |
Beta Was this translation helpful? Give feedback.
-
|
Hi all! Guys I had the same idea! reference: #16684 1. My idea2. Notes
|
Beta Was this translation helpful? Give feedback.
-
|
I'm glad to have seen this discussion and am glad to see the official response. But what surprises me is that this was raised almost two years ago and confirmed to be in the roadmap. Any updates? Please let us know! |
Beta Was this translation helpful? Give feedback.
-
|
Hi @evi-liu, At meilisearch, we decided to manage product feedback with Github Discussions. I would like to propose a template for our community members to express their pain points; a template would help them to express their feedback qualitatively from the beginning of the discussion. I look forward to seeing this feature. I would be super valuable 🙏 Thanks! |
Beta Was this translation helpful? Give feedback.
-
|
Same here! We would love having templates for discussions! |
Beta Was this translation helpful? Give feedback.
-
|
@evi-liu |
Beta Was this translation helpful? Give feedback.
-
|
The GitHub Discussions documentation mentions editing a template and I thought this was a template file for discussions, but instead it's editing the announcement template for the original post. Might be worth updating that documentation to be less confusing, though I might be the only dumby misinterpreting it. |
Beta Was this translation helpful? Give feedback.
-
|
For anyone coming across this page, it's probably worth mentioning that the
Just URL encode whatever you want in |
Beta Was this translation helpful? Give feedback.
-
|
Sorry for the spam but I emailed GitHub support on 16 November they said a public beta should be available "in a matter of weeks". This was two weeks ago so seems like it should be released this week or next :) |
Beta Was this translation helpful? Give feedback.
-
|
Wonderful! |
Beta Was this translation helpful? Give feedback.
-
|
Nice thing is that this is available according to the docs, but configuring them does not work? I can't find the blog post with the announcement for it. I've configured them in two different repos for testing (both public), but the template is not used. Example repo: link. |
Beta Was this translation helpful? Give feedback.
-
|
It's probably the same as with most new features: You need to get your repository/user/org added to an alpha/beta to use it. |
Beta Was this translation helpful? Give feedback.
-
|
Darn it! That is indeed written in the top of the docs here: |
Beta Was this translation helpful? Give feedback.
-
Any idea how to join the feature alpha/beta. |
Beta Was this translation helpful? Give feedback.
-
|
Looking forward to this feature becoming available! |
Beta Was this translation helpful? Give feedback.
-
Beta Was this translation helpful? Give feedback.
-
|
Discussion category forms has been beta-released |
Beta Was this translation helpful? Give feedback.
-
|
thank you! what is limited public beta? how can I join? |
Beta Was this translation helpful? Give feedback.
-
You're welcome ❤️
I also don't know what are their exact definition about that, but here are my thoughts:
I don't know, I personnaly already have access to it. |
Beta Was this translation helpful? Give feedback.
-
|
We also have Github Enterprise, I will give it a try in that case. |
Beta Was this translation helpful? Give feedback.
-
|
@alexef : Beta features are seldomly available on GHES, so in this case it will not work (same for Issue Forms). |
Beta Was this translation helpful? Give feedback.
-
|
When can we expect to use this? We would be happy to use this for http://github.com/squidfunk/mkdocs-material! |
Beta Was this translation helpful? Give feedback.
-
|
Update: this has just been released! https://github.blog/2023-01-09-github-discussions-just-got-better-with-category-forms |
Beta Was this translation helpful? Give feedback.
-
|
Yup, https://github.com/orgs/community/discussions/2838#discussioncomment-4601674 |
Beta Was this translation helpful? Give feedback.
-
|
great proposal! |
Beta Was this translation helpful? Give feedback.
-
|
As I can see in the documentation and in this discussion, a discussion template can only be created with a YAML file. |
Beta Was this translation helpful? Give feedback.
-
|
Is there a way to set up Discussion templates, not forms, like we can do with Issues? Use-case: imagine a discussion category called "Design Docs" where most of the documents follow a 6 sections structure but some documents need additional sections. If the person creating the discussion had a template instead of a form, they could easily adapt the template to each particular case, but with forms we are limited to hacks. Design docs are also long-form and a form's textareas are just too small and hard to edit. |
Beta Was this translation helpful? Give feedback.
-
|
You can set them up per category, so I think your use case is possible indeed. |
Beta Was this translation helpful? Give feedback.
-
|
Thanks, but how do I do that? I can't find that option anywhere... |
Beta Was this translation helpful? Give feedback.
-
|
It's described here: create a YAML file with the same name as the category you want to use it for. |
Beta Was this translation helpful? Give feedback.
-
|
Thank you |
Beta Was this translation helpful? Give feedback.
-
|
I'm glad GitHub added this. But is there a way to just provide one template to be used for all categories? I want to have my users always fill certain things in, regardless of what category they choose. As it is, I have to duplicate the same form yaml file several times. Actually, ideally, I could just write the yaml form once, then specify which categories it applies to at the top of the yaml like |
Beta Was this translation helpful? Give feedback.
Hi all, thanks for all the feedback here! Category templates for Discussions is on our roadmap, so stay tuned and I'll update here once the feature is available.