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

Change wording of debug log submission #1740

Merged
merged 4 commits into from
Mar 20, 2018
Merged

Change wording of debug log submission #1740

merged 4 commits into from
Mar 20, 2018

Conversation

lukebarnard1
Copy link
Contributor

@lukebarnard1
Copy link
Contributor Author

lukebarnard1 commented Feb 8, 2018

2018-02-08-181300_236x153_scrot

2018-02-08-181215_267x153_scrot

Thoughts on ^ appreciated.

Ping @lampholder, @ara4n.

@uhoreg
Copy link
Member

uhoreg commented Feb 8, 2018

Instead of just "Want to send logs?", it should say something about what logs are, and why someone would want to send logs. Maybe something along the lines of: "If you've found a bug, debug logs can help us track down the problem. Debug logs do not contain any of your messages, but will include your username, ..."

@lukebarnard1
Copy link
Contributor Author

I think we should focus on the original remit, which was to encourage people to submit an issue on GitHub if they want to report a bug, so I would opt for something more like (building on @uhoreg's proposal):

If you've submitted a bug via GitHub, debug logs can help us track down the problem. Debug logs contain your username, the IDs or aliases of the rooms or groups you visit, usernames of other users and other information. They do not contain messages.

@lampholder
Copy link
Member

@lukebarnard1 - I like that wording.

Will we still give users a box to type additional comments when they click 'submit debug logs'? What about an optional field to include a reference to the github issue they've (hopefully) filed?

@turt2live
Copy link
Member

wrt the url field, it might be worth it to make it appear required (ie no text saying "required" or "optional") but treat it as optional behind the scenes.

@lukebarnard1
Copy link
Contributor Author

@lampholder I think for those who don't use GH or who'd prefer not to, it's still useful to have the comment box. I like the idea of optional GH URL inserting - under the hood we can append it to the description.

We should also consider adjusting the wording in the dialog box itself, as it is geared towards sending a bug report:
2018-02-15-112133_793x492_scrot

@lampholder
Copy link
Member

I'd like to refine the wording to read:

If you've submitted a bug via GitHub, debug logs can help us track down the problem.
Debug logs contain application usage data including your username, the IDs or aliases 
of the rooms or groups you have visited and the usernames of other users. They do not
contain messages.

How about the modal looking something like:

# Submit debug logs

Debug logs contain application usage data including your username, the IDs or aliases
of the rooms or groups you have visited and the usernames of other users. They do not 
contain messages.

Github issue link: [_https://github.com/vector-im/riot-web/issues/1337____]
            Notes: [______________________________________________________]
                   [______________________________________________________]

[Send Logs]   [Cancel]

As @turt2live says, the additional fields can be optional. Styling the issue link field with a placeholder URL should encourage people to fill it in, and hopefully the 'notes' field is sufficiently vague that people who've filed a github issue will ignore it (and only the desperate will fill it in).

I've repeated the 'debug logs contain...' segment because I think it's important people know exactly what they're doing :)

I think this whole section could be further improved by making reference to where and how the logs are stored, who will have access to them, and how long they will be kept, but I'd suggest we just get version out and then iterate.

@lukebarnard1
Copy link
Contributor Author

FTR, I'll push changes to the dialog in another PR because it's in vector-web.

@dbkr dbkr merged commit 081edfb into develop Mar 20, 2018
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

Successfully merging this pull request may close these issues.

None yet

5 participants