-
Notifications
You must be signed in to change notification settings - Fork 62.1k
About discussions edits #38880
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
About discussions edits #38880
Changes from all commits
b168597
f7f8ede
6828447
33f29ea
b469982
8ba7804
3b6bd2e
69f2d52
bbcdc2a
8b62ed3
20dc743
247abb7
cb24b23
3f9a897
ca60c4b
e476e36
35aa205
67c614c
d951e3b
2fb11ca
31b7577
6afd86d
7ceb7cb
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -10,61 +10,45 @@ | |||||
|
||||||
## About {% data variables.product.prodname_discussions %} | ||||||
|
||||||
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. | ||||||
With {% data variables.product.prodname_discussions %}, the community for your project can create and participate in conversations within a repository or organization. Maintainers, contributors, and visitors can gather in a central location, without third-party tools. | ||||||
|
||||||
* Share announcements and information, gather feedback, plan, and make decisions | ||||||
* Ask questions, discuss and answer the questions, and mark the discussions as answered | ||||||
* Create polls to gauge community opinion | ||||||
* Share announcements and information | ||||||
* Plan and make decisions with community input | ||||||
* Encourage and answer questions, and mark them answered as you respond to them | ||||||
* Gauge community opinion using polls | ||||||
* Upvote discussions and comments to give higher visibility to ideas you find valuable | ||||||
* Foster an inviting atmosphere for visitors and contributors to discuss goals, development, administration, and workflows | ||||||
Comment on lines
19
to
20
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think these last two list items may not belong. Correct me if I'm wrong, but to me this is intended to be a list of real-list tasks you can accomplish using Discussions (share information, get community input, answer questions, etc). These last two items feel more like qualities of Discussions that help you accomplish all the tasks in the list, but are not tasks themselves. I'd remove the "Upvote discussions..." item entirely (I feel like that's just a given for this type of functionality, nothing to brag about), and we could move the "Foster an inviting atmosphere..." to the paragraph above. Something like this:
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. You're right. I don't feel confident right now deciding the finer details of what should and shouldn't be included, so I think I erred on the side of including things that were in the article. Happy to cut more, though. 👍 |
||||||
|
||||||
 | ||||||
|
||||||
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. | ||||||
You can use **repository** discussions to discuss topics that are specific to one repository and **organization** discussions for broader conversations that spans multiple repositories. | ||||||
|
||||||
{% data reusables.discussions.closing-discussions %} For more information, see [Closing a discussion](/discussions/managing-discussions-for-your-community/managing-discussions#closing-a-discussion). | ||||||
Anyone who can has access to a repository can create and participate in discussions once a repository administrator or project maintainer has enabled {% data variables.product.prodname_discussions %}. Similarly, 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. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think details about exactly who can create discussions and when are outside the scope of this article as they're more "how to use Discussions" than "why." But I do think it could make sense to convey the general concepts that (a) Discussions can be enabled/disabled by maintainers and (b) when enabled, anyone who can see a repo/org can create and participate in a discussion there. I think we can probably just rephrase the paragraph to accomplish that in a more conceptual way... something along these lines:
Suggested change
|
||||||
|
||||||
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. | ||||||
## Organizing discussions | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I question whether organization is an important enough topic for an entire section, at least for the goal of helping folks understand the value of Discussions and whether they should use it. I think it's likely that a single sentence or paragraph about how you can organize discussions using categories and labels is enough for this article. Could we include that in the "Managing discussions" section? |
||||||
|
||||||
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). | ||||||
{% data variables.product.prodname_discussions %} offers you varying levels of granularity for organizing discussions: | ||||||
|
||||||
For more information about management of discussions, see [AUTOTITLE](/discussions/managing-discussions-for-your-community/managing-discussions). | ||||||
* Discussions are opened in categories defined by anyone with maintain or admin permissions | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Small point, but both this list and the one below are full sentences and the items should therefore each end in a period. 😄 |
||||||
* Categories come with different formats, such as announcements, question-and-answer, polls, or open-ended | ||||||
* Categories can be further organized under sections you create | ||||||
* Individual discussions can be categorized with more specificity by applying labels | ||||||
|
||||||
## About polls | ||||||
|
||||||
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 %} | ||||||
|
||||||
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. | ||||||
|
||||||
Voters cannot change their vote. Editing a poll will reset any votes that have already been cast. | ||||||
For more information about managing categories, see [AUTOTITLE](/discussions/managing-discussions-for-your-community/managing-categories-for-discussions). | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think we can remove both of these links, or at least the second one. |
||||||
|
||||||
For more information on creating polls, see [AUTOTITLE](/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion#creating-a-poll). | ||||||
|
||||||
## About discussion organization | ||||||
|
||||||
You can organize discussions with categories, sections, and labels. | ||||||
|
||||||
{% data reusables.discussions.you-can-categorize-discussions %} {% data reusables.discussions.about-categories-and-formats %} {% data reusables.discussions.repository-category-limit %} | ||||||
|
||||||
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 %} | ||||||
|
||||||
{% data reusables.discussions.about-announcement-format %} | ||||||
|
||||||
{% data reusables.discussions.category-sections %} | ||||||
|
||||||
For more information, see [AUTOTITLE](/discussions/managing-discussions-for-your-community/managing-categories-for-discussions). | ||||||
|
||||||
{% data reusables.discussions.you-can-label-discussions %} | ||||||
|
||||||
## Best practices for {% data variables.product.prodname_discussions %} | ||||||
|
||||||
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). | ||||||
## Managing discussions | ||||||
|
||||||
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). | ||||||
In addition to sorting discussions by category, section, and label, {% data variables.product.prodname_discussions %} includes other tools for managing discussions, and using discussions to manage the repository or organization. | ||||||
|
||||||
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). | ||||||
* Discussions can be pinned to give topics more visibility | ||||||
* Comments can be marked as answers in question-and-answer categories to help readers find the most useful response quickly | ||||||
* If a discussion has reached a conclusion or gotten too heated, it can be locked | ||||||
* Issues that turn out to be too open-ended can be converted to a discussion | ||||||
* Moderators can close discussions that are no longer useful | ||||||
|
||||||
{% 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). | ||||||
For more information about discussion management, see [AUTOTITLE](/discussions/managing-discussions-for-your-community/managing-discussions). | ||||||
|
||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. You haven't made any updates to the "Further reading" section, but just wanted to mention that our approach to links has increasingly been to limit them to only those that are critical to the main purpose of the article. As you identified in the OP, the goal is something like "understand what Discussions is and why I should use it," and I'd argue that none of the articles in "Further reading" are closely enough related to that goal to be included. I'd consider removing the whole section and instead adding a "Next steps" section where we send folks to the one article that makes the most sense... in this case, probably the most logical destination after deciding that Discussions is right for you would be the quickstart, so you can start using it. |
||||||
## Sharing feedback | ||||||
|
||||||
|
This file was deleted.
This file was deleted.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd consider updating the intro above as well, to better summarize the purpose of the article. I like an intro to answer the question "What will I gain by reading this article?", providing the information a user needs to determine whether they should open the article, rather than serving as a TLDR of the content. In this case, something like "Learn how discussions can help you communicate with your community."