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

improve link checker #6797

Merged
merged 16 commits into from
Nov 8, 2021
6 changes: 5 additions & 1 deletion .github/workflows/doc-link-check.json
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,12 @@
{
"reason": "Test only scaffold connector",
"pattern": "destinations/scaffold-"
},
{
"reason": "Returns a 403 for many valid pages",
"pattern": "https://mvnrepository.com/artifact/"
}
],
"retryOn429": false,
"aliveStatusCodes": [200, 206, 401, 403, 429, 503]
"aliveStatusCodes": [200, 206, 429, 503]
}
19 changes: 13 additions & 6 deletions .github/workflows/doc-link-check.yml
Original file line number Diff line number Diff line change
@@ -1,21 +1,28 @@
# Perform link check on all markdown files
name: Doc Link Checker (Full)
# Add any custom exclusions to doc-link-check.json

name: Doc Link Checker

on:
push:
branches:
- master

jobs:
markdown-link-check:
timeout-minutes: 50
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
# check all files on master
- uses: gaurav-nelson/github-action-markdown-link-check@v1
if: github.ref == 'refs/heads/master'
with:
use-quiet-mode: 'no'
use-verbose-mode: 'yes'
use-quiet-mode: 'yes'
check-modified-files-only: 'no'
config-file: .github/workflows/doc-link-check.json
base-branch: ${{ github.base_ref }}
# check changed files for branches
- uses: gaurav-nelson/github-action-markdown-link-check@v1
if: github.ref != 'refs/heads/master'
with:
use-quiet-mode: 'yes'
check-modified-files-only: 'yes'
config-file: .github/workflows/doc-link-check.json
4 changes: 2 additions & 2 deletions docs/deploying-airbyte/on-kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ Airbyte allows scaling sync workloads horizontally using Kubernetes. The core co

### Cluster Setup
For local testing we recommend following one of the following setup guides:
* [Docker Desktop (Mac)](https://docs.docker.com/desktop/kubernetes/)
* [Minikube](https://minikube.sigs.k8s.io/docs/start/)
* [Docker Desktop (Mac)](https://docs.docker.com/desktop/kubernetes)
* [Minikube](https://minikube.sigs.k8s.io/docs/start)
* NOTE: Start Minikube with at least 4gb RAM with `minikube start --memory=4000`
* [Kind](https://kind.sigs.k8s.io/docs/user/quick-start/)

Expand Down
1 change: 0 additions & 1 deletion docs/integrations/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,6 @@ Airbyte uses a grading system for connectors to help users understand what to ex
|[GitLab](./sources/gitlab.md)| Beta |
|[Google Ads](./sources/google-ads.md)| Beta |
|[Google Adwords](./sources/google-adwords.md)| Beta |
|[Google Analytics](./sources/googleanalytics.md)| Beta |
|[Google Analytics v4](./sources/google-analytics-v4.md)| Beta |
|[Google Directory](./sources/google-directory.md)| Certified |
|[Google Search Console](./sources/google-search-console.md)| Beta |
Expand Down
3 changes: 2 additions & 1 deletion docs/integrations/sources/amplitude.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,9 @@ The Amplitude connector should gracefully handle Amplitude API limitations under
* Amplitude Secret Key

### Setup guide

<!-- markdown-link-check-disable -->
Please read [How to get your API key and Secret key](https://help.amplitude.com/hc/en-us/articles/360058073772-Create-and-manage-organizations-and-projects#view-and-edit-your-project-information).
<!-- markdown-link-check-enable -->

## Changelog

Expand Down
3 changes: 2 additions & 1 deletion docs/integrations/sources/iterable.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,9 @@ The Iterable connector should not run into Iterable API limitations under normal
* Iterable API Key

### Setup guide

<!-- markdown-link-check-disable -->
Please read [How to find your API key](https://support.iterable.com/hc/en-us/articles/360043464871-API-Keys-#creating-api-keys).
<!-- markdown-link-check-enable -->
Copy link
Contributor

Choose a reason for hiding this comment

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

You can also use <!-- markdown-link-check-disable-next-line --> by the way, which only requires one line of change.


## CHANGELOG

Expand Down
4 changes: 3 additions & 1 deletion docs/integrations/sources/klaviyo.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,5 +46,7 @@ Please [create an issue](https://github.com/airbytehq/airbyte/issues) if you see

### Setup guide

<!-- markdown-link-check-disable -->
Please follow these [steps](https://help.klaviyo.com/hc/en-us/articles/115005062267-How-to-Manage-Your-Account-s-API-Keys#your-private-api-keys3)
to obtain Private API Key for your account.
to obtain Private API Key for your account.
<!-- markdown-link-check-enable -->
4 changes: 2 additions & 2 deletions docs/integrations/sources/mixpanel.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,11 @@ The Mixpanel connector should not run into Mixpanel API limitations under normal
* Project region `US` or `EU`

### Setup guide

<!-- markdown-link-check-disable -->
Please read [Find API Secret](https://help.mixpanel.com/hc/en-us/articles/115004502806-Find-Project-Token-).

Select the correct region (EU or US) for your Mixpanel project. See detail [here](https://help.mixpanel.com/hc/en-us/articles/360039135652-Data-Residency-in-EU)

<!-- markdown-link-check-enable -->

## CHANGELOG

Expand Down
3 changes: 2 additions & 1 deletion docs/integrations/sources/trello.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,9 @@ The Trello connector should not run into Trello API limitations under normal usa
* Trello API Key

### Setup guide

<!-- markdown-link-check-disable -->
Please read [How to get your APIs Token and Key](https://developer.atlassian.com/cloud/trello/guides/rest-api/authorization/#using-basic-oauth) or you can log in to Trello and visit [Developer API Keys](https://trello.com/app-key/).
<!-- markdown-link-check-enable -->

## Changelog

Expand Down
2 changes: 1 addition & 1 deletion docs/project-overview/changelog/connectors.md
Original file line number Diff line number Diff line change
Expand Up @@ -537,7 +537,7 @@ Other progress on connectors:

## 10/30/2020

**New sources:** [Salesforce](../../integrations/sources/salesforce.md), [Google Analytics](../../integrations/sources/googleanalytics.md), [Hubspot](../../integrations/sources/hubspot.md), [GitHub](../../integrations/sources/github.md), [Google Sheets](../../integrations/sources/google-sheets.md), [Rest APIs](connectors.md), and [MySQL](../../integrations/sources/mysql.md)
**New sources:** [Salesforce](../../integrations/sources/salesforce.md), Google Analytics, [Hubspot](../../integrations/sources/hubspot.md), [GitHub](../../integrations/sources/github.md), [Google Sheets](../../integrations/sources/google-sheets.md), [Rest APIs](connectors.md), and [MySQL](../../integrations/sources/mysql.md)

## 10/21/2020

Expand Down