Nomenclature in code and error messages
Problem/Opportunity Statement
#64 (closed) raised the question of how to handle nomenclature for cloud resources in the UI, and !393 (merged) implemented localization support in the UI.
We have not systematically addressed nomenclature for cloud resources as used in code and in error messages, so it is inconsistent. For example, most of the code uses the term "server" right now, but some uses "instance".
If we used consistent nomenclature, it would be easier / less confusing to develop and troubleshoot Exosphere.
What would success / a fix look like?
- Style/contribution guide specifies nomenclature that developers should use in code and error messages for common cloud resources and various associated terms
- Perhaps it points to
src/Types/Defaults.elm
and specifies to use the default nomenclature defined there - Consider using nomenclature that makes sense for someone working directly with OpenStack API? Example, "user data" may make more sense than "boot script"
- Consider whether we want to localize error messages. @cmart feels bearish on this one but open to other perspectives.
- Perhaps it points to
- Code, strings, and error messages are updated throughout app to use this nomenclature
Edited by Chris Martin