docs: file detection using first few bytes disabled on S3 direct upload #11035
Conversation
This file contains 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
landreev
reviewed
Nov 19, 2024
| @@ -3617,6 +3617,7 @@ The fully expanded example above (without environment variables) looks like this | |||
| Currently the following methods are used to detect file types: | |||
| - The file type detected by the browser (or sent via API). | |||
| - Custom code that reads the first few bytes. As explained at :ref:`s3-direct-upload-features-disabled`, this code is disabled during direct upload to S3. However, this code is active when the "redetect" API is used. | |||
There was a problem hiding this comment.
I agree it's a good idea to spell this out in the guide; especially if it has been a source of confusion.
But, somewhat of a nitpick - I'm wondering if there's a better way to say this than "this code is disabled". Something along the lines of
"... this method of file type detection is not utilized during direct upload to S3, since by nature of direct upload Dataverse never sees the contents of the file."
Your call. I just feel like, technically, it is more like "does not apply" or "cannot be used" than "disabled".
There was a problem hiding this comment.
Please also note that the above applies to the next line, JHOVE as well.
pdurbin
commented
Nov 19, 2024
pdurbin
commented
Nov 19, 2024
pdurbin
commented
Nov 19, 2024
Co-authored-by: Philip Durbin <[email protected]>
Co-authored-by: Philip Durbin <[email protected]>
Co-authored-by: Philip Durbin <[email protected]>
pdurbin
commented
Nov 19, 2024
landreev
approved these changes
Nov 19, 2024
|
Proof read, merging PR |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Preview doc changes here:
What this PR does / why we need it:
There is confusion about file detection when using S3. See recent discussion between @bseeger and @shlake :