Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Create a ZIM with all versions of a given project

Đang mở
  • Có gì không ổn?
#42 3 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
25/100
Loại issue
Tính năng
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Công nghệ
python
Lĩnh vực
backend, frontend, search

Hướng nghiên cứu

Bắt đầu với điểm vào của scraper xử lý tham số CSV --slug và việc tạo ZIM, sau đó lần theo các luồng UI và tìm kiếm được mô tả trong issue. Để hoàn tất, cần có một tùy chọn theo kiểu --oneSingleZim, hỗ trợ nhiều slug trong một ZIM, chuyển đổi phiên bản trong UI và hành vi tìm kiếm hoạt động trên các project được nhúng.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

enhancement

Currently, it is only possible to create one ZIM per slug. E.g. one for one for lua5.4, one for lua5.3, one for lua~5.2 and so on.

Analyzing a bit devdocs, it showed this means we will create 716 ZIMs, with new ZIMs coming at every release of projects (lua, ...).

This is way too much, and this is not really convenient for the end-user who typically know he needs documentation of a given programming language, but usually need documentation for multiple versions.

We would like the scraper to be able to embed all versions of a given project (e.g. lua) in a single ZIM. This obviously means significant changes to the codebase, both in terms of ZIM structure (to accommodate to multiple slugs in one ZIM) but also in terms of UI (to be able to switch from one slug to the next one).

It probably also means that something needs to be done to provide custom search capabilities directly in the UI: currently suggestions and full-text search are already hard to use, but it will become even harder if we have multiple slugs in one ZIM. Or maybe this means we need to enrich the search capabilities of the libzim (e.g. ask the libzim to search only in a subset of articles ...).

To make the feature as generic as possible, I think that we should continue to use the CSV --slug parameter to specify all slugs that we want to embed, and add a --oneSingleZim (or something like this, I'm bad at choosing names) parameter to indicate we want all slugs in a single ZIM file. With this approach, it means we have lot's of flexibilities, and we can for instance embed all Vue (Vue, VueRouter, Vuex, ...) in a single ZIM file even if they are distinct project son DevDocs side. Or we can even create a "all DevDocs" ZIM with all documentation.

Ngôn ngữ chính
Python
Star
9
Fork
3
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Chúng tôi chưa kiểm tra các tệp thiết lập môi trường của dự án này. Hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của openzim/devdocs

Tất cả issue của openzim/devdocs

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.