developer-documentation icon indicating copy to clipboard operation
developer-documentation copied to clipboard

Add documentation on how to write a RecordBuilder

Open diosmosis opened this issue 2 years ago • 10 comments

Description:

As title.

Review

diosmosis avatar Jun 16 '23 20:06 diosmosis

Reading well, thanks! Will read it again but definitely a helpful piece of new docs! :)

michalkleiner avatar Jun 18 '23 14:06 michalkleiner

Can this be merged @matomo-org/core-reviewers ?

tsteur avatar Dec 21 '23 19:12 tsteur

We may need to do a one final sweep but probably very close to being able to merge this.

michalkleiner avatar Dec 22 '23 03:12 michalkleiner

@matomo-org/core-reviewers We should merge this, as this will be helpful for other devs wanting to use Recordbuilders

AltamashShaikh avatar Apr 30 '24 05:04 AltamashShaikh

We probably still need to decide within the core team whether it covers what it needs to cover and maybe remove the unstable information at the top if we deem it stable. But since things run just fine since Matomo 5 around archiving and we haven't seen any significant issues related to archiving it might just be fine as is.

Have you followed the docs and try to create a new record builder, @AltamashShaikh?

michalkleiner avatar Apr 30 '24 05:04 michalkleiner

We probably still need to decide within the core team whether it covers what it needs to cover and maybe remove the unstable information at the top if we deem it stable. But since things run just fine since Matomo 5 around archiving and we haven't seen any significant issues related to archiving it might just be fine as is.

Have you followed the docs and try to create a new record builder, @AltamashShaikh?

@michalkleiner While developing something for AbTesting, I tried looking for a doc but couldn't find anything and I looked different plugins and completed my change, but reading the doc I can confirm the steps mentioned looks correct and would help if someone wants to use RecordBuilder.

AltamashShaikh avatar Apr 30 '24 05:04 AltamashShaikh