Event-Federation/documentation
7
1
Fork 0
Code Issues 2 Pull requests Projects Releases Wiki Activity

fix toc

Browse source
This commit is contained in:
André Menrath 2023-10-05 14:33:17 +02:00
parent 4c22305ead
commit 464534f8a3
1 changed files with 4 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
architecture design proposal.md
View file

@ -149,9 +149,7 @@ interface Transformer {
Use WordPress's hook system or a public API function to let other plugins register their custom transformer implementations to the ActivityPub plugin. Use WordPress's hook system or a public API function to let other plugins register their custom transformer implementations to the ActivityPub plugin.
### Problem **Problem:** With the design above the transformer does a lot and leaves a lot of responsibility to the developer implementing it.
With the design above the transformer does a lot and leaves a lot of responsibility to the developer implementing it.
Possible alternatives and solutions: Possible alternatives and solutions:
- The ActivityPub plugin could provide reusable Traits for common tasks. - The ActivityPub plugin could provide reusable Traits for common tasks.
@ -199,8 +197,7 @@ The specifications allow for a lot of flexibility in their use. As WordPress web
Other WordPress actor types might have valid use cases, like actors for categories, or specific post types in general: "I only want to see the blog updates, but I do not want to spam my timeline with each product they post on their site, even if they choose to federate them." Other WordPress actor types might have valid use cases, like actors for categories, or specific post types in general: "I only want to see the blog updates, but I do not want to spam my timeline with each product they post on their site, even if they choose to federate them."
### Problems **Problems:**
- Overall complexity may lead to programming and usage errors. - Overall complexity may lead to programming and usage errors.
- Naming collisions become more likely. See below. - Naming collisions become more likely. See below.
- Who is the `actor`, who is the `attributedTo`, who is just sending an `Announce` of a post? - Who is the `actor`, who is the `attributedTo`, who is just sending an `Announce` of a post?
@ -209,7 +206,7 @@ Other WordPress actor types might have valid use cases, like actors for categori
We keep in mind that every post type shall only ever send as a `Create` Activity once by one single actor. We keep in mind that every post type shall only ever send as a `Create` Activity once by one single actor.
### User Interface **User Interface:**
| | users | tribe_organizers | custom | blog | category | | | users | tribe_organizers | custom | blog | category |
| -----------------|:-----:|:----------------:|:------:|:-----:|:--------:| | -----------------|:-----:|:----------------:|:------:|:-----:|:--------:|
| **post** | C | O | O | A | A | | **post** | C | O | O | A | A |
@ -255,7 +252,7 @@ Anyway it seems the question has to be raised wheter activitypub should store a
- Additionally, shouldn't the user have a detailed overview in each case if the actor management should get more complex? - Additionally, shouldn't the user have a detailed overview in each case if the actor management should get more complex?
### Proposal of how plugins register WordPress-actor types ## Proposal of how plugins register WordPress-actor types
TODO: This gives no information of how posts get dispatched to which actor. TODO: This gives no information of how posts get dispatched to which actor.
```php ```php