Improve error logs related to invalid source url in model generation

[riyaa14]

Description

This PR fixes #

Before

After

Notes for Reviewers

Signed commits

• [*] Yes, I signed my commits.

[gemini-code-assist[bot]]

[!WARNING] You have reached your daily quota limit. As a reminder, free tier users are limited to 5 requests per day. Please wait up to 24 hours and I will start processing your requests again!

[leecalcote]

@riyaa14, thank you. This is an improvement. 🙂 From the looks of it, it seems that we can be more accurate with the suggested probable cause. At the point in time in our logic where we are unable to retrieve the latest release tag, it should be the case that we've already been able to reach the URL that the user has provided and have moved along in our logic to looking up the release tag. If this is true, suggesting that the #1 most probable cause is an invalid source URL is inaccurate, and not helpful to users resolving this issue, then retrying and being successful.

Here is the URL that I used when I received this error: git://github.com/Azure/azure-service-operator/blob/main/charts/azure-service-operator-1.9.0.tgz. Be a user. Try using this URL to create a model. When you get a failure message. What are you to do with the information provided in the Suggested Remediation?

• As a user, can I point to a tarred Helm chart? This information isn't provided by the event. The event also does not link users to additional documentation on this topic, but should.

• As a user, can I include "blob" or branch name ("main" or "master" or other) in the URL? I should be able to do so. We should not be placing this burden on the user. We can parse the URL intelligently with ease.

• As a user, .... there are many other questions here that need answers. The two above are examples.

@riyaa14, this discussion is still on the topic of our very first assignment: documentation of the various scenarios in which mesheryctl registry and mesheryctl model commands are run, and how their UX should improve. The flow for these scenarios is simply invoked from the UI, but the source code is the same centrally sourced code from MeshKit.

Let's be discerning with our event notifications, ensuring that we are offering information back to the user at each step and specific to each step of the generation process.

@FaheemOnHub, where is the updated contributing docs on custom event notification formats? All events should include a link to a docs page, @riyaa14 @lekaf974 @alphaX86 @hexxdump. // @zihanKuang

The list of scenarios you've fathomed are now documented in the Meshery Test Plan spreadsheet as test cases, I think (awesome!). Please, please put your user hat on and attempt to use the Import Model and Create Model wizards - - with no assumption of prior knowledge. How can we improve? What doesn't make sense?

These need reconciled and improved:

1. https://docs.meshery.io/guides/configuration-management/generating-models - missing the new import and create wizards found in the UI.
2. https://docs.meshery.io/guides/configuration-management/importing-models - missing an explanation from the perspective of the UI.
3. https://docs.meshery.io/project/contributing/contributing-models-quick-start - arguably the best, consolidated user guide, but is categorized under "Contributing Guides"

// @ianrwhitney @amitamrutiya

[leecalcote]

Merge conflict

[FaheemOnHub]

@riyaa14, thank you. This is an improvement. 🙂 From the looks of it, it seems that we can be more accurate with the suggested probable cause. At the point in time in our logic where we are unable to retrieve the latest release tag, it should be the case that we've already been able to reach the URL that the user has provided and have moved along in our logic to looking up the release tag. If this is true, suggesting that the #1 most probable cause is an invalid source URL is inaccurate, and not helpful to users resolving this issue, then retrying and being successful.

Here is the URL that I used when I received this error: git://github.com/Azure/azure-service-operator/blob/main/charts/azure-service-operator-1.9.0.tgz. Be a user. Try using this URL to create a model. When you get a failure message. What are you to do with the information provided in the Suggested Remediation?

• As a user, can I point to a tarred Helm chart? This information isn't provided by the event. The event also does not link users to additional documentation on this topic, but should.
• As a user, can I include "blob" or branch name ("main" or "master" or other) in the URL? I should be able to do so. We should not be placing this burden on the user. We can parse the URL intelligently with ease.
• As a user, .... there are many other questions here that need answers. The two above are examples.

@riyaa14, this discussion is still on the topic of our very first assignment: documentation of the various scenarios in which mesheryctl registry and mesheryctl model commands are run, and how their UX should improve. The flow for these scenarios is simply invoked from the UI, but the source code is the same centrally sourced code from MeshKit.

Let's be discerning with our event notifications, ensuring that we are offering information back to the user at each step and specific to each step of the generation process.

@FaheemOnHub, where is the updated contributing docs on custom event notification formats? All events should include a link to a docs page, @riyaa14 @lekaf974 @alphaX86 @hexxdump. // @zihanKuang

The list of scenarios you've fathomed are now documented in the Meshery Test Plan spreadsheet as test cases, I think (awesome!). Please, please put your user hat on and attempt to use the Import Model and Create Model wizards - - with no assumption of prior knowledge. How can we improve? What doesn't make sense?

These need reconciled and improved:

1. https://docs.meshery.io/guides/configuration-management/generating-models - missing the new import and create wizards found in the UI.
2. https://docs.meshery.io/guides/configuration-management/importing-models - missing an explanation from the perspective of the UI.
3. https://docs.meshery.io/project/contributing/contributing-models-quick-start - arguably the best, consolidated user guide, but is categorized under "Contributing Guides"

// @ianrwhitney @amitamrutiya

We have not made any new custom formatters , so I guess these docs are still in a good position : https://docs.meshery.io/project/contributing/contributing-ui-notification-center

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.