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

4280/connectors guides #7312

Merged
merged 21 commits into from
Nov 8, 2021
Merged

4280/connectors guides #7312

merged 21 commits into from
Nov 8, 2021

Conversation

isalikov
Copy link
Contributor

@isalikov isalikov commented Oct 24, 2021

  • Documentation can be shown when user create source/destination if docs markdown are available
    image

@isalikov isalikov self-assigned this Oct 24, 2021
@github-actions github-actions bot added area/frontend area/platform issues related to the platform labels Oct 24, 2021
@isalikov isalikov temporarily deployed to more-secrets October 24, 2021 14:14 Inactive
@isalikov
Copy link
Contributor Author

For fetching documents markdown as text REACT_APP_INTEGRATION_DOCS_URLS should be set for webapp .env file.

Also I was use http-server localy for serve content from docs folder.

@isalikov isalikov added the help-welcome Accepting external contributions label Oct 24, 2021
@isalikov isalikov temporarily deployed to more-secrets October 24, 2021 14:21 Inactive
@isalikov isalikov linked an issue Oct 24, 2021 that may be closed by this pull request
@cgardens
Copy link
Contributor

@avaidyanatha heads up! it's happening!

@isalikov isalikov temporarily deployed to more-secrets October 28, 2021 11:02 Inactive
@isalikov isalikov temporarily deployed to more-secrets October 29, 2021 18:15 Inactive
COPY build /usr/share/nginx/html
RUN rm -rf /usr/share/nginx/html/docs
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@cgardens do you remember by any chance why was this line added? It looks like it removes docs from serving from nginx. Is it what we really want? I believe we still want to access this files from UI.

@isalikov isalikov temporarily deployed to more-secrets November 2, 2021 20:42 Inactive
Copy link
Contributor

@jrhizor jrhizor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great when configuring the source and destination directly.

There are two issues:

  1. It's easy to get stuck. Would it be easy to make clicking outside of the doc pane (for example if someone clicked to go to settings) to close out the docs pane?
  2. Accessing the guide during onboarding breaks the styling:
    Screen Shot 2021-11-02 at 3 46 46 PM
    It's also very easy to feel stuck in this situation because you have to horizontally scroll to see the x.

@isalikov isalikov temporarily deployed to more-secrets November 3, 2021 10:32 Inactive
@isalikov isalikov temporarily deployed to more-secrets November 3, 2021 10:38 Inactive
@isalikov isalikov temporarily deployed to more-secrets November 4, 2021 10:08 Inactive
@isalikov isalikov requested a review from jrhizor November 4, 2021 12:02
@jamakase
Copy link
Contributor

jamakase commented Nov 4, 2021

It's easy to get stuck. Would it be easy to make clicking outside of the doc pane
@isalikov
this problem is still there. We need to add outside-click listener

  • we need to display cross absolutely positioned, so if user scrolls down - it is still visible.
  • Actually markdown we render looks a bit ugly and doesn't fit our styling. We should update it.

@isalikov isalikov temporarily deployed to more-secrets November 5, 2021 09:50 Inactive
@isalikov
Copy link
Contributor Author

isalikov commented Nov 5, 2021

  • Click ouside docs panel close SideView
  • Styles updated
    image

@isalikov isalikov temporarily deployed to more-secrets November 5, 2021 10:37 Inactive
@isalikov isalikov temporarily deployed to more-secrets November 5, 2021 10:44 Inactive
Copy link
Contributor

@jrhizor jrhizor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The panel looks and feels perfect now (both for onboarding and normal configuration)!

However, I think it's breaking the design in other places:
Screen Shot 2021-11-05 at 10 41 00 AM
Screen Shot 2021-11-05 at 10 38 33 AM

See random box in both of them and the misaligned buttons in the second.

@jamakase
Copy link
Contributor

jamakase commented Nov 6, 2021

The panel looks and feels perfect now (both for onboarding and normal configuration)!

However, I think it's breaking the design in other places

See random box in both of them and the misaligned buttons in the second.

Indeed. Applied qfix so we can merge it

@jamakase jamakase temporarily deployed to more-secrets November 6, 2021 21:15 Inactive
@jamakase jamakase temporarily deployed to more-secrets November 6, 2021 21:43 Inactive
@jamakase jamakase temporarily deployed to more-secrets November 6, 2021 23:55 Inactive
@jamakase jamakase merged commit cc038cd into master Nov 8, 2021
@jamakase jamakase deleted the 4280/connectors-guides branch November 8, 2021 21:15
schlattk pushed a commit to schlattk/airbyte that referenced this pull request Jan 4, 2022
* feat: s/d docs popup

* feat: useDocumentation hook

* feat: SetupGuide as single component

Co-authored-by: Artem Astapenko <jamakase54@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/platform issues related to the platform help-welcome Accepting external contributions
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Display documentation in configuration UI
4 participants