67 Commits

Author SHA1 Message Date
FoxxMD
05f477b67d Merge branch 'edge' 2022-05-12 12:27:51 -04:00
FoxxMD
9080c7bdf4 Some more docs additions for subreddit state 2022-05-12 12:27:18 -04:00
FoxxMD
d418bf50eb Some cleanup on activity window docs 2022-05-12 12:22:48 -04:00
FoxxMD
5c8e73fee0 docs(activity window): Overhaul activity window docs
* Improve existing documentation with simpler language
* Organize/add table of contents
* Add window lifecycle diagram
* Add documentation for filter/fetch properties #55
2022-05-12 12:07:26 -04:00
FoxxMD
cf553cad59 docs: Re-organize docs structure and cleanup main readme 2022-04-27 10:09:13 -04:00
FoxxMD
1df9cd2b2a docs: Finish subreddit configuration docs refactor 2022-04-27 09:44:17 -04:00
FoxxMD
344dcc9879 refactor: New docs for subreddit configurations
More features documented with better examples. Not done yet...
2022-04-26 15:54:20 -04:00
FoxxMD
fc24b05eb3 fix: Fix links in documentation 2022-04-22 15:30:52 -04:00
FoxxMD
bfc7f8a508 docs: Rewrite and improve operator-related documentation
* Break out documentation into more standalone docs and reorganize into an operator folder
* Remove outdated information on adding bot
* Add additional information on docker install
* Make configuration more opinionated for "recommend" approach
* Add docs on database and caching
* Rewrite operator getting started guide to be more concise
2022-04-22 15:24:56 -04:00
FoxxMD
942d4fb2f2 feat(filter)!: Change behavior for rules that fail filter criteria tests
Instead of "skipping" the rule will now fail. This aligns Rule behavior with how filters work through the rest of CM which should reduce cognitive load and development effort.

