Keep track of recipe's changes

[kelson42]

For the moment, we don't really keep track of changes on recipes (or this is not visible for end-users). We don't have any "audit trail". This has two major consequences:

• The transparency about who, when, why, what is not secured
• Considering that this is a tool which is a bit technical, there is no way to learn from the changes that other users made.

It would be great to have a kind of revision log (like on Mediawiki).

Keeping track of each revision in json format and having a diff display between revisions would be really helpful.

I'm in favour as well to keep a big more information about each revision like:

• Comment about the revision (optional)
• Author of the revision
• Date
• What has been done

[rgaudin]

Would the comment be mandatory? I'd advise not to.

[kelson42]

Would the comment be mandatory? I'd advise not to.

Yes, but might help to explain why things have been done. Not always obvious.

[rgaudin]

OK, can't wait to see your ticket asking to make it not-mandatory 😀

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be now be reviewed manually. Thank you for your contributions.

[kelson42]

A system working in a similar manner like the Gandi DNS zone revision system would be fine.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be now be reviewed manually. Thank you for your contributions.

[kelson42]

I think this ticket start to be really super urgent because:

• We are more and more people editing in the Zimfarm
• Rules are complext and learning curve is long
• We need more visibility on who does what to be able to better control/fix/learn

We need IMO this very same feature on the CMS.

In term of architecture I would:

• Each time a modification is made we should save in addition the username + comment (mandatory)
• Save full JSON (compressed) of new version of each recipe in a dedicated table
• Display a new tab "History" on recipes allowing to make a diff
• We need a global "recent change" system (a feed on it would be even better.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be now be reviewed manually. Thank you for your contributions.