openzim / nautilus

Turns a collection of documents into a browsable ZIM file
GNU General Public License v3.0
19 stars 14 forks source link

ZIM `Description` should be mandatory #46

Closed kelson42 closed 1 year ago

kelson42 commented 1 year ago

Look at https://wiki.openzim.org/wiki/Metadata

LongDescription should be configurable as well

Would be great to check the max size for both.

ankur12-1610 commented 1 year ago

Hey @kelson42 I would like to work on this one :)

rgaudin commented 1 year ago

@ankur12-1610 please do. Note that issue title was incorrect. It should be required from user.

KrishnaRishi2208 commented 1 year ago

I am working on this one. Pretty easy though.

ankur12-1610 commented 1 year ago

I am working on this one. Pretty easy though.

Ah! sorry @KrishnaRishi2208 I am already working on this one :sweat_smile:

KrishnaRishi2208 commented 1 year ago

I am working on this one. Pretty easy though.

Ah! sorry @KrishnaRishi2208 I am already working on this one sweat_smile

Wait, so I cant work on this one?? I am sorry, I didn't know that once a task is assigned to someone, we are not supposed to work on it.

Will remember next time.

Thanks for informing me.

rgaudin commented 1 year ago

Yes, that's what the assignee field is for. If someone's already assigned, skip it or ask if it's been a long time.

Onyx2406 commented 1 year ago

hey, can I solve this? I have already worked on a similar issue in zim-tools.

rgaudin commented 1 year ago

@Onyx2406, let's give a couple days to @ankur12-1610 who already has started a PR. If not, we'll close and reassign as this is really a trivial thing. Please note that it should leverage scraperlib

snehalchaudhari98 commented 1 year ago

Hi @rgaudin, I am also interested in working on this issue. If this issue opens up again with no assignee, I would love to contribute.

rgaudin commented 1 year ago

@Onyx2406 this is now assigned to you.

nithinkatta commented 1 year ago

Hey hi I would like to solve this if @Onyx2406 couldn't.

rgaudin commented 1 year ago

No feedback in 5days… @Onyx2406 this task is now assigned to @nithinkatta

KrishnaRishi2208 commented 1 year ago

@rgaudin I tried to solve it when the problem was posted . But since the task was assigned to someone else, I stopped the work in middle. Could you please assign it to me next in case it doesn't work out with the others.

Thank you

KrishnaRishi2208 commented 1 year ago

@rgaudin If there is no response from @nithinkatta , I would love to solve this issue.

nithinkatta commented 1 year ago

Hi, I'm actually new to this open-source contribution stuff and enthusiastic about GSOC 2023, can you help me out how to approach this problem so that i will solve the issue by my python coding skills.

KrishnaRishi2208 commented 1 year ago

Hi, I'm actually new to this open-source contribution stuff and enthusiastic about GSOC 2023, can you help me out how to approach this problem so that i will solve the issue by my python coding skills.

You have to first locally download Nautilus python package and make changes to the Nautilus library so that the description will now be mandatory and also you have to add the option for long description.

rgaudin commented 1 year ago

I've unassigned the issue. Those interested can can submit PR directly.

Don't work on it If you're worried you may waste your time because someone could submit a correct PR first.

KrishnaRishi2208 commented 1 year ago

@rgaudin I have made changes to the entrypoint.py file , scraper.py file, init.js file to include the above functionality. I also had to change the filesystem.py file in zimscraperlib/zim to support longdescription while making the zim file. I achieved the functionality and solved the issue, but it wont work unless zimscraperlib/zim/filesystem.py file is changed. Could you please guide me on what to do next.

rgaudin commented 1 year ago

I'll release scraperlib tomorrow

KrishnaRishi2208 commented 1 year ago

I'll release scraperlib tomorrow

Great, I have created a PR. Please review it. Thank you