Add documentation on how to write a RecordBuilder

[diosmosis]

Description:

As title.

Review

• Functional review done
• Potential edge cases thought about (behavior of the code with strange input, with strange internal state or possible interactions with other Matomo subsystems)
• Usability review done (is anything maybe unclear or think about anything that would cause people to reach out to support)
• Security review done
• Wording review done
• Code review done
• Tests were added if useful/possible
• Reviewed for breaking changes
• Developer changelog updated if needed
• Documentation added if needed
• Existing documentation updated if needed

[michalkleiner]

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

[tsteur]

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

[michalkleiner]

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

[AltamashShaikh]

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

[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?

[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 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]

@diosmosis @michalkleiner Can we please merge this ??

[michalkleiner]

Is this still unstable or is this now the default and we can remove this warning?

[diosmosis]

that is up to the core team. feel free to change it yourself when your team decides the answer to that.

[michalkleiner]

I think this can probably be merged, just posted two questions.

[AltamashShaikh]

I think this can probably be merged, just posted two questions.

@michalkleiner should we merge this now ??

[michalkleiner]

@matomo-org/core-reviewers what do we think? Mainly on the stability aspect.