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

Add file upload instructions to file browser UI #1342

Merged
merged 4 commits into from
Nov 29, 2022

Conversation

mvandenburgh
Copy link
Member

@mvandenburgh mvandenburgh commented Oct 24, 2022

Closes #732
Closes #731
Screenshot from 2022-10-24 14-01-28

@mvandenburgh mvandenburgh force-pushed the file-upload-instructions branch 3 times, most recently from f5b7287 to 90eab19 Compare October 24, 2022 17:51
Copy link
Member

@waxlamp waxlamp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you can fix the typing issue, that would be good to include here. Otherwise, because this is a PR to non-master branch, I'm fine with you merging it pending a bigger review of that branch when it goes to master.

import { useDandisetStore } from '@/stores/dandiset';

const store = useDandisetStore();
const dandisetIdentifier = computed(() => store.dandiset?.dandiset.identifier);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's a small typing problem here. dandisetIdentifier has type string | undefined but you're assuming it's defined at the point of use in the template.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed 5c98f19

@danlamanna
Copy link
Contributor

To avoid the installation instruction versions becoming stale, should we link to https://www.dandiarchive.org/handbook/10_using_dandi/#dandi-python-client instead?

@mvandenburgh
Copy link
Member Author

To avoid the installation instruction versions becoming stale, should we link to dandiarchive.org/handbook/10_using_dandi/#dandi-python-client instead?

Good idea, I think that makes more sense. I added that link and a link to the file upload instructions.

@waxlamp
Copy link
Member

waxlamp commented Nov 17, 2022

To avoid the installation instruction versions becoming stale, should we link to dandiarchive.org/handbook/10_using_dandi/#dandi-python-client instead?

Good idea, I think that makes more sense. I added that link and a link to the file upload instructions.

I think it's better to have the instructions listed explicitly, rather than kick the user over to the full instructions. I understand there's a risk of things going out of sync, but also the dandi CLI calling conventions are not likely to change very much.

I do think adding a link to the docs alongside the customized command sequence for the given dandiset would be a good idea.

@danlamanna
Copy link
Contributor

I think it's better to have the instructions listed explicitly, rather than kick the user over to the full instructions. I understand there's a risk of things going out of sync, but also the dandi CLI calling conventions are not likely to change very much.

I was only referring to the second block which specifies py37 and dandi>0.13.0. I agree that the first block is unlikely to change.

@mvandenburgh
Copy link
Member Author

Updated to only change the text about installing the CLI.

@satra
Copy link
Member

satra commented Nov 17, 2022

@waxlamp and @mvandenburgh - given this is a web app, how about we create the text that it reads in some location separate from the web app, and it can pull the info, which we can update async from development of the app.

btw, i love this feature.

@waxlamp
Copy link
Member

waxlamp commented Nov 17, 2022

@waxlamp and @mvandenburgh - given this is a web app, how about we create the text that it reads in some location separate from the web app, and it can pull the info, which we can update async from development of the app.

If this text were going to be in rapid flux (or if it turns out to be like that) I think we could consider this approach. For a first implementation, I prefer the simplicity of what we have in this PR.

btw, i love this feature.

🥳

Base automatically changed from filebrowser-script-setup to master November 29, 2022 19:59
@mvandenburgh mvandenburgh added enhancement New feature or request patch Increment the patch version when merged release Create a release when this pr is merged labels Nov 29, 2022
@mvandenburgh mvandenburgh merged commit e27c7c0 into master Nov 29, 2022
@mvandenburgh mvandenburgh deleted the file-upload-instructions branch November 29, 2022 20:01
@dandibot
Copy link
Member

🚀 PR was released in v0.3.4 🚀

@dandibot dandibot added the released This issue/pull request has been released. label Nov 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request patch Increment the patch version when merged release Create a release when this pr is merged released This issue/pull request has been released.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Implement "Add files" DLP design Finish DLP redesign implementation
5 participants