github/context-mod
1
1
Fork 0
mirror of https://github.com/FoxxMD/context-mod.git synced 2026-01-10 22:28:02 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs: Use project README as index and fix more links

Browse Source
This commit is contained in:
FoxxMD
2022-11-14 11:54:07 -05:00
parent 34ee5da082
commit b3b0d92f2a
11 changed files with 41 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -1,3 +1,7 @@
---
title: Home
nav_order: 1
---
# ContextMod [![Latest Release](https://img.shields.io/github/v/release/foxxmd/context-mod)](https://github.com/FoxxMD/context-mod/releases) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Docker Pulls](https://img.shields.io/docker/pulls/foxxmd/context-mod)](https://hub.docker.com/r/foxxmd/context-mod)
<img src="/docs/logo.png" align="right"

2
_config.yml
View File

@@ -2,7 +2,7 @@ title: ContextMod
description: Documentation for ContextMod
theme: just-the-docs
source: docs
#source: docs
url: https://contextmod.dev

4
docs/README.md
View File

@@ -1,6 +1,6 @@
---
title: Home
nav_order: 1
title: Overview
nav_order: 2
---
# Table of Contents

6
docs/development.md
View File

@@ -1,5 +1,5 @@
---
nav_order: 6
nav_order: 7
---
# Development
@@ -10,9 +10,9 @@ TODO add more development sections...
Use [act](https://github.com/nektos/act) to run Github actions locally.
An example secrets file can be found in the project working directory at [act.env.example](act.env.example)
An example secrets file can be found in the project working directory at [act.env.example](../act.env.example)
Modify [push-hook-sample.json](.github/push-hook-sample.json) to point to the local branch you want to run a `push` event trigger on, then run this command from the project working directory:
Modify [push-hook-sample.json](../.github/push-hook-sample.json) to point to the local branch you want to run a `push` event trigger on, then run this command from the project working directory:
```bash
act -e .github/push-hook-sample.json --secret-file act.env

2
docs/moderators/README.md
View File

@@ -1,7 +1,7 @@
---
has_children: true
title: Moderators
nav_order: 2
nav_order: 3
---
This section is for **reddit moderators**. It covers how to use a CM bot for your subreddit.

2
docs/operator/README.md
View File

@@ -1,6 +1,6 @@
---
has_children: true
nav_order: 3
nav_order: 4
---
# Operator

2
docs/subreddit-configuration/README.md
View File

@@ -1,6 +1,6 @@
---
has_children: true
nav_order: 4
nav_order: 5
---
# Subreddit Configuration

14
docs/subreddit-configuration/activitiesWindow.md
View File

@@ -30,13 +30,13 @@ parent: Subreddit Configuration
# Overview
An **Activity Window** (`window`) is a group of properties that describe a **range** of [**Activities**](/docs/README.md#activity) to retrieve from Reddit and how to **filter** them.
An **Activity Window** (`window`) is a group of properties that describe a **range** of [**Activities**](../README.md#activity) to retrieve from Reddit and how to **filter** them.
The main components of an Activity Window:
* **Range** -- How many Activities ([`count`](#count)) or what time period ([`duration`](#duration)) of Activities to fetch
* **Type of Activities** -- When **fetching** from an Author's history, should it return overview (any Activities), just Submissions, or just Comments?
* **Filters** -- How the retrieved Activities should be [filtered](/docs/moderators/components/README.md#filters) before returning them to a Rule
* **Filters** -- How the retrieved Activities should be [filtered](README.md#filters) before returning them to a Rule
As an example, if you want to run a **Recent Activity Rule** to check if a user has had activity in /r/mealtimevideos you also need to define what range of activities you want to look at from that user's history.
@@ -220,7 +220,7 @@ window:
# Filters
Activity Window can also specify [Item and Subreddit Filters](/docs/moderators/components/README.md#filters) to filter the Activities retrieved from Reddit before they are returned to a Rule.
Activity Window can also specify [Item and Subreddit Filters](README.md#filters) to filter the Activities retrieved from Reddit before they are returned to a Rule.
Activities can be filtered **during** (`pre`) retrieval or **after** (`post`) retrieval. **When**, during the window **lifecycle**, the Activities are filtered can change the set of Activities returned to a Rule drastically.
@@ -228,10 +228,10 @@ Activities can be filtered **during** (`pre`) retrieval or **after** (`post`) re
Regardless of when you are filtering Activities the shape of the filter is the same. Filter properties:
* `subreddits` -- A [Filter Shape](/docs/moderators/components/README.md#filter-shapes) for filtering by the [Subreddit Criteria](/docs/moderators/components/README.md#subreddit-filter) of each Activity
* `submissionState` -- A [Filter Shape](/docs/moderators/components/README.md#filter-shapes) for [Submission Criteria](/docs/moderators/components/README.md#item-filter). Will run only if filtering a Submission.
* `commentState` -- A [Filter Shape](/docs/moderators/components/README.md#filter-shapes) for [Comment Criteria](/docs/moderators/components/README.md#item-filter). Will run only if filtering a Comment.
* `activityState` -- A [Filter Shape](/docs/moderators/components/README.md#filter-shapes) for either [Submission or Comment Criteria](/docs/moderators/components/README.md#item-filter). Will run only if `submissionState` or `commentState` is not defined for their respective Activity types.
* `subreddits` -- A [Filter Shape](README.md#filter-shapes) for filtering by the [Subreddit Criteria](README.md#subreddit-filter) of each Activity
* `submissionState` -- A [Filter Shape](README.md#filter-shapes) for [Submission Criteria](README.md#item-filter). Will run only if filtering a Submission.
* `commentState` -- A [Filter Shape](README.md#filter-shapes) for [Comment Criteria](README.md#item-filter). Will run only if filtering a Comment.
* `activityState` -- A [Filter Shape](README.md#filter-shapes) for either [Submission or Comment Criteria](README.md#item-filter). Will run only if `submissionState` or `commentState` is not defined for their respective Activity types.
In this example the filter only returns Activities:

36
docs/subreddit-configuration/cookbook/README.md
View File

@@ -17,7 +17,7 @@ If the type is **Check** or **Run** the recipe contents will have instructions i
### As Config Fragment
**Checks, Runs, Actions, and Rule** recipes can be referenced in your config without copy-pasting by using them as [Config Fragments.](/docs/moderators/components/README.md#partial-configurations) These need to be placed in the correct spot in your config, just like copy-pasting, but only require the URL of the recipe instead of all the code.
**Checks, Runs, Actions, and Rule** recipes can be referenced in your config without copy-pasting by using them as [Config Fragments.](../README.md#partial-configurations) These need to be placed in the correct spot in your config, just like copy-pasting, but only require the URL of the recipe instead of all the code.
To use a recipe as a fragment **copy** the URL of the config and insert into your config like this:
@@ -51,42 +51,42 @@ runs:
### Remove submissions from users who have used 'freekarma' subs to bypass karma checks
* Type: **Check**
* [Config](/docs/moderators/components/cookbook/freekarma.yaml)
* [Config](freekarma.yaml)
If the user has any activity (comment/submission) in known freekarma subreddits in the past (100 activities) then remove the submission.
### Remove submissions that are consecutively spammed by the author
* Type: **Check**
* [Config](/docs/moderators/components/cookbook/crosspostSpam.yaml)
* [Config](crosspostSpam.yaml)
If the user has crossposted the same submission in the past (100 activities) 4 or more times in a row then remove the submission.
### Remove submissions if users is flooding new
* Type: **Check**
* [Config](/docs/moderators/components/cookbook/floodingNewSubmissions.yaml)
* [Config](floodingNewSubmissions.yaml)
If the user has made more than 4 submissions in your subreddit in the last 24 hours than new submissions are removed and user is tagged with a modnote.
### Remove submissions posted in diametrically-opposed subreddit
* Type: **Check**
* [Config](/docs/moderators/components/cookbook/diametricSpam.yaml)
* [Config](diametricSpam.yaml)
If the user makes the same submission to another subreddit(s) that are "thematically" opposed to your subreddit it is probably spam. This check removes it. Detects all types of submissions (including images).
### Remove comments that are consecutively spammed by the author
* Type: **Check**
* [Config](/docs/moderators/components/cookbook/commentSpam.yaml)
* [Config](commentSpam.yaml)
If the user made the same comment (with some fuzzy matching) 4 or more times in a row in the past (100 activities or 6 months) then remove the comment.
### Remove comment if it is a chat invite link spam
* Type: **Check**
* [Config](/docs/moderators/components/cookbook/chatSpam.yaml)
* [Config](chatSpam.yaml)
This rule goes a step further than automod can by being more discretionary about how it handles this type of spam.
@@ -105,7 +105,7 @@ This way ContextMod can more easily distinguish between these use cases for a us
### Remove comments reposted from youtube video submissions
* Type: **Check**
* [Config](/docs/moderators/components/cookbook/youtubeCommentRepost.yaml)
* [Config](youtubeCommentRepost.yaml)
**Requires bot has an API Key for Youtube.**
@@ -114,7 +114,7 @@ Removes comment on reddit if the same comment is found on the youtube video the
### Remove comments reposted from reddit submissions
* Type: **Check**
* [Config](/docs/moderators/components/cookbook/commentRepost.yaml)
* [Config](commentRepost.yaml)
Checks top-level comments on submissions younger than 30 minutes:
* Finds other reddit submissions based on crosspost/duplicates/title/URL, takes top 10 submissions based # of upvotes
@@ -123,7 +123,7 @@ Checks top-level comments on submissions younger than 30 minutes:
### Remove reposted reddit submission
* Type: **Check**
* [Config](/docs/moderators/components/cookbook/submissionRepost.yaml)
* [Config](submissionRepost.yaml)
Checks reddit for top posts with a **Title** that is 90% or more similar to the submission being checked and removes it, if found.
@@ -132,7 +132,7 @@ Checks reddit for top posts with a **Title** that is 90% or more similar to the
### Remove link submissions where the user's history is comprised of 10% or more of the same link
* Type: **Check**
* [Config](/docs/moderators/components/cookbook/selfPromo.yaml)
* [Config](selfPromo.yaml)
If the link origin (youtube author, twitter author, etc. or regular domain for non-media links)
@@ -144,7 +144,7 @@ then remove the submission
### Remove submissions posted in 'newtube' subreddits
* Type: **Check**
* [Config](/docs/moderators/components/cookbook/newtube.yaml)
* [Config](newtube.yaml)
If the user makes the same submission to a 'newtube' or self-promotional subreddit it is removed and a modnote is added.
@@ -153,14 +153,14 @@ If the user makes the same submission to a 'newtube' or self-promotional subredd
### Remove comments on brigaded submissions when user has no history
* Type: **Check**
* [Config](/docs/moderators/components/cookbook/brigadingNoHistory.yaml)
* [Config](brigadingNoHistory.yaml)
The users of comments on a brigaded submission (based on a special submission flair) have their comment history checked -- if they have no participation in your subreddit then the comment is removed.
### Remove submissions from users with a history of sex solicitation
* Type: **Check**
* [Config](/docs/moderators/components/cookbook/sexSolicitationHistory.yaml)
* [Config](sexSolicitationHistory.yaml)
If the author of a submission has submissions in their history that match common reddit "sex solicitation" tags (MFA, R4F, M4F, etc...) the submission is removed and a modnote added.
@@ -173,7 +173,7 @@ The check can be modified to removed comments by changing `kind: submission` to
### Verify users from r/TranscribersOfReddit
* Type: **Check**
* [Config](/docs/moderators/components/cookbook/transcribersOfReddit.yaml)
* [Config](transcribersOfReddit.yaml)
[r/TranscribersOfReddit](https://www.reddit.com/r/transcribersofreddit) is a community of volunteers transcribing images and videos, across reddit, into plain text.
@@ -182,14 +182,14 @@ This Check detects their standard transcription template and also checks they ha
### Require submission authors have prior subreddit participation
* Type: **Check**
* [Config](/docs/moderators/components/cookbook/requireNonOPParticipation.yaml)
* [Config](requireNonOPParticipation.yaml)
Submission is removed if the author has **less than 5 non-OP comments** in your subreddit prior to making the submission.
### Require submission authors make a top-level comment with 15 minutes of posting
* Type: **Check**
* [Config](/docs/moderators/components/cookbook/requireNonOPParticipation.yaml)
* [Config](requireNonOPParticipation.yaml)
After making a submission the author must make a top-level comment with a regex-checkable pattern within X minutes. If the comment is not made the submission is removed.
@@ -198,7 +198,7 @@ After making a submission the author must make a top-level comment with a regex-
### Sticky a comment on popular submissions
* Type: **Run**
* [Config](/docs/moderators/components/cookbook/popularSubmissionMonitoring.yaml)
* [Config](popularSubmissionMonitoring.yaml)
This **Run** should come after any other Runs you have that may remove a Submission.

3
docs/subreddit-configuration/imageComparison.md
View File

@@ -7,7 +7,7 @@ parent: Subreddit Configuration
ContextMod supports comparing image content, for the purpose of detecting duplicates, with two different but complimentary systems. Image comparison behavior is available for the following rules:
* [Recent Activity](/docs/moderators/components/recentActivity)
* [Recent Activity](in-depth/recentActivity)
* Repeat Activity (In-progress)
To enable comparisons reference the example below (at the top-level of your rule) and configure as needed:
@@ -44,6 +44,7 @@ YAML
```yaml
name: ruleWithImageDetection
kind: recentActivity
imageDetection:
enable: true
threshold: 5
fetchBehavior: extension

2
docs/webInterface.md
View File

@@ -1,5 +1,5 @@
---
nav_order: 5
nav_order: 6
---
# Web Interface