docs: Prepare docs for fileupload editor #1524
Conversation
github-actions
bot
added
the
t-console
|
See apify/apify-shared-js#509 for the final name of the editor |
We want to add file upload to the input schema, decided to go with url on the input. Seems like a good idea to just use a special editor for this, instead of adding a new input type. The default fallback editor should work reasonably well everywhere. ### Related PRs: - apify/apify-docs#1524
valekjo
changed the title
| Example of file selection using `fileupload` editor. The input is passed to the Actor as a string, it is up to the author to resolve the file or validate if it exists. | ||
|
|
||
|  | ||
|
|
||
|
|
||
| The input allows the user to either provide a link or to upload the file as a record to a key-value store of their choosing. | ||
|
|
||
|  | ||
|
|
||
|
|
There was a problem hiding this comment.
| Example of file selection using `fileupload` editor. The input is passed to the Actor as a string, it is up to the author to resolve the file or validate if it exists. | |
|  | |
| The input allows the user to either provide a link or to upload the file as a record to a key-value store of their choosing. | |
|  | |
| The `fileupload` editor enables users to specify a file as input. The input is passed to the Actor as a string. It is the author's responsibility to interpret this string, including validation of its existence and format. | |
|  | |
| It could be a URL or a key-value store record identifier and manage the file content. | |
|  |
There was a problem hiding this comment.
Thanks!
I'm not sure about this phrase:
It could be a URL or a key-value store record identifier and manage the file content.
I was trying to explain that the UI makes it easier for users to upload a file to a key-value store, and that they can choose an existing store, or create a new one.
There was a problem hiding this comment.
Hmm, yeah I might have went a little overboard with this one, and create more confusion where it wasn't needed.
Let's go with something closer to original just slightly rephrased to avoid words like lets
The user provides either a URL or uploads the file to a key-value store (existing or new)."
| @@ -223,11 +223,19 @@ The `anyDate` property renders a date picker that accepts both absolute and rela | |||
|
|
|||
|  | |||
|
|
|||
| The `fileupload` editor enables users to specify a file as input. The input is passed to the Actor as a string. It is the author's responsibility to interpret this string, including validation of its existence and format. | |||
There was a problem hiding this comment.
Just a question to clarify, does this mean Actor's author? or the Actor user? Reading it back now it's not entirely clear, maybe there is a better wording for this as well
There was a problem hiding this comment.
It's easier for Actor user to provide a link to a file.
The Actor's author needs to deal with a string, that 🤞 , should be a link to a file. But it's the author's responsibility to check this (and handle the case when it's not).
Does that make sense?
This PR should be merged once the feature is in Apify Console.
Related PRs