Skip to content

Commit afa2537

Browse files
Sharra-writeslecoursenjc-clarksabrowning1
authored
About discussions edits (#38880)
Co-authored-by: Laura Coursen <lecoursen@github.com> Co-authored-by: Joe Clark <31087804+jc-clark@users.noreply.github.com> Co-authored-by: Sam Browning <106113886+sabrowning1@users.noreply.github.com>
1 parent e34c74e commit afa2537

File tree

10 files changed

+22
-63
lines changed

10 files changed

+22
-63
lines changed

content/discussions/collaborating-with-your-community-using-discussions/about-discussions.md

Lines changed: 17 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -10,70 +10,35 @@ versions:
1010

1111
## About {% data variables.product.prodname_discussions %}
1212

13-
With {% data variables.product.prodname_discussions %}, the community for your project can create and participate in conversations within the project's repository or organization. Discussions empower a project's maintainers, contributors, and visitors to gather and accomplish the following goals in a central location, without third-party tools.
13+
{% data variables.product.prodname_discussions %} allows your project's community to engage in conversations about the project's direction and future in an open-ended format. Maintainers, contributors, and visitors can gather in a central location, without third-party tools.
1414

15-
* Share announcements and information, gather feedback, plan, and make decisions
16-
* Ask questions, discuss and answer the questions, and mark the discussions as answered
17-
* Create polls to gauge community opinion
18-
* Upvote discussions and comments to give higher visibility to ideas you find valuable
19-
* Foster an inviting atmosphere for visitors and contributors to discuss goals, development, administration, and workflows
15+
* Share announcements and information
16+
* Plan and make decisions with community input
17+
* Encourage and answer questions, and mark them answered as you respond to them
18+
* Gauge community opinion using polls
2019

2120
![Screenshot of the "Discussions" page for a repository, showing a list of discussions such as "Feedback on the new layout" and "Project direction".](/assets/images/help/discussions/hero.png)
2221

23-
You might use repository discussions to discuss topics that are specific to the repository. If your project spans multiple repositories, you might use organization discussions to discuss topics that aren't specific to a single repository in your organization.
22+
You can use **repository** discussions to discuss topics that are specific to one repository and **organization** discussions for broader conversations that span multiple repositories.
2423

25-
{% data reusables.discussions.closing-discussions %} For more information, see [Closing a discussion](/discussions/managing-discussions-for-your-community/managing-discussions#closing-a-discussion).
24+
Anyone with access to a repository or organization can create and participate in discussions there. However, an administrator must enable {% data variables.product.prodname_discussions %} for the repository or organization first.
2625

27-
If a repository administrator or project maintainer enables {% data variables.product.prodname_discussions %} for a repository, anyone who has access to the repository can create and participate in discussions for the repository. If an organization owner enables {% data variables.product.prodname_discussions %} for an organization, anyone who can view the source repository can create an organization discussion.
26+
## Managing discussions
2827

29-
Repository administrators and project maintainers can manage discussions and discussion categories in a repository, and pin discussions to increase the visibility of the discussion. Moderators and collaborators can mark comments as answers, lock discussions, and convert issues to discussions. Similarly, for organization discussions, the role of a user in the source repository determines how a user can interact with organization discussions. For more information, see [AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization).
28+
{% data variables.product.prodname_discussions %} includes tools for managing discussions, and for using discussions to manage the repository or organization.
3029

31-
For more information about management of discussions, see [AUTOTITLE](/discussions/managing-discussions-for-your-community/managing-discussions).
30+
* Pin discussions to give topics more visibility
31+
* Mark comments as answers in question-and-answer categories to help users find information more quickly
32+
* Lock discussions that have reached a conclusion or become too heated
33+
* Convert open-ended issues into discussions
34+
* Close discussions that are no longer useful
3235

33-
## About polls
34-
35-
You can create polls in the polls category to gauge interest in new ideas and project direction. Anyone with read access to your repository can create polls, vote in polls, and view their results.{% ifversion fpt or ghec %} Signed out users can view the results of polls in public repositories.{% endif %}
36-
37-
Polls require a question and at least two options. You can add a maximum of eight options and the options can contain a maximum of 128 characters.
38-
39-
Voters cannot change their vote. Editing a poll will reset any votes that have already been cast.
40-
41-
For more information on creating polls, see [AUTOTITLE](/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion#creating-a-poll).
42-
43-
## About discussion organization
44-
45-
You can organize discussions with categories, sections, and labels.
46-
47-
{% data reusables.discussions.you-can-categorize-discussions %} {% data reusables.discussions.about-categories-and-formats %} {% data reusables.discussions.repository-category-limit %}
48-
49-
For discussions with a question/answer format, an individual comment within the discussion can be marked as the discussion's answer. {% data reusables.discussions.github-recognizes-members %}
50-
51-
{% data reusables.discussions.about-announcement-format %}
52-
53-
{% data reusables.discussions.category-sections %}
54-
55-
For more information, see [AUTOTITLE](/discussions/managing-discussions-for-your-community/managing-categories-for-discussions).
56-
57-
{% data reusables.discussions.you-can-label-discussions %}
58-
59-
## Best practices for {% data variables.product.prodname_discussions %}
60-
61-
As a community member or maintainer, start a discussion to ask a question or discuss information that affects the community. For more information, see [AUTOTITLE](/discussions/collaborating-with-your-community-using-discussions/collaborating-with-maintainers-using-discussions).
62-
63-
Participate in a discussion to ask and answer questions, provide feedback, and engage with the project's community. For more information, see [AUTOTITLE](/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion).
64-
65-
You can spotlight discussions that contain important, useful, or exemplary conversations among members in the community. For more information, see [AUTOTITLE](/discussions/managing-discussions-for-your-community/managing-discussions#pinning-a-discussion).
66-
67-
{% data reusables.discussions.you-can-convert-an-issue %} For more information, see [AUTOTITLE](/discussions/managing-discussions-for-your-community/moderating-discussions#converting-an-issue-to-a-discussion).
36+
Discussions are opened in user-defined categories, and can be further organized with repository labels. For more information about discussion management, see [AUTOTITLE](/discussions/managing-discussions-for-your-community/managing-discussions).
6837

6938
## Sharing feedback
7039

7140
You can share your feedback about {% data variables.product.prodname_discussions %} with {% data variables.product.company_short %}. To join the conversation, see [{% data variables.product.prodname_github_community %} discussions](https://github.com/orgs/community/discussions/categories/discussions).
7241

73-
## Further reading
42+
## Next steps
7443

75-
* [AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github)
76-
* [AUTOTITLE](/search-github/searching-on-github/searching-discussions)
77-
* [AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications)
78-
* [AUTOTITLE](/communities/moderating-comments-and-conversations){% ifversion fpt or ghec %}
79-
* [AUTOTITLE](/communities/maintaining-your-safety-on-github){% endif %}
44+
If you're ready to try {% data variables.product.prodname_discussions %}, get started at [AUTOTITLE](/discussions/quickstart).

content/discussions/collaborating-with-your-community-using-discussions/collaborating-with-maintainers-using-discussions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ versions:
1818

1919
Repository administrators and project maintainers can delete a discussion in that repository. Similarly, administrators and maintainers of the source repository for an organization's discussions can delete a discussion in that organization. For more information, see [AUTOTITLE](/discussions/managing-discussions-for-your-community/managing-discussions#deleting-a-discussion).
2020

21-
{% data reusables.discussions.github-recognizes-members %} {%- ifversion fpt %} These members appear in a list of the most helpful contributors to the project's discussions, if their privacy settings allow. For more information, see [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/setting-your-profile-to-private).{%- endif %}{%- ifversion ghes or ghec %} These members appear in a list of the most helpful contributors to the project's discussions.{%- endif %}
21+
{% data variables.product.prodname_dotcom %} will automatically recognize community members who contribute the most comments marked as answers to discussions with a question/answer format. {%- ifversion fpt %} These members appear in a list of the most helpful contributors to the project's discussions, if their privacy settings allow. For more information, see [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/setting-your-profile-to-private).{%- endif %}{%- ifversion ghes or ghec %} These members appear in a list of the most helpful contributors to the project's discussions.{%- endif %}
2222

2323
As your project grows, you can grant higher access permissions to active members of your community. For more information, see [AUTOTITLE](/discussions/guides/granting-higher-permissions-to-top-contributors).
2424

@@ -91,7 +91,7 @@ You can choose how to sort top-level comments in discussions. Comment threads do
9191

9292
## Converting an issue to a discussion
9393

94-
{% data reusables.discussions.you-can-convert-an-issue %} For more information, see [AUTOTITLE](/discussions/managing-discussions-for-your-community/moderating-discussions#converting-an-issue-to-a-discussion).
94+
If an issue turns out to be a question or open-ended conversation instead of a work item to track and prioritize, you can convert the issue to a discussion. For more information, see [AUTOTITLE](/discussions/managing-discussions-for-your-community/moderating-discussions#converting-an-issue-to-a-discussion).
9595

9696
## Further reading
9797

content/discussions/managing-discussions-for-your-community/managing-categories-for-discussions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ redirect_from:
1818

1919
{% data reusables.discussions.about-announcement-format %}
2020

21-
Each category must have a unique name and emoji pairing, and can be accompanied by a detailed description stating its purpose. Categories help maintainers organize how conversations are filed and are customizable to help distinguish categories that are Q&A or more open-ended conversations. {% data reusables.discussions.repository-category-limit %} For more information, see [AUTOTITLE](/discussions/collaborating-with-your-community-using-discussions/about-discussions#about-categories-and-formats-for-discussions).
21+
Each category must have a unique name and emoji pairing, and can be accompanied by a detailed description stating its purpose. Categories help maintainers organize how conversations are filed and are customizable to help distinguish categories that are Q&A or more open-ended conversations. Each repository or organization can have up to 25 categories. For more information, see [AUTOTITLE](/discussions/collaborating-with-your-community-using-discussions/about-discussions#about-categories-and-formats-for-discussions).
2222

23-
{% data reusables.discussions.category-sections %}
23+
To further organize your discussions, you can create sections and then nest your categories within a section.
2424

2525
## Default categories
2626

content/discussions/managing-discussions-for-your-community/managing-discussions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ To transfer a discussion, you must have permissions to create discussions in the
151151

152152
## Closing a discussion
153153

154-
{% data reusables.discussions.closing-discussions %}
154+
You can close a discussion when the discussion has been resolved, is no longer relevant, or is a duplicate.
155155

156156
{% data reusables.discussions.navigate-to-repo-or-org %}
157157
{% data reusables.discussions.discussions-tab %}

data/reusables/discussions/category-sections.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

data/reusables/discussions/closing-discussions.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

data/reusables/discussions/github-recognizes-members.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

data/reusables/discussions/repository-category-limit.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

data/reusables/discussions/you-can-categorize-discussions.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

data/reusables/discussions/you-can-convert-an-issue.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)