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

[Feature]: Provide configurable website links to error messages #17

Open
1 task done
smh812xyz opened this issue Jun 17, 2023 · 0 comments
Open
1 task done

[Feature]: Provide configurable website links to error messages #17

smh812xyz opened this issue Jun 17, 2023 · 0 comments
Assignees
Labels
code documentation Augment comments and/or developer documentation
Milestone

Comments

@smh812xyz
Copy link
Member

smh812xyz commented Jun 17, 2023

What are you trying to achieve?

Provide a simple means of extending error explanations and log messages which is optionally accessible within the messages themselves.

What would you like to see in the product?

Enable end users to click on links within KubeFox log and error messages which point to the XigXog website and which provide for deeper explanations, links to tutorials etc.

Give us an idea of the benefit to you and others should we fulfill the request

Error and log messages tend to be terse by design. Individual messages are frequently not immediately understandable by developers except for those who are already schooled in the art (of whatever product - including KubeFox). That puts developers in the position of hunting in the documentation for that information. By building links into the messages themselves, the developer is given a tremendous head start as they're pointed to the relevant part of the documentation. This will also generate information on what areas of the documentation are accessed the most, leading both to product improvements (ideally developers won't need to experience the issue in the first place) and documentation improvements.

Version

v0.5.x-beta

Code of Conduct

  • I agree to follow XigXog's Code of Conduct
@smh812xyz smh812xyz added the code documentation Augment comments and/or developer documentation label Jun 17, 2023
@smh812xyz smh812xyz added this to the v0.5.x milestone Jun 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code documentation Augment comments and/or developer documentation
Projects
None yet
Development

No branches or pull requests

2 participants