If the skipping behavior is still desired a user can use a RuleSet with OR condition to achieve the same effect.
2022-04-21 10:19:54 -04:00
Christian Walde
e9135ec1ef trying to use names key in authorfilter causes config parse failure 2022-04-05 13:49:41 +02:00
FoxxMD
e9b76bc503 refactor(docker): Improve permissions and set default db driver
* Change project location to /home/node to avoid root permissions when creating WORKDIR
* Create default config directory with correct permissions in the event no volume is mounted
* Set default db driver to better-sqlite3 since we control environment -- it has better performance and we know we can use a pre-built binary b/c of base docker image
2022-03-30 16:20:07 -04:00
FoxxMD
f6fb0dc877 docs: Add development instructions for mocking reddit api network issues 2022-03-16 12:02:30 -04:00
FoxxMD
f4103206db docs: some clarifications in flow control wording 2022-03-07 13:17:17 -05:00
FoxxMD
c9b1bfed40 fix(docs): mermaid issue was being inside closed detail block
For some reason. Removing blocks fixed rendering error
2022-03-07 13:11:45 -05:00
FoxxMD
7f764b4d99 fix(docs): Replace colon causing issues with mermaid diagram rendering 2022-03-07 13:06:12 -05:00
FoxxMD
fb7ddbba70 docs: Add overview for runs and flow control #73 2022-03-07 13:02:17 -05:00
FoxxMD
85b1d13718 docs: Refactor docs to use runs syntax
* Add Runs to main docs readme and concepts
* Add high level diagram in main docs readme to show CM lifecycle
* Refactor subreddit/rule examples to use runs syntax
2022-03-07 10:28:48 -05:00
FoxxMD
4f9d1c1ca1 docs: Some clarifications for install/run directions 2022-02-14 10:54:25 -05:00
FoxxMD
176611dbf3 docs: Add web interface and config onboarding 2022-02-11 23:40:28 -05:00
FoxxMD
174d832ab0 docs: Pretty up readme header 2022-01-18 16:08:40 -05:00
FoxxMD
dcc5f87c30 refactor(docs): Clean up flair docs
* Fix regex escaped characters
* Use authorIs
* make flair action type usage more clear
2022-01-10 12:22:16 -05:00
Marcin Macinski
bc541d00d4 feat(docs): User flair and submission flair docs 2022-01-08 00:02:37 +01:00
FoxxMD
0ae74fdce1 docs: Add missing config box screenshot 2022-01-03 13:42:35 -05:00
FoxxMD
845173822c docs(onboarding): Update moderator getting started to reflect new editor capabilities 2022-01-03 13:40:17 -05:00
FoxxMD
b32c4f213c docs(yaml): Finish adding yaml examples
#61
2021-12-25 16:42:44 -05:00
FoxxMD
7e01c8d1f8 docs(yaml): add yaml examples fo activities window
#61
2021-12-25 16:28:58 -05:00
FoxxMD
aee158ecc9 docs(yaml): add attribution and advanced concepts yaml examples
#61
2021-12-25 16:18:13 -05:00
FoxxMD
8cd2243c2d docs(yaml): add history and author yaml examples
#61
2021-12-25 16:07:46 -05:00
FoxxMD
4969789532 docs(yaml): add recentActivity yaml examples
#61
2021-12-25 15:53:54 -05:00
FoxxMD
1dcfdc14d1 docs(yaml): add regex yaml examples
#61
2021-12-25 15:23:34 -05:00
FoxxMD
f1c9b64f64 docs(yaml): Add more examples
#61
2021-12-23 21:35:18 -05:00
FoxxMD
2e5a61566b docs(yaml): create yaml versions of subreddit ready examples
#61
2021-12-23 12:34:50 -05:00
FoxxMD
fb5fc961cc feat(docs): Add youtube credentials requirements for repost rule 2021-12-21 09:33:24 -05:00
FoxxMD
c04b305881 feat(docs): Add link-spamming regex config 2021-12-21 09:22:35 -05:00
FoxxMD
9790e681ea docs(regex): Add subreddit-ready example for removing discord link spam 2021-12-16 16:27:06 -05:00
FoxxMD
0c31bdf25e refactor(repost): Improve repost criteria configuration and add documentation
* Simplify usage b/w comment-submission by removing "criteria" in main criteria property -- comment checks can just use additional properties
* Consolidated occurrence count/time into one property to allow and/or operands on both conditions (more powerful!)
* Added documentation describing repost configuration
* Added repost configuration examples
2021-12-07 16:30:05 -05:00
FoxxMD
027199d788 docs(heroku): Add information on dyno usage 2021-11-15 17:27:42 -05:00
FoxxMD
2c797e0b9b docs(image): Add documentation for image comparison
#26
2021-10-12 11:10:14 -04:00
FoxxMD
15806b5f1f Add regex documentation 2021-08-26 11:26:59 -04:00
FoxxMD
82a1a393de Rewrite docs for mod/operator to include bot authentication approaches 2021-08-20 14:27:32 -04:00
FoxxMD
2fd1ffed19 Rewrite docs to explain server-client architecture 2021-08-20 13:47:55 -04:00
FoxxMD
7b00e1c54b Add more screenshots and information to web ui section 2021-08-20 12:11:36 -04:00
FoxxMD
707547effc Implement separate credentials for web 2021-08-10 12:02:03 -04:00
FoxxMD
7f1429395c Fix links in getting started 2021-07-30 18:17:13 -04:00
FoxxMD
2a5f812dba Implement defining multiple operators 2021-07-30 14:19:49 -04:00
FoxxMD
547f57b99f Some configuration override clarification 2021-07-30 12:05:07 -04:00
FoxxMD
bf336ca55a Move the schema/settings for operator into json schema (viewer)
easier to read, has full examples, and validation
2021-07-30 12:00:42 -04:00
FoxxMD
4716ac8c0a Add docs for thresholds and expand caching docs 2021-07-30 10:43:05 -04:00
FoxxMD
b72a3fea7f Fill out some TODOs for docs (checks, filters) 2021-07-30 10:04:51 -04:00