Closed
Description
This issue is a child of: #3879
Tell us about the problem you're trying to solve
We run into a lot of issues that can be simply explained by having documentation next to source and destination setup that clearly explains what each field is and how it is relevant to the connection. This has been requested and will save us a lot of time answering questions that can live within our UI.
-- avaidyanatha
Describe the solution you’d like
- We want to display the "setup guide" portion of connector docs side-by-side with the connector configuration UI.
- The rules we should are as follows:
- check in the public github respository if the docs exist
/docs/integrations/<sources/destinations>/<connector-name>/getting-started.md
. if it does, render that, otherwise (in the case where there is no internet connectivity or it just doesn't exist for some reason)... - check on the local image (can we just put this on the webapp image) to see if the docs exist:
/path/<connector-name>/getting-started.md
. if it does, render that, otherwise... - do not split the page. in other words do nothing.
- the idea here is we'd always prefer to get the most recent docs, but if they're not available then we have a fallback. and then in the worst case scenario we are just doing what we already do.
- check in the public github respository if the docs exist
Open Questions
- Is it okay to just put the markdown on the webapp image (@jamakase are you okay with this?)
- The markdown we use right now has some special syntax that gitbook (the tool we are using to host our docs) knows how to render (see example below). Ideally whatever markdown reader we use in the UI could handle this syntax. If it can't (which seems likely) we need to figure out what we want to do here (e.g. not use this syntax or something else).
# Google Adwords
{% hint style="warning" %}
If you don't already have a developer token from Google Ads, make sure you follow the [instructions](google-adwords.md#how-to-apply-for-the-developer-token) so your request doesn't get denied.
{% endhint %}
## Overview
source: docs/integrations/sources/google-adwords.md
for visibility: @avaidyanatha