mindsdb icon indicating copy to clipboard operation
mindsdb copied to clipboard

[Bug]: MAKE SURE that all DB connection templates in GUI match the docs and have full connection options and context

Open ianu82 opened this issue 2 years ago • 3 comments

Short description of current behavior

Often the docs and the GUI connection templates do not match or miss helpful user context (eg you need one of these options or this field is optional).

Users have trouble connecting and we don't help them.

Perhaps we could include a link to the docs page in the connection template in GUI too.

Video or screenshots

See: https://github.com/mindsdb/mindsdb/issues/4327

https://github.com/mindsdb/mindsdb/issues/4086

https://github.com/mindsdb/mindsdb/issues/3976

https://github.com/mindsdb/mindsdb/issues/4072

Expected behavior

No response

How to reproduce the error

No response

Anything else?

No response

ianu82 avatar Jan 20 '23 11:01 ianu82

@ZoranPandovski @martyna-mindsdb let's review of all the database connection templates and docs, starting with the above mentioned ones? We should be making this as easy as possible for the user, ideally eventually with a short video for each.

tomhuds avatar Jan 23 '23 12:01 tomhuds

@ZoranPandovski says:

  1. Make sure the docs are aligned with the code
  2. Align with GUI

tomhuds avatar Jan 24 '23 16:01 tomhuds

@ZoranPandovski In the docs, I created the template and example of CREATE DATABASE statement for each database (56 databases). In the templates, I have standardized the comments to describe the connection parameters. So the templates present in docs currently could be replicated to GUI. Please let me know. Thanks.

martyna-mindsdb avatar Jan 24 '23 18:01 martyna-mindsdb

to be converted into new issues for competition - closing for now

tomhuds avatar Jan 31 '23 16:01 tomhuds