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

Validate against and attempt fixing of incorrectly formatted HTML5 ZIPs #4013

Closed
bjester opened this issue Apr 6, 2023 · 0 comments · Fixed by #4867
Closed

Validate against and attempt fixing of incorrectly formatted HTML5 ZIPs #4013

bjester opened this issue Apr 6, 2023 · 0 comments · Fixed by #4867
Assignees
Labels
design: todo Scoped and ready for design work to begin DEV: frontend P1 - important Priority: High impact on UX TAG: new feature

Comments

@bjester
Copy link
Member

bjester commented Apr 6, 2023

Background

Kolibri's HTML5 ZIPs need to be formatted a certain way, with an index.html file at the root of the ZIP, in order to render it. This can cause confusion for users who use consumer tools to create a ZIP file, which usually adds a parent directory within the ZIP.

Desired behavior

  • Studio should validate that the ZIP file is formatted correctly with an index.html file at the root of the ZIP at upload
  • If there isn't an index.html file at the root of the ZIP, but there is a single folder at the root which does, we should attempt to fix it by unzipping and re-zipping it
  • Otherwise, it should make the node incomplete when the file isn't correct and show the appropriate feedback to the user regarding the issue.

Current behavior

No validation exists, but the preview does mention that it is missing the index.html

Value add

Validation at time of upload will avoid headaches for users who go through the process of curating content, publishing a channel, importing it into Kolibri, only to find that the file doesn't work.
https://community.learningequality.org/t/kolibre-index-for-html/2783

@bjester bjester added P1 - important Priority: High impact on UX TAG: new feature DEV: frontend design: todo Scoped and ready for design work to begin labels Apr 6, 2023
@bjester bjester changed the title Validate HTML5 ZIPs are formatted correctly at upload Validate against and attempt fixing of incorrectly formatted HTML5 ZIPs Nov 21, 2024
@rtibbles rtibbles self-assigned this Dec 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
design: todo Scoped and ready for design work to begin DEV: frontend P1 - important Priority: High impact on UX TAG: new feature
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants