Issue #11076 has been updated by Randall Hansen.

The identifier needs to be recognizable as a Puppet error, both to humans and 
to robots like Google.  Google is easy:  add enough noise to the string and it 
will be unique.  People are harder but more important.

"PLPP0103" doesn't tell people that it's an error code, that it's related to 
Puppet, or that it contains tokens.  All three of these are important 
information for a human.  Consider something like "puppet_error_103."  That's 
easily tokenizable by a person, is clearly a Puppet error message, and can be 
looked up uniquely in Google or our documents.  Furthermore it will probably 
work with less precise searches, like "puppet error code 103."
----------------------------------------
Feature #11076: Error messages should all have a unique identifier
https://projects.puppetlabs.com/issues/11076

Author: Nigel Kersten
Status: Unreviewed
Priority: Normal
Assignee: 
Category: 
Target version: 
Affected Puppet version: 
Keywords: 
Branch: 


It's difficult to search for phrases when trying to work out what has provoked 
a given error message.

Something IBM did quite awesomely was to have unique identifiers for their 
error messages so that you could more easily search for information on them.

I'm not suggesting we abandon providing a human-readable phrase explaining the 
error in context, but that we instead append a unique identifier of some kind 
so that we can more easily provide significantly more detail in our 
documentation around errors.

Love to get feedback on this idea, particularly from docs and UX.




-- 
You have received this notification because you have either subscribed to it, 
or are involved in it.
To change your notification preferences, please click here: 
http://projects.puppetlabs.com/my/account

-- 
You received this message because you are subscribed to the Google Groups 
"Puppet Bugs" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to 
[email protected].
For more options, visit this group at 
http://groups.google.com/group/puppet-bugs?hl=en.

Reply via email to