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

docs/moderation: document moderation section #15

Merged
merged 35 commits into from
Jun 2, 2024
Merged

Conversation

l-zeuch
Copy link
Collaborator

@l-zeuch l-zeuch commented Mar 23, 2024

I'm still thinking about the best way to structure the advanced
automoderator page, as it is per definition quite complex.

What's still missing is the general moderation section, but that should
be fairly quick to write.

Do feel free to leave comments and thoughts about the as of now
unwritten pages. Basic Automoderator is up for review right here, too.

Terms

l-zeuch added 2 commits March 23, 2024 13:49
Signed-off-by: Luca Zeuch <l-zeuch@email.de>
Document the entirety of our basic automoderator, outlining the general
configuration and details on each available rule.

Signed-off-by: Luca Zeuch <l-zeuch@email.de>
@l-zeuch
Copy link
Collaborator Author

l-zeuch commented Mar 23, 2024

As a heads-up, I didn't feel like a screenshot is necessary for the
basic automoderator page, as it is quite clear in its layout already.

also initial work on documenting the main moderation commands in
subpages.

Signed-off-by: SoggySaussages <vmdmaharaj@gmail.com>
SoggySaussages and others added 20 commits March 24, 2024 12:36
* docs/moderation: document moderation page

also initial work on documenting the main moderation commands in
subpages.

Signed-off-by: SoggySaussages <vmdmaharaj@gmail.com>

* docs/moderation: typo and case fixes

---------

Signed-off-by: SoggySaussages <vmdmaharaj@gmail.com>

Reviewed-by: Luca Zeuch <l-zeuch@email.de>
Signed-off-by: Luca Zeuch <l-zeuch@email.de>
Signed-off-by: SoggySaussages <vmdmaharaj@gmail.com>
Signed-off-by: SoggySaussages <vmdmaharaj@gmail.com>
Signed-off-by: SoggySaussages <vmdmaharaj@gmail.com>
Signed-off-by: SoggySaussages <vmdmaharaj@gmail.com>
Signed-off-by: SoggySaussages <vmdmaharaj@gmail.com>
Signed-off-by: SoggySaussages <vmdmaharaj@gmail.com>
Signed-off-by: SoggySaussages <vmdmaharaj@gmail.com>
docs/moderation: document moderation commands

Reviewed-by: Luca Zeuch <l-zeuch@email.de>
Signed-off-by: Luca Zeuch <l-zeuch@email.de>
Remove the superfluous "BAM" acronym, it isn't used anywhere in the text
anyway and only makes things less clear when cross-referencing from
other pages.

Signed-off-by: Luca Zeuch <l-zeuch@email.de>
Signed-off-by: Luca Zeuch <l-zeuch@email.de>
The 'chapter' archetype is best used for top-level pages, rather than
subpages that document something, so use 'default'.

Signed-off-by: Luca Zeuch <l-zeuch@email.de>
docs/moderation: document verification
docs/moderation: document logging
Introduce YAGPDB's Advanced Automoderator, outlining its basic
configuration structure of rulesets and rules, as well as its
limitations.

Triggers, Conditions, and Effects have their own sub-page allocated,
they will follow in future commits.

Signed-off-by: Luca Zeuch <l-zeuch@email.de>
Document the Advanced Automoderator triggers, listing them in the order
as they appear on the control panel.

Reiterate the trigger logic (logical OR) as discussed on the AA intro
page.

Signed-off-by: Luca Zeuch <l-zeuch@email.de>
Document Advanced Automoderator conditions, reiterating on their logic
as well as noting when conditions are mutually exclusive to certain
triggers or other conditions.

Signed-off-by: Luca Zeuch <l-zeuch@email.de>
@l-zeuch l-zeuch force-pushed the docs/moderation branch from 350dcb8 to aff1ed1 Compare May 12, 2024 18:50
Document the Advanced Automoderator effects, in the order as they appear
on the control panel.

Signed-off-by: Luca Zeuch <l-zeuch@email.de>
@l-zeuch l-zeuch marked this pull request as ready for review May 12, 2024 19:21
@l-zeuch
Copy link
Collaborator Author

l-zeuch commented May 12, 2024

This PR is now ready for a proper review.

It might be useful to build this PR locally when reviewing it, as it is
quite large and the diff might be somewhat messy.

Alternatively / additionally, consider reviewing the changes as single
commits rather than the whole PR at once.

Copy link
Collaborator

@jo3-l jo3-l left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some scattered comments of varying value; feel free to ignore as applicable.

content/moderation/advanced-automoderator/_index.md Outdated Show resolved Hide resolved
content/moderation/advanced-automoderator/_index.md Outdated Show resolved Hide resolved
content/moderation/advanced-automoderator/_index.md Outdated Show resolved Hide resolved
content/moderation/advanced-automoderator/conditions.md Outdated Show resolved Hide resolved
content/moderation/advanced-automoderator/conditions.md Outdated Show resolved Hide resolved
content/moderation/moderation-overview.md Outdated Show resolved Hide resolved
content/moderation/moderation-overview.md Outdated Show resolved Hide resolved
content/moderation/verification.md Outdated Show resolved Hide resolved
content/moderation/verification.md Outdated Show resolved Hide resolved
content/moderation/moderation-overview.md Outdated Show resolved Hide resolved
l-zeuch added 7 commits May 17, 2024 11:35
Signed-off-by: Luca Zeuch <l-zeuch@email.de>
Put rules before rulesets in introduction, as they are — after all — the
core concept for advanced automoderator, and it makes the jump from
basic easier as well.

Signed-off-by: Luca Zeuch <l-zeuch@email.de>
Signed-off-by: Luca Zeuch <l-zeuch@email.de>
Signed-off-by: Luca Zeuch <l-zeuch@email.de>
Signed-off-by: Luca Zeuch <l-zeuch@email.de>
Signed-off-by: Luca Zeuch <l-zeuch@email.de>
Signed-off-by: Luca Zeuch <l-zeuch@email.de>
l-zeuch added 3 commits May 31, 2024 15:18
Signed-off-by: Luca Zeuch <l-zeuch@email.de>
Signed-off-by: Luca Zeuch <l-zeuch@email.de>
Signed-off-by: Luca Zeuch <l-zeuch@email.de>
@l-zeuch
Copy link
Collaborator Author

l-zeuch commented May 31, 2024

I think I have adequately addressed every review comment left by you
guys, so I suggest one final review pass and then we should be good to
merge this.

@l-zeuch l-zeuch merged commit 6c44759 into master Jun 2, 2024
4 checks passed
@l-zeuch l-zeuch deleted the docs/moderation branch June 2, 2024 07:18
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.

5 participants