Skip to content

Commit

Permalink
add documentation on moderation
Browse files Browse the repository at this point in the history
Signed-off-by: Vu Van Dung <joulev.vvd@yahoo.com>
  • Loading branch information
joulev committed Jul 30, 2022
1 parent a6d7770 commit 3b24545
Show file tree
Hide file tree
Showing 6 changed files with 89 additions and 0 deletions.
39 changes: 39 additions & 0 deletions docs/moderation/approve-and-delete-comments.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Approve and delete comments

## Approve comments

Pages with auto-approval enabled (default behaviour) will have all comments automatically approved for you, so this section is not applicable. [Learn more about auto-approval](/docs/moderation/introduction#approving-comments) and [update the configuration](/docs/moderation/auto-approval-configuration) if you would like to.

If the page has auto-approval disabled, follow these steps to approve a comment.

- Visit the page dashboard.

- Under **Pending comments**, if you see the following text

> This page has auto-approval turned on, hence all new comments are automatically approved. Go to settings to configure this.
that means all comments have been automatically approved for you. No action is required in your part.

- Otherwise, the section should contain all comments waiting to be verified. If there are not any, for testing purposes you can visit the comment section (with the link from **Your comment section is live!**) and post a test comment.

- For each of these pending comments, read it. If you want to approve it, click on the purple tick button at the top-right.

![A pending comment](/images/docs/moderation/approve-and-delete-comments/approve-pending-comments.png)

- The comment is then approved and you can see it visible in both the comment section and the **Approved comments** section in the page dashboard.

## Delete comments

Any comment can be deleted at any time regardless of whether it has been approved or not. Do note that comment deletions are irreversible and deleted comments are forever lost, therefore please think twice before deleting anything. Also make sure you do not delete wrong comments by mistake.

To delete a comment, follow these steps.

- Visit the page dashboard.

- Under either **Pending comments** or **Approved comments**, find the offending comment you would like to remove.

- Click on the "X" button at the top-right.

- If this is the first time you are deleting a comment in that session, there will be a warning modal. If you still want to delete the comment, click **Delete**. Note that this modal will be silenced for the rest of the session.

- The comment is now deleted and removed from everywhere.
15 changes: 15 additions & 0 deletions docs/moderation/auto-approval-configuration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Auto-approval configuration

This configuration dictates whether a new comment would be automatically approved and visible to the public immediately, or it requires manual approval from you as the page administrator ([see more](/docs/moderation/introduction)).

You can update the auto-approval configuration at any time for any ezkomment pages you have. To do so, follow these steps:

- Visit the page dashboard of the page whose configuration you want to update.

- On the navigation bar, click on **Settings** to go to the page settings.

- Under **Automatic approval**, use the switch on the right to set the configuration.

![Automatic approval section under page settings](/images/docs/moderation/auto-approval-configuration/auto-approval-settings.png)

Note that, with auto-approval disabled, when a user inputs a new comment, it will _not_ be shown automatically. This may cause confusion, therefore we recommend updating the help text in the comment section (see [Customisation](https://google.com)) to clarify this.
27 changes: 27 additions & 0 deletions docs/moderation/introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Moderation

In several occasions, you would want to have some control over comments in your website. Whether that is for removing profanity, hate speech, abuse or any other reasons, being able to dictate whether a comment is visible to the public is something you would probably need sometimes. ezkomment does support that, and it is called the moderation feature.

## Approving comments

When a new comment arrives, whether or not it is immediately visible to the public depends on the _auto-approval configuration_ in which the ezkomment page operates:

- Auto-approval _enabled_ (default): All coming comments are automatically approved and made visible to everyone viewing the comment section. Therefore, when a commenter makes a comment, it will automatically be reflected everywhere.

- Auto-approval _disabled_: All coming comments are marked as "pending". You, as the page admin, have to go to the ezkomment page dashboard to read and approve those comments manually, one-by-one. Only after being approved would the comments be visible to everyone visiting your page. You may also choose to [delete any comments](#deleting-comments) if you want to.

With auto-approval disabled, when a user inputs a new comment, it will _not_ be shown automatically. This may cause confusion, therefore we recommend updating the help text in the comment section (see [Customisation](https://google.com)) to clarify this.

You can [approve comments](/docs/moderation/approve-and-delete-comments#approve-comments) in the page dashboard and [update the auto-approval configuration](/docs/moderation/auto-approval-configuration) in the page settings.

## Deleting comments

You as page admin can always delete any comments you consider inappropriate, regardless of whether it has been approved or not.

**This is dangerous!**

Deleted comments are, well, deleted: your visitor cannot see them anymore. In fact, in accordance with our no-permanent-data policy, we will also completely delete it from all of our databases. In other words, comment deletions are **irreversible**: you cannot get a comment back once it has been removed.

As usual, throughout the whole ezkomment application, please think twice before deleting anything.

You can [delete comments](/docs/moderation/approve-and-delete-comments#delete-comments) in the page dashboard.
8 changes: 8 additions & 0 deletions docs/nav.json5
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,12 @@
embed: "Embed the comment section",
},
},
moderation: {
sectionTitle: "Moderation",
pages: {
introduction: "Moderation",
"auto-approval-configuration": "Auto-approval configuration",
"approve-and-delete-comments": "Approve and delete comments",
},
},
}
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 3b24545

Please sign in to comment.