compas-dev / compas-dev/compas

Help user understand cases where plugin is not found

Open
#1,008 0 comments 2 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
386
Forks
122
Avg merge
11d 46m
Merged PRs (30d)
1

Description

# Feature Request

As a user, I want know what to do when a compas plugin is not found (ie. not installed) so that I can be a happy person.

## Details

The current error message when a plugin is not found is really low level and it doesn't indicate the user how to resolve or why the error is occurring at all. This is the case for remeshing, boolean operation plugins, and also for artists (when scripts are run from the command line).

There are two concrete issues:
* The message contains a URL that is not resolvable, eg. https://plugins.compas.dev/trimesh/trimesh_remesh
* The English error message doesn't provide guidance on how to resolve it.

Consequently, there are two actions needed:
* The idea of the URL was to point to a webpage that would show specific info about this pluggable. This needs to be configured in our DNS and we need to prepare a webpage as target for it. I am not sure if the current sphinx page will do (maybe it does).
* The error messages should be more helpful, telling user what are their options (like what happens when you type a command that is not installed on linux and `apt` will suggest immediately `Maybe you need to: sudo apt install whatever`

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.