Update connector documentation to have generic catalog names#13964
Update connector documentation to have generic catalog names#13964sheajamba wants to merge 2 commits intotrinodb:masterfrom
Conversation
|
@electrum @hashhar .. this PR is to undo #9252 .. before this got merged we were attempting to ensure that the catalog names are NOT the same the as the connector names. The linked PR reestablishes this problematic setup. It causes users to misunderstand that catalogs are separate from connectors and you can have as many catalogs accessing different database as you want .. including using all using the same connector. With this PR we propose to come up with a standard solution that can then be used in all connector docs. Before we proceed we would like to get to an agreement on what that name should be. It could be like in the current PR where it is the same for all connector docs .. e.g. always mycatalog, test_catalog or whatever Or it could be different for each connector as long as it is not the same as the connector name |
|
A better way to show that you can have multiple catalogs for a connector is to actually show multiple catalogs instead of trying to imply it via different name. We can say something like |
Sure .. we can do that as well in a generic document about connectors and catalogs. But nevertheless .. in the individual connector docs we should NOT use the same name for catalog and connector.. so what should we do there? |
|
People don't often follow links. If they are looking to only use MySQL connector they won't ever click through to the generic page. I'm proposing to add an example of multiple catalogs to each connector's doc instead of a generic page (which already exists https://trino.io/docs/current/overview/concepts.html#catalog) |
|
Just to clarify .. @electrum @sheajamba and myself synced up and discussed this .. we are going to use example.properties in all connector docs .. Shea will update this PR or send replacement and link it here |
fdaab31 to
b5ad6ee
Compare
|
@sheajamba did you want to close this and send separate replacement PRs as discussed? |
Description
Improvement
Connector documentation
Changes example catalog names to not match the name of the connector.
Related issues, pull requests, and links
Documentation
(x) No documentation is needed.
( ) Sufficient documentation is included in this PR.
( ) Documentation PR is available with #prnumber.
( ) Documentation issue #issuenumber is filed, and can be handled later.
Release notes
(x) No release notes entries required.
( ) Release notes entries required with the following suggested text: