What's the point of `documentationUrl` in source/d...
# contributing-to-airbyte
j
What's the point of
documentationUrl
in source/destination destinations?
u
The spec command is already expected to return a real documentation URL.
u
u
which isn't used anywhere or particularly useful (as far as I can tell)?
u
If it is used somewhere, shouldn't it use what the spec is returning instead?
u
That’s intended to be the URL pointing to available image tags in the Admin UI
u
and change log
u
there's no repo overview there though
u
and changelogs would presumably be in the root airbyte project?
u
And can't tags be inferred from
airbyte/integration-singer-csv-destination
alone and the default registry?
u
tags meaning all available tags
u
For the consumer to find
u
Why would a user go to that link to look for tags?
u
we can determine what the tags are but it’s supposed to give an easy way for them to find out what tags exist. The missing piece is a change log. imo we should put changelogs in the root repo and then maybe change these urls to point there
u
I thought the UI would automatically show available tags?
u
It doesn’t do that at the moment
u
ah
u
so are we expecting to maintain up to date descriptions of each point version of integrations?
u
if so that seems like it should exist in the same format as the source definition with some additional metadata for that version
u
if we need a programattically accessible changelog
u
so are we expecting to maintain up to date descriptions of each point version of integrations?
only in documentation at the moment
u
basically a change log
u
I'm still a bit confused how this helps a user select a tag they want
u
wouldn't they always want latest unless they wanted to revert after upgrading?
u
I can't imagine consciously choosing a specific older version otherwise
u
assuming airbyte ships with the latest versions, this means people running airbyte instances would need to manually upgrade their connectors
u
so you only upgrade when you specifically choose to
u
is the concern that this is the intended behavior, or that the UX doesn’t help the user navigate it?
u
I definitely think the latter is true right now
u
I agree you should only upgrade when you choose to, but people would generally upgrade from current to latest if they want to upgrade
u
the UX doesn't seem to help and the changelog won't help either if the pattern I'm describing is the primary use case
u
upgrading to latest?
u
yeah
u
I don't think people will search through a changelog looking for the feature they wanted
u
and upgrade to that
u
vs going to the latest that also includes the feature they wanted
u
right so in that case the user upgrades to the latest version
u
unless you mean
latest
u
seems like it'd mostly be bug fixes or changes to the underlying integration
u
which is undesirable
u
yeah I mean latest as in highest semantic version, not
latest
tag
u
I'd prefer to have global airbyte changelogs instead of integration-specific ones
u
wouldn’t having a changelog help them figure out the latest version if they don’t care to comb through every line in changelog?
u
ah
u
Just due to ease of management