Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: updated notes on snapshot generation #67

Merged
merged 2 commits into from
Feb 7, 2020
Merged

Conversation

lidel
Copy link
Member

@lidel lidel commented Jan 20, 2020

This PR includes docs and scripts updates necessary for updating TR snapshot.

Work in progress, do not merge yet.

TODO

  • use updated extract_zim tool
  • switch to CIDv1
  • document how to find and set landing page
    • tools/find_main_page_name.sh:
      Every Wikipedia version uses different name of the main page,
      this scripts takes language code and returns the filename
    • tools/find_original_main_page_url.sh:
      Landing pages shipping with ZIM file are either truncated or
      Kiwix-specific.
      This script finds the URL of original version of the langing page
      mathing the timestamp of snapshot in unpacked ZIM directory

- use updated extract_zim tool
- switch to CIDv1
- add note about broken execute-changes.sh

License: MIT
Signed-off-by: Marcin Rataj <[email protected]>
tools/find_main_page_name.sh:
 Every Wikipedia version uses different name of the main page,
 this scripts takes language code and returns the filename

tools/find_original_main_page_url.sh:
 Landing pages shipping with ZIM file are either truncated or
 Kiwix-specific.
 This script finds the URL of original version of the langing page
 mathing the timestamp of snapshot in unpacked ZIM directory

License: MIT
Signed-off-by: Marcin Rataj <[email protected]>
@lidel lidel marked this pull request as ready for review February 7, 2020 12:37
@lidel
Copy link
Member Author

lidel commented Feb 7, 2020

Sadly I had no bandwidth to push this further, but this PR has useful README updates so I am merging this as-is.

Remaining work is documented at #64

@lidel lidel changed the title fix: TR snapshot generation scripts and docs docs: updated notes on snapshot generation Feb 7, 2020
@lidel lidel merged commit 918d684 into master Feb 7, 2020
@lidel lidel deleted the fix/build-q1-2020 branch February 7, 2020 12:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant