[Feedback] Stop including error messages in the feedback body#25286
[Feedback] Stop including error messages in the feedback body#25286
Conversation
|
Az Feedback refinement to fix an issue. |
There was a problem hiding this comment.
| _Put here the error message you received. Make sure to redact sensitive information, such as personally identifiable information (PII), user name, password, credential, etc._ | |
| _Insert here the error message you have received. Make sure to redact any sensitive information, such as user name, password, credential, subscription id, etc._ |
There was a problem hiding this comment.
I think PII is a well-known term. 🙂 https://www.dol.gov/general/ppii
There was a problem hiding this comment.
I choose the word "put" because we already use it in the following section.
As for "have", do we really have to use present perfect tense? Simple past tense "received" feels good to me. No need to emphasize the "have received" status.
Also, "any" only serves as an emphasis, so it seems a little bit redundant. But, I am not a native speaker, so may be wrong.
dcaro
left a comment
There was a problem hiding this comment.
overall lgtm, just a suggestion to improve the message.
dbradish-microsoft
left a comment
There was a problem hiding this comment.
I do like @dcaro's rewrite, but I simplified it some more. There isn't anything wrong with using PII, but what is similar for our readers and language translators?
There was a problem hiding this comment.
| identifiable information (PII), user name, password, credential, subscription ID, etc. | |
| _Insert here the error message you have received. Make sure to remove all sensitive information, such as user name, password, credential, subscription ID, etc._ |
There was a problem hiding this comment.
This line is surrounded by ```, so _ won't work here as italic. I am also wondering which character we should use as a placeholder.
dbradish-microsoft
left a comment
There was a problem hiding this comment.
@jiasli , I see you have kept "Insert" vs your preferred "put". Maybe "paste" would be even better, but I'm fine with whatever you use.
Good idea. Changed as suggested. |
Related command
az feedbackDescription
Stop including error messages in the feedback body.