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

Review diagnostics and develop guidelines for creating new ones #3064

Open
Tracked by #3063
jandubois opened this issue Sep 30, 2022 · 0 comments
Open
Tracked by #3063

Review diagnostics and develop guidelines for creating new ones #3064

jandubois opened this issue Sep 30, 2022 · 0 comments
Labels
area/diagnostics kind/story Work item that is linked from a kind/epic

Comments

@jandubois
Copy link
Member

jandubois commented Sep 30, 2022

We should review all existing diagnostics to develop guidelines (and adjust the diagnostics to follow our new guidelines):

  • What categories should we create for diagnostics?
  • Can we find a way to link categories to Preference areas?
  • How do categories map to documentation pages?
  • How should the wording be for passing diagnostics?
  • How should the wording be for failing diagnostics?
  • What should we log for passing diagnostics?
  • What should we log for failing diagnostics?
  • Should we log additional information at the debug level?
  • How can we keep sensitive information out of the log file by default (because people may post them on Slack/Github)?

Any additional guidelines for "Fix actions"? May need to be a separate story, as the feature does not exist yet.

@jandubois jandubois added kind/story Work item that is linked from a kind/epic area/diagnostics labels Sep 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/diagnostics kind/story Work item that is linked from a kind/epic
Projects
None yet
Development

No branches or pull requests

1 participant