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 navbar links to get help #350

Closed
matthew-white opened this issue Jul 23, 2020 · 4 comments · Fixed by #398
Closed

Add navbar links to get help #350

matthew-white opened this issue Jul 23, 2020 · 4 comments · Fixed by #398
Labels
enhancement New feature or behavior needs discussion Discussion needed before work can begin

Comments

@matthew-white
Copy link
Member

@lognaturel, @issa-tseng, what do you think about adding link(s) to the navbar dropdown that link to the docs and/or the forum? One possibility is that these links could go between "Edit profile" and "Log out".

Also CC @florianm, who made a related comment on the forum.

@matthew-white matthew-white added the needs discussion Discussion needed before work can begin label Jul 23, 2020
@florianm
Copy link

Links to server diagnostics or docs/forum would be great!

e.g.

  • a hint to open the browser console might save a round trip to the forum
  • an expanding section in error messages to "view details" which I can copy straight away would save a round trip to the browser console and could include details about central version, deployment, issue with certificates etc (similar to R sessionInfo())
  • if error is known / occurs often due to incorrect config / relevant to server maintainers: a link to the FAQ or a preformed link to search the forum for that error.

@matthew-white
Copy link
Member Author

Thanks, @florianm! Some of these ideas wouldn't be easy to implement today, but I like the idea of improving the user experience around errors. I'm going to throw out a couple of thoughts related to how Frontend handles errors today, then I'll show a screenshot of what I'm currently thinking.

Currently Frontend doesn't have information about the deployment, including the version of Central. Frontend could fetch /version.txt, and we could try to set up ops to provide Frontend other information about the deployment, but that's not something we have set up today. (Also linking to the related getodk/central#59.)

There's a way in Frontend to read the details from a Backend error and display them in a human-readable way. The aim is for the Frontend error message to contain all the information that the user needs. For example, we use that mechanism in the modal that's used to create a form or upload a new form definition. However, I think there are probably more places we could use that mechanism: getodk/central#144 may be an example of this.

Here are a couple of screenshots of what I think might be a quick win. I've updated the navbar to link to the docs, the forum, and /version.txt. We already link to the docs and the forum from the Central homepage, but this change would make those links accessible in more places.

Version 1: Add the links to the existing dropdown:

Screen Shot 2020-08-23 at 12 05 31 PM

Version 2: Add a new help menu:

Screen Shot 2020-08-23 at 1 02 32 PM

@matthew-white matthew-white added the enhancement New feature or behavior label Aug 23, 2020
@florianm
Copy link

As an ODK Central user who just experienced an error, my first thoughts are "what's wrong exactly" and "where can I find a solution". The question mark icon in Version 2 is the most logical symbology for me to open, more than my profile/name.

Shower thought: "log" + "audit" + "console" = Win 10-like notification stream? Let this area display errors (with a link to the forum that contains a few targeted keywords) and make it unobtrusive yet discoverable.

@issa-tseng
Copy link
Contributor

the latter feels closer to me but I don't like the order and placement.

can we mirror the left side a little and do something like

[? v] [lang v] [space] [name v]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or behavior needs discussion Discussion needed before work can begin
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants