bitovi / bitops

Automate the provisioning and configuration of cloud infrastructure with BitOps docker image

https://bitops.sh

Other

36 stars 9 forks source link

documentation lookup implementation #199

Open PhillypHenning opened 2 years ago

PhillypHenning commented 2 years ago

TODO

mickmcgrath13 commented 2 years ago

@PhillypHenning is this done?

if not, can you add details around what is done today (v2) and what will be done to enhance it?

PhillypHenning commented 2 years ago

Sure -

State of today

The lookup function has been added A single lookup message has been added in the docs.json

State of tomorrow

Consolidate all error messages into the docs.json lookup source
Update error logging to use lookup functionality
Organization

TL;DR

The function is written
We now need to move the error messages into the file and update bitops accordingly

arm4b commented 2 years ago

I understand that the idea is to keep all error messages in the dictionary. When the error case is hit in the code, - it will lookup the error message from the json file and output that to the user. We'll also render this list of error messages in the docs.

What are the benefits of duplicating all the error messages in the docs? Do we also plan to provide a link from the code to the respective docs URL#code_num or something? Will it link to the same error that was already output to the user in the console?

PhillypHenning commented 1 year ago

It wouldn't be duplication. We'd take advantage of a centralized file to keep logging messages in. Keeping them generic means that they can be used in more then one way.