Difference between revisions of "Content team"

Jump to navigation Jump to search
Fix formatting of recipe periodicity
(Add draft proposal on recipe periodicity)
(Fix formatting of recipe periodicity)
 
Line 141: Line 141:
# Click on Update offliner details and then click on Request again.
# Click on Update offliner details and then click on Request again.
# Finally, check the file in [https://library.kiwix.org/ Kiwix Content Library]. If all is good, do not forget to go back to [https://github.com/openzim/zim-requests/issues the initial ticket] and put the link of the output file and close the ticket.
# Finally, check the file in [https://library.kiwix.org/ Kiwix Content Library]. If all is good, do not forget to go back to [https://github.com/openzim/zim-requests/issues the initial ticket] and put the link of the output file and close the ticket.
==== Choose proper recipe periodicity (DRAFT PROPOSAL) ====
==== Choose proper recipe periodicity ====
'''''This is a draft proposal'''''
 
When we configure a recipe on the Zimfarm, we have to decide on the periodicity at which the recipe will be ran.
When we configure a recipe on the Zimfarm, we have to decide on the periodicity at which the recipe will be ran.


Following rules should be followed, unless justified by an exception:
Following rules should be followed, unless justified by an exception:


- by default, the periodicity is quarterly
* by default, the periodicity is quarterly
 
* recipes linked to content which is very regularly updated might switch to monthly updates ; this is typically the case for all recipes linked to Wikimedia wikis
- recipes linked to content which is very regularly updated might switch to monthly updates ; this is typically the case for all recipes linked to Wikimedia wikis
* recipes known to take a lot of time to complete / consume much resources / be linked to content not regularly updated should be switched to bi-annually or annually periodicity (at the discretion of recipe maintainer)
 
* recipes in DEV (pushing to /.hidden/dev) have a manual periodicity:
- recipes known to take a lot of time to complete / consume much resources / be linked to content not regularly updated should be switched to bi-annually or annually periodicity (at the discretion of recipe maintainer)
** the person setting up the recipe will take care of updating the ZIM when needed, having a manual process helps to avoid side-effects during testing by not all testing the same ZIM
 
** we aim to put the time during which a recipe is in DEV to a minimum
- recipes in DEV (pushing to /.hidden/dev) have a manual periodicity:
** we have too many recipe in DEV which are failing and not yet disabled, if the update is automated it will continuously waste resources
 
* recipes building ZIMs for a specific customer have a manual periodicity by default, unless we have a clear maintenance contract paying us to update ZIMs at a given interval, or unless the ZIM in question is of general interest (but then we usually do not consider this ZIM to be linked to a specific customer)
- the person setting up the recipe will take care of updating the ZIM when needed, having a manual process helps to avoid side-effects during testing by not all testing the same ZIM
 
- we aim to put the time during which a recipe is in DEV to a minimum
 
- we have too many recipe in DEV which are failing and not yet disabled, if the update is automated it will continuously waste resources
 
- recipes building ZIMs for a specific customer have a manual periodicity by default, unless we have a clear maintenance contract paying us to update ZIMs at a given interval, or unless the ZIM in question is of general interest (but then we usually do not consider this ZIM to be linked to a specific customer)


==== Change a recipe/ZIM warehouse path and/or a ZIM name ====
==== Change a recipe/ZIM warehouse path and/or a ZIM name ====
50

edits

Navigation menu