Openfoodnetwork: [Cookies] Document technical choices in wiki

[myriamboure]

Create some documentation around the matomo config we are doing right now. In the wiki probably best place (to check).

[luisramos0]

Hi @myriamboure I am sorry but I cant recall what was this issue for.
Is this related to creating documentation around best practices like this?https://github.com/openfoodfoundation/openfoodnetwork/wiki/Code,-the-way-we-do-things

[myriamboure]

@luisramos0 from my understanding it was to check if there needs to be any wiki update linked to the new feature, so you will for instance add a page on Matomo configuration maybe for new instances who join the OFN and want to get their data analysis? Also I think from the discussion we had with @Matt-Yorkley for product import he was talking about adding some class documentation comments... I have another issue to do the same on user guide and superadmin handbooks which are more "product oriented", so yours is more about tech documentation. @mkllnk if you see more precisely what documentation should be added on the tech side please let us know.

[luisramos0]

ok!
thanks for reminding me that I should create some documentation around the matomo config we are doing right now! I'll add that to my todo list re matomo config issue.

[mkllnk]

On the ofn-install project we often add a checklist of wiki changes to each pull request. That is very helpful. Maybe we should add that to our pull request template.

[mkllnk]

Okay, I updated the issue and pull request templates.

[daniellemoorhead]

@myriamboure @luisramos0 can we close this issue? Did you already do this documentation Luis?

[myriamboure]

I don't think so @daniellemoorhead this remain to be done from my understanding.

[luisramos0]

Here's the wiki page for the matomo integration docs:
https://github.com/openfoodfoundation/openfoodnetwork/wiki/Matomo-Integration

I think this is enough. What do you think?

Moving issue to test ready.

[mkllnk]

I thought the issue was more about why you did certain implementation decisions. But I'm happy with it. Should there be something in the user guide?

[luisramos0]

Yeah, this is more of a user guide, isnt it?
I dont think we need any technical documentation here. It's all rather straight forward.

[myriamboure]

I guess what you wrote @luisramos0 yes is more for a super-admin handbook, how to setup matomo in OFN, and how to configurate it to get usefull data (which I have not yet understood, will be next step I guess!). So it's more on my task when all the other last bits of implementation are done. I too the content of your suggestion Luis as a base. So if no need for more technical implementation documentation for next devs to understand what was done, we can close that. I let you judge on that, I'm not reading the tech documentations ;-)

[daniellemoorhead]

So if no need for more technical implementation documentation for next devs to understand what was done, we can close that. I let you judge on that, I'm not reading the tech documentations ;-)

Given the above comment by @myriamboure can this be closed @luisramos0?

[luisramos0]

yes, I think we can close, I dont think there's much tech details I can add here.