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

Load "getting started" docs onto "core" docker image #4281

Closed
cgardens opened this issue Jun 22, 2021 · 1 comment · Fixed by #4522
Closed

Load "getting started" docs onto "core" docker image #4281

cgardens opened this issue Jun 22, 2021 · 1 comment · Fixed by #4522
Assignees
Labels
type/enhancement New feature or request

Comments

@cgardens
Copy link
Contributor

This issue is a child of #3879 and dependent on an open question in #4280.

Tell us about the problem you're trying to solve

When a user is configuring a connector, we want to show the appropriate docs in the UI. Part of the plan there is including the docs on a docker image in the airbyte platform so that even if airbyte doesn't have internet access it can render docs.

Describe the solution you’d like

  • We need to figure out how to copy any connector docs with the name getting-started.md. Everything else can be ignored.
  • We also need to figure out how to make sure the names of docs, matches up with with connector names in the ui. In other words the UI has to be using the right identifier to be able to find these docs; not clear what id we should be using here. Ideally we would just use the UUID associated with the connector. The problem is since we are reusing the docs that are hosted publicly we are a little locked into the convention there, which just used name for human friendliness. Either we need to make a change there or figure out how the UI can figure out what these names are.
@cgardens
Copy link
Contributor Author

just needs to be merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants