Skip to content

Commit

Permalink
docs: replace black-/whitelist -> deny-/allowlist
Browse files Browse the repository at this point in the history
These terms are prone to cause confusion, especially to those unfamiliar
with the common jargon. Replace them.

Reference: botlabs-gg/yagpdb#1748 -- this commit is to be deployed when
the referenced PR is also deployed.

Signed-off-by: Luca Zeuch <[email protected]>
  • Loading branch information
l-zeuch committed Oct 31, 2024
1 parent ab81214 commit ce5e94b
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 25 deletions.
6 changes: 3 additions & 3 deletions content/docs/custom-commands/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,13 +78,13 @@ Selecting a group allows you to edit it. Changes must be saved (**11**) to take

Using role/channel restrictions, it is possible to set conditions on which users can trigger a custom command.

Specifically, whitelisted roles or channels are required to run the command, whereas blacklisted roles or channels
Specifically, allowlisted roles or channels are required to run the command, whereas denylisted roles or channels
cannot use the command at all. These role restrictions are unrelated to member permissions. Having `Administrator`
permissions will not override these restrictions.

{{< callout context="note" title="Note: Priority of Ignored vs. Required Roles" icon="outline/info-circle" >}}

YAGPDB was raised well and honors a "no" when told "no". In other words, blacklists take precedence over whitelists.
YAGPDB was raised well and honors a "no" when told "no". In other words, denylists take precedence over allowlists.

{{< /callout >}}

Expand Down Expand Up @@ -281,7 +281,7 @@ Group restrictions operate identically to [command-specific restrictions](#rolec
#### CC Groups

A user executing a command must obey both the overarching group's restrictions and the command restrictions.
Command-specific whitelists will _not_ override the group restrictions.
Command-specific allowlists will _not_ override the group restrictions.

### Execution Statistics

Expand Down
8 changes: 4 additions & 4 deletions content/docs/moderation/advanced-automoderator/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ to set it up.
Advanced automoderator operates on the basis of user-configurable rules, which trigger on specific actions and
conditions to produce certain effects. Collections of rules are referred to as rulesets.

Finally, there are lists you can create, which can be used to black- or whitelist words or domains.
Finally, there are lists you can create, which can be used to black- or allowlist words or domains.

## Overview

Expand All @@ -28,7 +28,7 @@ This tab is your first stop when starting with Advanced Automoderator, as it is
telling name and click the **Create** button. This will create a new tab with that name.

Furthermore, this is also the place to create and manage your lists. Lists are used to store words or domains that you
want to use as black- or whitelist triggers in your rules. More on that under [Lists](#lists).
want to use as black- or allowlist triggers in your rules. More on that under [Lists](#lists).

### Logs

Expand All @@ -42,11 +42,11 @@ With that out of the way, we'll go through how to _actually_ make Advanced Autom

### Lists

As mentioned above, lists are used to store words or domains that you want to use as black- or whitelist triggers in your
As mentioned above, lists are used to store words or domains that you want to use as black- or allowlist triggers in your
rules.

Multiple entries in word lists are separated by either a newline or a space. Entries in word lists must be single words
containing no spaces; to blacklist complete phrases, use a regex trigger instead.
containing no spaces; to denylist complete phrases, use a regex trigger instead.

For website / link lists, specify _just_ the site's domain, without any protocol or path. Subdomains will be
automatically included. Logically, if you want to _only_ check against some specific subdomain (and its sub-subdomains),
Expand Down
30 changes: 15 additions & 15 deletions content/docs/moderation/advanced-automoderator/triggers.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,8 @@ This trigger will fire when a message exceeds the configured threshold for *uniq

This trigger will fire when a message contains *any* valid link.[^1]

For more fine-grained control, consider using the [Website blacklist](#website-blacklist) or
[Website whitelist](#website-whitelist) trigger.
For more fine-grained control, consider using the [Website denylist](#website-denylist) or
[Website allowlist](#website-allowlist) trigger.

#### X Violations in y minutes

Expand All @@ -69,7 +69,7 @@ This will trigger when the offending user has amassed x violations in y minutes,
- **Ignore if a higher violation trigger of this name was activated**<br>
Whether to ignore this if a trigger with a higher threshold for the same violation was activated. (Default: on)

#### Word blacklist
#### Word denylist

This trigger will fire when a message contains any word from the specified list.

Expand All @@ -79,23 +79,23 @@ This trigger will fire when a message contains any word from the specified list.
- **Also match visually similar characters**<br>
Whether to also match visually similar characters, like `Ĥéĺĺó`. (Default: off)

#### Word whitelist
#### Word allowlist

Triggers when a message contains words **not** in the specified list. See [Word blacklist](#word-blacklist) for
Triggers when a message contains words **not** in the specified list. See [Word denylist](#word-denylist) for
configuration.

#### Website blacklist
#### Website denylist

This trigger will fire when a message contains any link to a domain from the specified list, subdomains included.

- **List**<br>
The list to check against. (Default: first found list)

#### Website whitelist
#### Website allowlist

Triggers when a message contains links **not** in the specified list. See [Website blacklist](#website-blacklist).
Triggers when a message contains links **not** in the specified list. See [Website denylist](#website-denylist).

Depending on your use-case, it may be more time-efficient to use a whitelist instead of a blacklist.
Depending on your use-case, it may be more time-efficient to use a allowlist instead of a denylist.

#### Server invites

Expand Down Expand Up @@ -186,7 +186,7 @@ This trigger will fire when the nickname of the user matches the specified regul

The inverse of [Nickname matches regex](#nickname-matches-regex). See there for configuration.

#### Nickname word whitelist
#### Nickname word allowlist

This trigger will fire when the nickname of the user contains words **not** in the specified list.

Expand All @@ -195,10 +195,10 @@ This trigger will fire when the nickname of the user contains words **not** in t
- **Also match visually similar characters**<br>
Whether to also match visually similar characters, like `Ĥéĺĺó`. (Default: off)

#### Nickname word blacklist
#### Nickname word denylist

This trigger will fire when the nickname of the user contains any word from the specified list.
See [Nickname word whitelist](#nickname-word-whitelist) for configuration.
See [Nickname word allowlist](#nickname-word-allowlist) for configuration.

- **List**<br>
The list to check against. (Default: first found list)
Expand All @@ -221,7 +221,7 @@ This trigger will fire when the offending user has sent x attachments in y secon
See [X user attachments in Y seconds](#x-user-attachments-in-y-seconds), but now applied to the channel as a whole,
instead of a single user.

#### Join username word whitelist
#### Join username word allowlist

This trigger will fire when the username of a user joining the server contains words **not** in the specified list.

Expand All @@ -230,10 +230,10 @@ This trigger will fire when the username of a user joining the server contains w
- **Also match visually similar characters**<br>
Whether to also match visually similar characters, like `Ĥéĺĺó`. (Default: off)

#### Join username word blacklist
#### Join username word denylist

This trigger will fire when the username of a user joining the server contains any word from the specified list. See
[Join username word whitelist](#join-username-word-whitelist) for configuration.
[Join username word allowlist](#join-username-word-allowlist) for configuration.

#### Join username matches regex

Expand Down
6 changes: 3 additions & 3 deletions content/docs/moderation/logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,9 +105,9 @@ messages, they will not be able to see deleted messages, or that a message was d

## Blacklisting Channels

Under the Logging page on the control panel you may blacklist channels for log creation. Using the logs command in a
blacklisted channel will return an error message. Moderation actions will also not generate or attach logs in
blacklisted channels.
Under the Logging page on the control panel you may denylist channels for log creation. Using the logs command in a
denylisted channel will return an error message. Moderation actions will also not generate or attach logs in
denylisted channels.

## Deleting Logs

Expand Down

0 comments on commit ce5e94b

Please sign in to comment.