Skip to content

Ticket Lifecycle (Zimit)

Jump to bottom
RavanJAltaie edited this page Mar 8, 2023 · 3 revisions

To create a new recipe for Zimit

**It’s better to clone an existing Zimit recipe. ** You can find previous Zimit recipes here (Offliner column)

  • Create the recipe name as per the naming instructions here.
  • In the Language space, choose the language of the website you are creating the recipe for.
  • From Category space, choose (Other).
  • From warehouse path space, choose (/.hidden/.dev) always as a first time in order to test the resulting file, if the file is tested and all is correct then you update the recipe with the proper path (Zimit).
  • You can choose Periodicity to be monthly or quarterly.
  • In Offliner space choose: Zimit.
  • In platform space choose None.
  • Keep the rest the same with no change.

In Zimit command flags:

  • Replace Wiki URL: https://xxx with the URL for the website you want to submit, e.g. https://journals.openedition.org/bibnum/ .
  • In Name: type the file name as per the naming rules here.
  • In Language: type the 3-letter code for the target website.
  • In Title: type the name you want your output file to be titled.
  • In Description: type a short description of your required zim file.
  • In Illustration: Place the link of the required logo of your zim file.
  • Leave the rest of the fields empty or as it is (cloned from old recipe).
  • Finally, click in the bottom on [Update offliner details] and make sure that [Status] is set to enabled.
  • Review all your entries once again, then go back to the top of the page and click on (Request).
  • After about an hour, check the recipe if it failed or succeeded (or the next day if the source website is large).
  • If successful, go to this link (https://dev.library.kiwix.org/) and check your created file; check the file size (anything in KB or low MB has probably failed) and check if the file is working properly.
  • If the file looks good and complete, go back to your recipe, In warehouse path space, change [/.hidden/.dev] to [Zimit].
  • Click on Update offliner details and then click on Request again.
  • Finally, check the file at (https://library.kiwix.org/ ). If all is good, do not forget to go back to the initial ticket (most likely at zim-requests) and put the link of the output file and close the ticket.
Clone this wiki locally