Skip to content

Managing disruptive comments is overly prescriptive #16446

Closed
@jsoref

Description

@jsoref

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    communitiesContent related to CommunitiescontentThis issue or pull request belongs to the Docs Content teamget startedContent related to "Getting Started" doc set

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions