DSpeichert / cloudvcl

Cloud VCL - let your students use virtual environments for class/assignments
https://dspeichert.github.io/cloudvcl/
3 stars 1 forks source link

Change default Help text to useful contextual information #40

Closed abhishekvalanju closed 7 years ago

abhishekvalanju commented 7 years ago

Edit collapsible wells to have useful helpful hints and information for users. This is currently initiated at major process flows such as creating assignments, environments, environment definitions, launching instances and etc. Research how other sites give helpful context to their user and similarly implement.

Example: For assignment_detail, create a collapsable well. Inside the well, you have to have contextual help such as "By clicking 'Launch an Instance' you are initiating a virtual instance. Please wait for a few minutes once you click the button for setup to be completed".

Note*: Collapsible wells have been made for you in assignment_list.html, course_list.html and environment_definition_detail.html. Edit the context text within them to guide users on how to use the page.

Acceptance criteria:

  1. All pages listed have collapsible wells
  2. All wells have context text that is helpful in context to the page its on
  3. Text is a minimum a paragraph in length
mitchfeldman commented 7 years ago

I think popovers will be better than wells but I can't get them to work. Not sure what I'm missing...

<button class="btn btn-primary" type="button" data-container="body" data-toggle="popover" data-placement="bottom" data-content="Test test test test"> {% bootstrap_icon "question-sign" %} Help </button>

I retrieved the code from the bottom of this page: http://fezvrasta.github.io/bootstrap-material-design/bootstrap-elements.html

mitchfeldman commented 7 years ago

assignment_list.html

course_list.html

environment_definition_list.html

assignment_detail.html

...

abhishekvalanju commented 7 years ago

What is this? Are you showing this to get feedback? Cause, it would be nice to see this in the popover/wells so we can judge the appearance.

abhishekvalanju commented 7 years ago

Spoke to Dan and he doesn't believe that popovers are a good idea. His reasoning is that it's not obvious that the help text is there.