Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation link: Support both domains: OLD docs.airbyte.io, NEW docs.airbyte.com #10412

Closed
grubberr opened this issue Feb 17, 2022 · 4 comments · Fixed by #10621
Closed

Documentation link: Support both domains: OLD docs.airbyte.io, NEW docs.airbyte.com #10412

grubberr opened this issue Feb 17, 2022 · 4 comments · Fixed by #10621
Assignees
Labels
needs-feedback type/bug Something isn't working

Comments

@grubberr
Copy link
Contributor

grubberr commented Feb 17, 2022

Current Behavior

Docs pre-loading feature works only for OLD urls which starts with docs.airbyte.io domain.
https://docs.airbyte.io/integrations/sources/zendesk_sunshine

but for NEW correct domain docs.airbyte.com it fails like on picture

Screenshot 2022-02-17 at 18 17 25

it happens because we support only OLD domain

const DOCS_URL = "https://docs.airbyte.io";

Expected Behavior

I think we need to support both domains: docs.airbyte.io, docs.airbyte.com until all doc urls updated.

@grubberr grubberr added type/bug Something isn't working needs-triage and removed needs-triage labels Feb 17, 2022
@grubberr grubberr changed the title Change all docs urls docs.airbyte.io -> docs.airbyte.com Support both domains: OLD docs.airbyte.io, NEW docs.airbyte.com Feb 17, 2022
@grubberr grubberr changed the title Support both domains: OLD docs.airbyte.io, NEW docs.airbyte.com Documentation link: Support both domains: OLD docs.airbyte.io, NEW docs.airbyte.com Feb 17, 2022
@octavia-squidington-iii
Copy link
Collaborator

cc @airbytehq/frontend

@timroes
Copy link
Collaborator

timroes commented Feb 24, 2022

Can someone explain me what's the difference between those two domains? Which one is the one we're using for actually publishing docs?

@jrhizor
Copy link
Contributor

jrhizor commented Feb 24, 2022

We redirect from .io to .com now. However, the issue here is that we're packaging the doc .md files into the webapp build, but referencing their file paths based off of the documentationUrl provided in the connector definition.

Some of the more recent ones are specified with .com:

airbyte-integrations/connectors/source-quickbooks-singer/source_quickbooks_singer/spec.json
2:  "documentationUrl": "https://docs.airbyte.com/integrations/sources/quickbooks",

While others use .io:

airbyte-integrations/connectors/source-tiktok-marketing/integration_tests/spec.json
2:  "documentationUrl": "https://docs.airbyte.io/integrations/sources/tiktok-marketing",

Others still use invalid domains:

airbyte-integrations/connectors/source-azure-table/source_azure_table/spec.json
2:  "documentationUrl": "https://docsurl.com",

or helpful but non-internal domains (not related to the md files at all):

airbyte-integrations/connectors/source-shortio/source_shortio/spec.json
2:  "documentationUrl": "https://developers.short.io/reference",

So I suppose for some of these you'll need to reach out to the connector team to improve these. However, I agree with @grubberr that we could fix the hacky mapping here to accept either prefix.

@timroes timroes self-assigned this Feb 24, 2022
@timroes
Copy link
Collaborator

timroes commented Feb 24, 2022

I've created https://github.com/airbytehq/airbyte-internal-issues/issues/438 for the connectors team to fix all invalid scaffolded domains.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs-feedback type/bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants