Skip to content

docs: add moderation guide and fix its sidebar entry - #356

Open
rbowen wants to merge 1 commit into
apache:mainfrom
rbowen:rbowen-moderation
Open

rbowen wants to merge 1 commit into
apache:mainfrom
rbowen:rbowen-moderation

Conversation

@rbowen

@rbowen rbowen commented Nov 11, 2026

Copy link
Copy Markdown

The Moderation guide (docs/guides/moderation.md) contained only a TODO placeholder, and the "Moderation" entry in the sidebar was a category heading rather than a link to that page. The only item under it was Settings, which isn't a moderation topic.

This PR:

  1. Adds content to the Moderation guide, giving an overview of how moderation works in Answer:

    • How moderation is shared between the community (flagging and suggesting edits), trusted users (reviewing, based on reputation), and moderators/admins (final decisions)
    • Flagging content, including a table of the available flag reasons
    • The review process and the outcomes a reviewer can choose (looks OK, needs edit, needs close, needs delete)
    • Closing/reopening, deleting/undeleting, and unlisting questions and answers
    • Suspending and deleting users
    • Automated moderation with reviewer plugins
    • A few suggested practices for communities

    The page focuses only on moderation and links to the existing
    Flags, Review, Questions, Users, Permission, Reputation, and
    Using Plugins pages for related details, rather than duplicating
    their content.

  2. Updates sidebars.js so that:

    • "Moderation" links directly to the new page instead of being a category heading
    • "Settings" becomes its own entry under User Guides, instead of being nested under Moderation

The flag reasons, review outcomes, and other labels match the English UI strings in apache/answer (i18n/en_US.yaml), so the docs use the same wording users see in the interface.

No other pages were changed. Several related pages (Review, Flags, Tags, and parts of Users) are still placeholders or very brief. I'm happy to work on those in follow-up PRs.

The Moderation guide (docs/guides/moderation.md) contained only a
TODO placeholder, and the "Moderation" entry in the sidebar was a
category heading rather than a link to that page. The only item
under it was Settings, which isn't a moderation topic.

This PR:

1. Adds content to the Moderation guide, giving an overview of how
   moderation works in Answer:
   - How moderation is shared between the community (flagging and
     suggesting edits), trusted users (reviewing, based on
     reputation), and moderators/admins (final decisions)
   - Flagging content, including a table of the available flag
     reasons
   - The review process and the outcomes a reviewer can choose
     (looks OK, needs edit, needs close, needs delete)
   - Closing/reopening, deleting/undeleting, and unlisting questions
     and answers
   - Suspending and deleting users
   - Automated moderation with reviewer plugins
   - A few suggested practices for communities

   The page focuses only on moderation and links to the existing
   Flags, Review, Questions, Users, Permission, Reputation, and
   Using Plugins pages for related details, rather than duplicating
   their content.

2. Updates sidebars.js so that:
   - "Moderation" links directly to the new page instead of being a
     category heading
   - "Settings" becomes its own entry under User Guides, instead of
     being nested under Moderation

The flag reasons, review outcomes, and other labels match the
English UI strings in apache/answer (i18n/en_US.yaml), so the docs
use the same wording users see in the interface.

No other pages were changed. Several related pages (Review, Flags,
Tags, and parts of Users) are still placeholders or very brief.
I'm happy to work on those in follow-up PRs.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant