Feat 151 Document-based export#196
Draft
melolw wants to merge 4 commits into
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This feature adds a way to export all (for now, filtering will be possible later) of the documents part of a project with the relevant files using the streaming download introduced with Feat #68 .
The exported ZIP only contains documents owned by users that did agree to data sharing, it follows this structure:
{exportName}/
{docHash}/
document_data.json (all types)
document.pdf (type 0 - PDF)
annotations.json (type 0 - PDF)
comments.json (type 0 - PDF, includes votes)
edits.json (type 1/2 - HTML/Modal)
html.html (type 1/2 - HTML/Modal)
text.txt (type 1/2 - HTML/Modal)
document.zip (type 4 - ZIP)
In the frontend, "export documents" was added, with a simple next step stating that all documents will be downloaded.
In the backend, a new case was added in the export route to handle documents.