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

Render Google Ads docs for users with Adblockers #13681

Merged
merged 2 commits into from
Jun 10, 2022

Conversation

teallarson
Copy link
Contributor

@teallarson teallarson commented Jun 10, 2022

What

Adresses part of #13555

Before: Users with adblocker browser plugins would not see our Google Ads documentation in our documentation side panel. They would instead see "no documentation found for this connector". But we do have (beautiful) docs for it!

This only appears to have affected Google Ads. Not other plugins with the word Ad and not other plugins with the word Google.

Now: Users can see the docs 🎉

Screen Shot 2022-06-10 at 9 59 51 AM

Note: The H1 is still stripped out. This appears to affect a few docs when Adblockers are on. I'm not addressing that in this PR.

How

  1. In the gradle build, we now rename google-ads.md as gglad.md
  2. We also tell our proxy to point to google-ads.md if gglad.md is requested so users on localhost see the right docs
  3. Where we set the documentation URL in the context, we now ensure that google-ads is replaced by gglad

Recommended reading order

  1. DocumenationPanelContext.tsx
  2. build.gradle
  3. setupProxy.js

Testing

Testing this with various ad-blocking plugins may be helpful. I've tested it manually using Adblock Plus on Firefox and Chrome.

  1. At the root of the repo in this branch, run SUB_BUILD=PLATFORM ./gradlew :airbyte-webapp:copyDocs --rerun-tasks. This will rebuild the docs.
  2. In airbyte-webapp run npm start
  3. Try adding a Google Ads source, verify that you can see the documentation

@teallarson teallarson requested a review from a team as a code owner June 10, 2022 14:19
@github-actions github-actions bot added area/platform issues related to the platform area/frontend Related to the Airbyte webapp labels Jun 10, 2022
@edmundito edmundito added the type/bug Something isn't working label Jun 10, 2022
@teallarson teallarson merged commit 866fb52 into master Jun 10, 2022
@teallarson teallarson deleted the teal/google-ads-docs-workaround branch June 10, 2022 18:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/frontend Related to the Airbyte webapp area/platform issues related to the platform type/bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants