Skip to content
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

Managing disruptive comments is overly prescriptive #16446

Closed
1 task done
jsoref opened this issue Mar 22, 2022 · 5 comments · Fixed by #17280
Closed
1 task done

Managing disruptive comments is overly prescriptive #16446

jsoref opened this issue Mar 22, 2022 · 5 comments · Fixed by #17280
Labels
communities Content related to Communities content This issue or pull request belongs to the Docs Content team get started Content related to "Getting Started" doc set

Comments

@jsoref
Copy link
Contributor

jsoref commented Mar 22, 2022

Code of Conduct

What article on docs.github.com is affected?

https://github.com/github/docs/blob/main/content/communities/moderating-comments-and-conversations/managing-disruptive-comments.md

What part(s) of the article would you like to see updated?

This content:

When you edit a comment, note the location that the content was removed from and optionally, the reason for removing it.

... feels more like instructions for how a specific project should operate, as opposed to the world at large. If it's the world at large, then it should be integrated into the tooling.

This should really have its own anchor, for redacting information:

Comment authors and anyone with write access to a repository can also delete sensitive information from a comment's edit history. For more information, see "[Tracking changes in a comment](/communities/moderating-comments-and-conversations/tracking-changes-in-a-comment)."

3. In the comment window, delete the content you'd like to remove, then type `[REDACTED]` to replace it.
![Comment window with redacted content](/assets/images/help/issues/redacted-content-comment.png)

The content should also include a note that it's merely a suggestion.

If a comment contains some constructive content that adds to the conversation in the issue or pull request, you can edit the comment instead.

It's a bit late in the chronology to make this suggestion. I'd suggest it precede the information about deleting a comment (i.e. before Deleting a comment is your last resort as a moderator.). But, I want to be careful to not be too prescriptive (the current content suffers from this...).

There should be an anchor for the steps:

Additional information

Fwiw, while this information is interesting, it is definitely not complete.

I found this page because I was researching a behavior I noticed today which does not appear to be documented.

@jsoref jsoref added the content This issue or pull request belongs to the Docs Content team label Mar 22, 2022
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Mar 22, 2022
@ramyaparimi ramyaparimi added waiting for review Issue/PR is waiting for a writer's review communities Content related to Communities and removed triage Do not begin working on this issue until triaged by the team labels Mar 22, 2022
@ramyaparimi
Copy link
Contributor

@jsoref
Thanks so much for opening an issue! I'll triage this for the team to take a look 👀

@hubwriter
Copy link
Contributor

I've mentioned this in an internal channel to get some expert 👀 on these suggestions.

@ramyaparimi ramyaparimi added the needs SME This proposal needs review from a subject matter expert label Apr 21, 2022
@github-actions
Copy link
Contributor

Thanks for opening an issue! We've triaged this issue for technical review by a subject matter expert 👀

@hubwriter
Copy link
Contributor

Hi @jsoref - Thanks again for raising this issue. Apologies it's taken a while to get back to you about this.

I've now heard back from an SME who has taken a look at this issue. They've said that your suggestions seem potentially valid, but they'd like to have a pull request with docs changes to review.

If you could open a PR with your suggested changes to the docs that would be great. Please check out the contributing guidelines.

@hubwriter hubwriter added get started Content related to "Getting Started" doc set and removed waiting for review Issue/PR is waiting for a writer's review needs SME This proposal needs review from a subject matter expert labels Apr 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
communities Content related to Communities content This issue or pull request belongs to the Docs Content team get started Content related to "Getting Started" doc set
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants
@jsoref @ramyaparimi @hubwriter and others