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

Should we rename the scraper / repo #6

Open
benoit74 opened this issue Oct 1, 2024 · 3 comments
Open

Should we rename the scraper / repo #6

benoit74 opened this issue Oct 1, 2024 · 3 comments
Assignees
Labels
question Further information is requested
Milestone

Comments

@benoit74
Copy link
Contributor

benoit74 commented Oct 1, 2024

While this repo was originally targeted at making ZIMs for libretext, it is now clear that:

  • libretexts is in fact based on Mindtouch (formerly DekiWiki, a fork of MediaWiki, now rebranded Nice CXOne Expert)
  • the scraper seems to move in a direction where it would probably easily support any Mindtouch instance (small adapations might be necessary, but the move seems ongoing)

This is not something to answer now, but probably before first release.

@benoit74 benoit74 added the question Further information is requested label Oct 1, 2024
@benoit74 benoit74 self-assigned this Oct 1, 2024
@benoit74 benoit74 added this to the 0.1 milestone Oct 1, 2024
@kelson42
Copy link

kelson42 commented Oct 1, 2024

Agree, the sooner the better (think about code types and variable names).

@benoit74
Copy link
Contributor Author

While developing, it is becoming quite obvious that there is probably some particularities around libretexts implementation, or at least areas where it is doubtful it will be "like this" on all mindtouch instances.

Since we do not have another mindtouch instance for testing, and do not have the adequate resources

I however recommend to still rename the scraper asap, keeping a warning on front page that this scraper has for now been tested only on one mindtouch instance and might probably have some rough edges to fix when moving to another one.

The reason is that:

  • these rough edges seems feasible to overcome
  • keeping libretexts name would not allow to "advertise" clearly we might have almost working support of any mindtouch instance
  • probably 80% of the code needing to scraper any mindtouch instance will be already done
  • should we move to mindtouch later-on, it means that we have too much to clean-up: code + docker repo + pypi + zimfarm + ...

@kelson42 @rgaudin are you ok with this move? Shall we use mindtouch as name, which is both nicer and easier to spell than nicecxoneexpert?

@rgaudin
Copy link
Member

rgaudin commented Oct 10, 2024

LGTM ; I have no opinion on the name to use though

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

3 participants