Docs: Add description for mrf_reject_newly_created_account_notes #695

Merged
floatingghost merged 15 commits from YokaiRick/akkoma:doc_mrf_reject_acc_notes into develop 2024-02-24 04:31:28 +00:00
Contributor

Hi,

here is a small pr for documenting mrf_reject_newly_created_account_notes.
I had some trouble configuring it and had some questions regarding what it affects.. so i tried to add all my new achieved knowledge in there ;)

Hopefully this helps other ppl

Hi, here is a small pr for documenting mrf_reject_newly_created_account_notes. I had some trouble configuring it and had some questions regarding what it affects.. so i tried to add all my new achieved knowledge in there ;) Hopefully this helps other ppl
YokaiRick added 2 commits 2024-02-17 21:57:33 +00:00
ci/woodpecker/pr/build-amd64 Pipeline is pending Details
ci/woodpecker/pr/build-arm64 Pipeline is pending Details
ci/woodpecker/pr/docs Pipeline is pending Details
ci/woodpecker/pr/lint Pipeline is pending Details
ci/woodpecker/pr/test Pipeline is pending Details
718104117f
fix link
YokaiRick added 1 commit 2024-02-17 21:58:26 +00:00
ci/woodpecker/pr/build-amd64 Pipeline is pending Details
ci/woodpecker/pr/build-arm64 Pipeline is pending Details
ci/woodpecker/pr/docs Pipeline is pending Details
ci/woodpecker/pr/lint Pipeline is pending Details
ci/woodpecker/pr/test Pipeline is pending Details
db49daa4a5
make it clearer what it affects
YokaiRick added 2 commits 2024-02-17 22:19:34 +00:00
b4c832471c docs/docs/configuration/cheatsheet.md aktualisiert
fixed up some grammer / wording. removed a setence and made wording more in line with what I could find in Admin-FE (especially wording of "rejecting" vs. dropping)
ci/woodpecker/pr/build-amd64 Pipeline is pending Details
ci/woodpecker/pr/build-arm64 Pipeline is pending Details
ci/woodpecker/pr/docs Pipeline is pending Details
ci/woodpecker/pr/lint Pipeline is pending Details
ci/woodpecker/pr/test Pipeline is pending Details
37f9626116
Merge pull request 'Docs: reword description for mrf_reject_newly_created_account_notes for more clarity' (#1) from stefan230/akkoma:doc_mrf_reject_acc_notes_patch into doc_mrf_reject_acc_notes
Reviewed-on: YokaiRick/akkoma#1
Oneric reviewed 2024-02-18 19:52:02 +00:00
Oneric left a comment
Member

heh, i too was planning to add this and other undocumented MRFs soon (there’s at least one more, DirectMessageDisabledPolicy, iinm), but you were faster

As a general note, I think to avoid misunderstanding the docs should clarify that “created at” refers to when the reference to the user on the local instance was created, i.e. when the user was first encountered by the instance, and not when the account was created on its own home instance.
Akkoma cannot do the latter since account creation times are not federated.

EDIT: i initially proposed a style change below, but turned out its actually fine as is. Since Forgejo wouldn’t let me mark the thread as resolved, i instead deleted the thread °~°

heh, i too was planning to add this and other undocumented MRFs soon *(there’s at least one more, `DirectMessageDisabledPolicy`, iinm)*, but you were faster As a general note, I think to avoid misunderstanding the docs should clarify that “created at” refers to when the reference to the user *on the local instance* was created, i.e. when the user was first encountered by the instance, and not when the account was created on its own home instance. Akkoma cannot do the latter since account creation times are not federated. **EDIT:** i initially proposed a style change below, but turned out its actually fine as is. Since Forgejo wouldn’t let me mark the thread as resolved, i instead deleted the thread °~°
Member

i too was planning to add this and other undocumented MRFs soon

Here are the updates, most configurable MRFs already had at least their options documented even if their full name wasn’t listed in the policies list. Includes some refactoring for readability and dropping leftovers from a removed MRF:
https://akkoma.dev/Oneric/akkoma/commits/branch/doc_mrfs

Since this is on top of the changes from this PR, it’s not possible/doesn’t make sense to open a seperate PR; feel free to pull this in here or if you prefer I’ll open a seperate PR after this one is merged.

> i too was planning to add this and other undocumented MRFs soon Here are the updates, most configurable MRFs already had at least their options documented even if their full name wasn’t listed in the `policies` list. Includes some refactoring for readability and dropping leftovers from a removed MRF: https://akkoma.dev/Oneric/akkoma/commits/branch/doc_mrfs Since this is on top of the changes from this PR, it’s not possible/doesn’t make sense to open a seperate PR; feel free to pull this in here or if you prefer I’ll open a seperate PR after this one is merged.

DirectMessageDisabledPolicy isn't really configurable, it's just there because MRF turned out to be the nicest place to implement that particular functionality - it's hardcoded to always run, so i'm not sure it's worth documenting there

DirectMessageDisabledPolicy isn't really configurable, it's just there because MRF turned out to be the nicest place to implement that particular functionality - it's hardcoded to always run, so i'm not sure it's worth documenting there
floatingghost reviewed 2024-02-19 14:03:51 +00:00
floatingghost left a comment
Owner

pretty ok, i'd agree with the above that it's worth noting that the time we first encounter an account is taken to be the "created" time

pretty ok, i'd agree with the above that it's worth noting that the time we first encounter an account is taken to be the "created" time
@ -225,1 +226,4 @@
#### :mrf_reject_newly_created_account_notes
Rejects posts of users, whose accounts are more recent than the configured time (in seconds).
Only drops posts. Follows, reposts, etc. are not effected.

spelling, "affected"

spelling, "affected"
YokaiRick marked this conversation as resolved
Member

DirectMessageDisabledPolicy isn't really configurable, it's just there because MRF turned out to be the nicest place to implement that particular functionality

aye, I noticed while preparing the doc updates. However, apart from some incomplete documentetion NoEmptyPolicy and NoPlaceholderPolicy turned out to be entirely undocmented (and not hardcoded). Regarding:

it's hardcoded to always run, so i'm not sure it's worth documenting there

Other hardcoded MRFs NormalizeMarkup and InlineQuotePolicy are also already documented — currently without configuration. But to my surprise both of them are actually configurable (and docs are added by the linked branch).

> DirectMessageDisabledPolicy isn't really configurable, it's just there because MRF turned out to be the nicest place to implement that particular functionality aye, I noticed while preparing the doc updates. However, apart from some incomplete documentetion `NoEmptyPolicy` and `NoPlaceholderPolicy` turned out to be entirely undocmented (and not hardcoded). Regarding: > it's hardcoded to always run, so i'm not sure it's worth documenting there Other hardcoded MRFs `NormalizeMarkup` and `InlineQuotePolicy` are also already documented — currently without configuration. But to my surprise *both* of them are actually configurable *(and docs are added by the linked branch)*.
YokaiRick added 9 commits 2024-02-19 22:20:57 +00:00
1640d19448 doc/cheatsheet: move :activitypub section ahead
Else it is too easy to mistake for another MRF policy.
8e7a89605d doc/cheatsheet: move MRF policies key to end of section
This makes it easier to spot the transparency options
da4190c46e doc/cheatsheet: split out always active MRFs
It doesn’t make sense to add/remove them from the policies list
f254e4f530 doc/cheatsheet: add missing MRF config detail docs
And remove “on by default” text from individual entries.
They are now laready in the “on by default” section.
9830d54fa1 doc/cheatsheet: sort main MRF list alphabetically
It is too cumbersome to find a specific policy atm
or to check if all are docuemtned yet.
Trivial placeholder policies are excluded from this.
ci/woodpecker/pr/build-amd64 Pipeline is pending Details
ci/woodpecker/pr/build-arm64 Pipeline is pending Details
ci/woodpecker/pr/docs Pipeline is pending Details
ci/woodpecker/pr/lint Pipeline is pending Details
ci/woodpecker/pr/test Pipeline is pending Details
41dd37d796
doc/cheatsheet: add missing MRFs
Or mentions of MRFs in the main list
whose options were already documented.
Author
Contributor

pretty ok, i'd agree with the above that it's worth noting that the time we first encounter an account is taken to be the "created" time

edit oneric already did that. thanks :3

> pretty ok, i'd agree with the above that it's worth noting that the time we first encounter an account is taken to be the "created" time **edit** oneric already did that. thanks :3
YokaiRick added 1 commit 2024-02-19 22:33:10 +00:00
ci/woodpecker/pr/lint Pipeline was successful Details
ci/woodpecker/pr/test Pipeline failed Details
ci/woodpecker/pr/build-arm64 unknown status Details
ci/woodpecker/pr/build-amd64 unknown status Details
ci/woodpecker/pr/docs unknown status Details
c25cfe9b7a
fixed spelling

:nod: thanks to the both of you!

:nod: thanks to the both of you!
floatingghost merged commit 967e6b8ade into develop 2024-02-24 04:31:28 +00:00
floatingghost deleted branch doc_mrf_reject_acc_notes 2024-02-24 04:31:29 +00:00
Sign in to join this conversation.
No description provided.