Commit Graph

117 Commits

Author SHA1 Message Date
FoxxMD
b094b72d4a docs: Update docker compose instructions
* Specify docker-compose minimum version
* Change commands to use new syntax
2022-11-21 11:29:14 -05:00
FoxxMD
d90e88360d feat: Add some author properties for templating 2022-11-17 13:16:10 -05:00
FoxxMD
718f81b921 feat(docs): Generate docs on startup or in docker build
* Generate docs if none found on Web client startup
* Add "Docs" link to local docs index
* Add working implementation of building docs in docker image
2022-11-15 13:07:40 -05:00
FoxxMD
4041ea5bb5 docs: Revert to using docs folder only
* Using project dir copies too much to _site directory and causes TS issues
* In order to keep "home" page in generated docs need to duplicate project README (unfortunately)
2022-11-15 09:36:29 -05:00
FoxxMD
981591a5fa docs: Add more filters documentation 2022-11-14 14:42:56 -05:00
FoxxMD
f58430c615 docs: Add doc site development documentation 2022-11-14 11:59:02 -05:00
FoxxMD
b3b0d92f2a docs: Use project README as index and fix more links 2022-11-14 11:54:07 -05:00
FoxxMD
34ee5da082 docs: Fix broken link 2022-11-14 11:33:05 -05:00
FoxxMD
ba8ad100bc docs: Fix detail expansion blocks
https://github.com/just-the-docs/just-the-docs/issues/246#issuecomment-643783307
2022-11-14 10:46:40 -05:00
FoxxMD
4b6f66499a docs: Fix relative links 2022-11-09 15:19:47 -05:00
FoxxMD
9a08df1990 testing relative links in plain docs with parent 2022-11-09 14:47:03 -05:00
FoxxMD
1f3aa8e732 testing relative links in plain docs 2022-11-09 14:44:53 -05:00
FoxxMD
ec98d8f629 docs: Initial implementation of just-the-docs 2022-11-09 14:22:53 -05:00
FoxxMD
b9f85814d4 Merge branch 'dockerCompose' into edge 2022-11-01 16:41:14 -04:00
FoxxMD
e11a1d2a52 feat: Add full docker-compose support and documentation
* Annotated docker-compose file
* simplified CM config.yaml for docker-compose "base"
* instructions for usage in installation docs
2022-11-01 16:41:00 -04:00
FoxxMD
0127cbfd0f docs: Add cookbook recipe for monitoring popular submissions 2022-10-27 15:40:53 -04:00
FoxxMD
59d31bde84 feat(comment): Implement commenting as subreddit 2022-10-27 14:29:05 -04:00
FoxxMD
fdc0ccf4c8 fix(mhs): Fix examples missing criteria property 2022-10-25 16:51:47 -04:00
FoxxMD
d67283a923 feat(filter): Add same regex/matching functionality for author flair filtering as item has 2022-10-24 13:02:27 -04:00
FoxxMD
fcfb037d6c feat(docs): Add more cookbook recipies 2022-10-20 12:33:20 -04:00
FoxxMD
8c3601a4cf refactor(docs): Improve CM examples by using a "cookbook"
* Better instructions on how to use configs
* Remove json examples since everything else in docs is yaml
2022-10-20 10:49:17 -04:00
FoxxMD
cfc96b6c82 Merge branch 'sharedBaseConfig' into edge
# Conflicts:
#	src/Subreddit/UserNotes.ts
2022-10-20 09:37:01 -04:00
FoxxMD
239d173ffd feat(config): Implement ACL for full config sharing 2022-10-20 09:35:26 -04:00
FoxxMD
fd5488376a docs: Add template variable examples for most rules #121 2022-10-18 13:18:12 -04:00
FoxxMD
6c8ea66fcc docs: Typo fix 2022-10-18 11:07:19 -04:00
FoxxMD
acbb9a8626 feat(usernote): Improve usernote filtering functionality
Same as modActions...

* Add `referencesCurrentActivity` boolean to filter by notes associated with current activity
* Add `note` string property to filter by note content (string or regular expression)
* Replace `allowDuplicates` with `existingNoteCheck` on UserNoteAction to allow for more granular note control on action
2022-10-17 15:32:47 -04:00
FoxxMD
122d5fb2af docs: Fix malformed URLs
Fixes #114
2022-10-17 14:16:34 -04:00
FoxxMD
542aa26c62 feat(history): Implement ratio comparison #112 2022-10-03 13:25:05 -04:00
FoxxMD
1b20122ffc docs: Fix some typos 2022-09-23 10:35:13 -04:00
FoxxMD
b3df1b4d41 Update default confidence for MHS based on feedback from Welton 2022-09-20 10:56:39 -04:00
FoxxMD
4abe8e07f3 docs: Add docs for MHS toxic content prediction rule 2022-09-20 10:44:08 -04:00
FoxxMD
44f9389b69 docs: Add general subreddit/moderator docs readme
* Also add Guest Access docs
2022-09-16 16:40:28 -04:00
FoxxMD
71b2d0597d docs: Update screenshots 2022-09-16 15:38:52 -04:00
FoxxMD
95216b3950 docs: Add GHCR image location to install docs
Closes #109
2022-09-13 15:06:13 -04:00
FoxxMD
49ac8cda19 feat: Update github actions to push to multiple registries
And add documentation for GH actions local dev/testing
2022-09-13 14:23:22 -04:00
FoxxMD
2fb503f09f feat(message): Implement templating for to field so subreddit can be used generically
since 'to' be now be templated a user can configure a message to send to the subreddit the action is being processed from using `to: 'r/{{item.subreddit}}'`
2022-08-31 09:58:24 -04:00
FoxxMD
84f2da8b6d feat(action): Implement Action templating data #104
* Add top-level 'actionSummary' template variable that renders a markdown list of action results
* Add individual action result/data, in the same structure as rules, under the top-level 'actions' template variable
2022-08-30 17:12:51 -04:00
FoxxMD
f82d985eab feat(template): Refactor templating to be more extensible and add some requested data
* Implement interfaces for template parts
* Refactor Action constructor to take an object for runtime options (cleaner, more extensible)
* Refactor subreddit resource and snoowraputils content rendering and organization to use objects of optional data rather than required arguments
  * Make almost all data optional and only parse/render if included
  * Move rule results parsing/formatting into own function
  * Refactor footer render to use renderContent (DRY)
* Add some requested template data #104
  * {{item.subreddit}} #87
  * {{check}} #87
* Updated templating documentation
2022-08-26 13:42:02 -04:00
FoxxMD
4b95ccd0ba feat(docs): Simplify getting started operator instructions
Take advantage of First Time Setup page when no configuration is present to help generate a minimum configuration.
2022-08-23 09:46:54 -04:00
FoxxMD
567a2f0720 feat(action): Implement creating submissions #93
* Create self/link submissions, no reddit media (upload) yet
* Submission can use user modifiers (nsfw, spoiler) and mod modifiers (sticky, distinguish, lock)
* Can create submission in current subreddit (default) or arbitrary subreddit defined in configuration (targets)
  * Can create multiple submissions by defining multiple targets
2022-08-22 14:00:27 -04:00
FoxxMD
9158bda992 feat(comment): Implement arbitrary comment targets #93 2022-08-19 11:01:54 -04:00
FoxxMD
cc0c3dfe61 docs: Fix incorrect url for minimum config 2022-08-15 15:57:45 -04:00
FoxxMD
01f95a37e7 feat(ui): Add guided tour for main dashboard 2022-08-03 14:37:56 -04:00
FoxxMD
f8df6fc93f docs: Remove removal reason footnote 2022-08-02 13:02:28 -04:00
FoxxMD
86a3b229cb feat(remove): Implement removal reason id and note
* Cache subreddit removal reasons and display in popup helper in authenticated config editor
* Add fields for removal reason note/reason in remove action
* Update remove action documentation to include new fields
2022-08-02 12:34:40 -04:00
FoxxMD
d684ecc0ff docs: Add memory management notes
* Document memory management approaches
* Change node args for docker to a better name (NODE_ARGS)
* Implement default node arg for docker `--max_old_space_size=512`
2022-07-25 12:20:02 -04:00
FoxxMD
fa450f9f8f docs(database): Add influx/grafana documentation 2022-07-11 13:46:27 -04:00
FoxxMD
1e76ca6c0e docs(config): Add partial configuration documentation 2022-07-11 13:01:40 -04:00
FoxxMD
0379ad17b9 feat: Add more Activity data to templating data #94
* Add votes, reports, upvote ratio, nsfw, op, and spoiler
* Update templating documentation
2022-07-08 10:24:10 -04:00
FoxxMD
242c6a49b5 docs(usernote): Document usernote types in schema and in documentation 2022-06-27 09:33:57 -04:00