Updates to setup guides for APIs #26870
Conversation
nataliekwong
added
the
area/documentation
| @@ -73,3 +73,4 @@ The Amplitude connector ideally should gracefully handle Amplitude API limitatio | |||
| | 0.1.2 | 2021-09-21 | [6353](https://github.com/airbytehq/airbyte/pull/6353) | Correct output schemas on cohorts, events, active\_users, and average\_session\_lengths streams | | |||
| | 0.1.1 | 2021-06-09 | [3973](https://github.com/airbytehq/airbyte/pull/3973) | Add AIRBYTE\_ENTRYPOINT for kubernetes support | | |||
| | 0.1.0 | 2021-06-08 | [3664](https://github.com/airbytehq/airbyte/pull/3664) | New Source: Amplitude | | |||
| <!-- /env:oss --> | |||
There was a problem hiding this comment.
more of a long term thing, should we separate setup instructions from the changelogs (have them in different files for example) and only display setup instructions in app?
There was a problem hiding this comment.
Yep! That is what we will move toward as I understand from the Metadata plan.
docs/integrations/sources/asana.md
Outdated
| @@ -15,11 +15,10 @@ Please follow these [steps](https://developers.asana.com/docs/personal-access-to | |||
| 1. [Log into your Airbyte Cloud](https://cloud.airbyte.com/workspaces) account. | |||
| 2. In the left navigation bar, click **Sources**. In the top-right corner, click **+new source**. | |||
| 3. Set the name for your source | |||
| 4. Enter your `personal_access_token` | |||
| 4. Authenticate using OAuth or enter your `personal_access_token`. Please follow these [steps](https://developers.asana.com/docs/personal-access-token) to obtain Personal Access Token for your account. | |||
There was a problem hiding this comment.
| 4. Authenticate using OAuth or enter your `personal_access_token`. Please follow these [steps](https://developers.asana.com/docs/personal-access-token) to obtain Personal Access Token for your account. | |
| 4. Authenticate using OAuth (recommended) or enter your `personal_access_token`. Please follow these [steps](https://developers.asana.com/docs/personal-access-token) to obtain Personal Access Token for your account. |
|
|
||
|
|
||
| ## Setup guide | ||
| 1. Name your BambooHR connector |
There was a problem hiding this comment.
Out of curiosity why did you decide to work on this connectors doc?
There was a problem hiding this comment.
I ended up randomly on this one; I had started just exploring sources from top alphabetically (A - Z) and found this doc particularly bad.
|
|
||
| ## Setup guide | ||
| 1. Name your BambooHR connector | ||
| 2. Enter your `api_key`. To generate an API key, users should log in and click their name in the upper right-hand corner of any page to get to the user context menu. If they have sufficient permissions, there will be an "API Keys" option in that menu to go to the page. |
There was a problem hiding this comment.
What are the permissions needed?
There was a problem hiding this comment.
Good point; I took this from their API docs. Adjusting to administrator.
| Please be sure to authenticate with the email (personal or work) that you used to sign in to the Bing ads/Microsoft ads platform. | ||
| ::: | ||
|
|
||
| 4. Request your [Microsoft developer token](https://docs.microsoft.com/en-us/advertising/guides/get-started?view=bingads-13#get-developer-token) in the Microsoft Advertising Developer Portal account tab. |
There was a problem hiding this comment.
fwiw this will go away soon https://github.com/airbytehq/airbyte/issues/26380
There was a problem hiding this comment.
Glad to hear it! This process looks painful.
What
Goal is to improve the usability of docs for Cloud users by centering on setup within the app.
Creates new in-app docs for:
Update existing docs with improved setup information (so non-Cloud users can benefit too):
Update existing docs with OSS tags
馃毃 User Impact 馃毃
Are there any breaking changes? What is the end result perceived by the user?
None