search

WheatonCS / Lexos

Python/Flask-based website for text analysis workflow. Previous (stable) release is live at:
http://lexos.wheatoncollege.edu
MIT License
120 stars 20 forks source link

Getting support and reporting bugs #278

Closed scottkleinman closed 8 years ago

scottkleinman commented 8 years ago

As mentioned in issue #277, there is no clear way to get support or report bugs for Lexos. Perhaps we should add a link to the GitHub issues page (such links should also be added on the Lexomics and In the Margins sites). Or do we not want to send our users to GitHub?

czhang03 commented 8 years ago

I think GitHub issues are by design for the general user with nearly no computer skill

scottkleinman commented 8 years ago

I agree, although discussion around the submission process for Programming Historian revealed that some Humanities users nevertheless find the GitHub platform intimidating. It's probably a good idea to create a link directly to the New Issue page.

czhang03 commented 8 years ago

I agree, also we can create an in the margin to work them though how to create a issue.

czhang03 commented 8 years ago

And I suspect most of them don't have GitHub account...

scottkleinman commented 8 years ago

An In the Margins article on how to create a GitHub issue is a great idea. A YouTube video like this, but slightly less aimed at project developers, would be great.

czhang03 commented 8 years ago

that would benefits a lot of people if we do that. That video is obviously out of date. I think we need to mainly explain the function of this tool bar

capture

mleblanc321 commented 8 years ago

at this point, i'm alil' leery of mixing general-user comments with development (github) issues; however, i also agree that that is the place where we want them centralized; however, the average user will not have a github acct, thus, we need another mechanism; i suggest we have a LINK from within ITM (in fact, the link should be liberally sprinkled throughout most/all ITM pages) to enter the message in a form and submit it to us (via email link?), that is probably best; we can then review user input and consider the value of the comment to be included in the ITM text for that particular section

scottkleinman commented 8 years ago

We could always set up a separate bug tracker/support repo. You don't actually need a GitHub account to post issues, do you?

Alternatively, we could have a simple Contact Us form. If it's something like a Google form, it can be embedded in an ITM page. (For that matter, it should be possible to submit GitHub issues from a a form in ITM using the GitHub API.)

But what you're suggesting is a review process for transferring the user comment to the ITM text. That makes sense for support requests and is a good way of growing the content. It's less useful for bug trackers. Of course, we could always pipe selected GitHub issues to ITM using the GitHub API, as well. Or is that just going linked-data crazy?

mleblanc321 commented 8 years ago

let's keep v1 of this simple ...

czhang03 commented 8 years ago

I have never seen anyone leave a issue without a GitHub account.

Although GitHub registration is easy, I suspect there is many people out there that don't want to register...

I don't really like google form, they are as ugly as the web Gmail, and there is no markdown the test displayed will have ugly '>' for quotation and reply.

But there is many advantage in Gmail, for example people all over the world 🗺 (besides china) have google accounts.

scottkleinman commented 8 years ago

Yes, I'd say GitHub is a non-starter if you have to have an account. Google forms are ugly and a little bit inflexible, but they're probably sufficient for questions and reporting. We'll just have to re-format if we want to incorporate any material into In the Margins. If we want to get more sophisticated later, there are ways.

scottkleinman commented 8 years ago

We never implemented this. Is a contact form available in the Wheaton Wordpress implementation? If so, we could set that up and link to it. If not, a Google form might be the way to go for a quick implementation.

mleblanc321 commented 8 years ago

i'll ask our web team

mleblanc321 commented 8 years ago

hmm, using Google Form ...

https://docs.google.com/a/wheatoncollege.edu/forms/d/e/1FAIpQLSddEsRE2PcserYwcjtNpBAMF-YRKVrL4H4LtWDxHeNKoVVxcA/viewform

??

scottkleinman commented 8 years ago

I think that's good enough for now. Should we put a "Feedback and Support" link underneath the Twitter button?

mleblanc321 commented 8 years ago

yes; (i just started to do this, but i wasn't sure how to make this link right-justified under the Twitter button but on same line as the MIT license)

scottkleinman commented 8 years ago

I've pushed a simple way of doing it. Feel free to modify it.

mleblanc321 commented 8 years ago

for now, let's go with this; at present, i'll get an email when someone submits ...