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 FAQs page or something similar? #10

Closed
mblue9 opened this issue Feb 27, 2018 · 11 comments
Closed

Add FAQs page or something similar? #10

mblue9 opened this issue Feb 27, 2018 · 11 comments

Comments

@mblue9
Copy link
Collaborator

mblue9 commented Feb 27, 2018

I really like your front page of usegalaxy.eu 😄 and was wondering - what about having a link to an FAQs page or something?

e.g. how would users know that they have to use ftp to get files >2GB (and how to do it)?

I know it must be in the Galaxy documentation somewhere but imho that info is super important (as getting data in is the first step to using Galaxy and a lot of the fastq/BAM files our users have are over >2GB) so having that info closer (more easily accessible) for users e.g. one-click away would be good I think

Also having an prominent/obvious link to where users can support (e.g. Biostars) would be good, or to wherever they're supposed to get help.

@hexylena
Copy link
Member

Whenever you try to upload a file larger than 2GB, it complains and says to use FTP

auswahl_343

Clicking the FTP button mentions you should connect to ftp://... with your standard creentials.

auswahl_344

Is that enough to help users or would you think more information would be helpful?

@hexylena
Copy link
Member

Additionally, if they try and open a browser to the FTP site, https://ftp.usegalaxy.eu/, I've shown an FTP info page which has some documentation.

@mblue9
Copy link
Collaborator Author

mblue9 commented Mar 1, 2018

I think this would be good to test out with a few users new to Galaxy. As my feeling is users may still waste time faffing around trying to get their files in (after the initial error they get when they try to upload) but maybe I'm underestimating them :)

@hexylena
Copy link
Member

hexylena commented Mar 1, 2018

Definitely. I think there will be a huge leap between "you need to use ftp" and the user being able to successfully download, install, and operate an FTP client. I can't wait until they implement chunked uploads galaxyproject/galaxy#573 and we can kill FTP except for the users who really need it.

I don't think you're underestimating, it would be better if we linked to some documentation on "here is where to download an ftp client for your platform, here are detailed instructions, here are the exact server connection parameters" would significantly improve the success rate of people completing this task.

@mblue9
Copy link
Collaborator Author

mblue9 commented Mar 2, 2018

Cool thanks for the link to that issue!

Yeah I ended up having to make a doc like that for our users 😄 see here:
BIOIN-HowtoloadfilesintoGalaxyMelbourne-020318-1700-42.pdf

@hexylena
Copy link
Member

hexylena commented Mar 2, 2018

How do you link to it? How do users know where to find that PDF?

@mblue9
Copy link
Collaborator Author

mblue9 commented Mar 4, 2018

I exported that PDF, it lives in Confluence, the documentation system used (and admin-ed) by our group... which is now about to be trialled much wider by other groups in the hospital! 😄 🎉

@mblue9
Copy link
Collaborator Author

mblue9 commented Mar 4, 2018

In case you're interested to know, our Galaxy front page has a "Knowledge Base" button that links to info we will provide for users in Confluence, see below

screen shot 2018-03-04 at 4 32 12 pm

@bgruening
Copy link
Member

I think we need a FAQ site for all the small things people wonder will ask. Begins with Quota, might end citations/funding, CSA ... I hope most of the Q are links to the Galaxy hub in the end. Or the entire FAQ can be stored on the hub as part of our usegalaxy.eu hub site ...

@mblue9
Copy link
Collaborator Author

mblue9 commented Mar 5, 2018

Yeah, I think you can't avoid the need for some sort of FAQ. That "Knowledge Base" button above on our front page leads to this page:
screen shot 2018-03-05 at 12 51 38 pm

which is currently completely empty (I need to add info in there asap!) I'm also hoping most will just be links to the Galaxy hub, I certainly don't want to reinvent the documentation wheel!

But most importantly, imo some sort of FAQ/note is needed for data backup and storage (to cover your a*ses) - what accountability/responsibility are you accepting for the Users' data?

e.g. see this from Galaxy-QLD front page:
screen shot 2018-03-05 at 12 42 40 pm

Note the "We do not backup user data" and "Data might be deleted from accounts inactive for six months or more". Something like that is really important to have imho, a clear statement of the scope of responsibility.

There's a similar note on the front page of Galaxy Melbourne (they also have a note on running jobs):
screen shot 2018-03-05 at 12 43 27 pm

@hexylena
Copy link
Member

hexylena commented Mar 14, 2019

  • we now have a quota/storage/policy-y box in our carousel / at the bottom
  • the "Help → Galaxy Help" now links to the new help.galaxyproject.org which we will use for FAQ / problems. We can pin messages there and we can pin one for dealing with common issues

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants