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

fix(doc): update doc url to point to generated docs #4860

Merged
merged 4 commits into from
May 13, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ const azureAdConfig: SourceConfig = {
type: 'azure-ad',
placeholderRecipe,
displayName: 'Azure AD',
docsUrl: 'https://datahubproject.io/docs/metadata-ingestion/source_docs/azure-ad',
docsUrl: 'https://datahubproject.io/docs/generated/ingestion/sources/azure-ad',
logoUrl: azureLogo,
};

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ const bigqueryConfig: SourceConfig = {
type: 'bigquery',
placeholderRecipe,
displayName: 'BigQuery',
docsUrl: 'https://datahubproject.io/docs/metadata-ingestion/source_docs/bigquery/',
docsUrl: 'https://datahubproject.io/docs/generated/ingestion/sources/bigquery/',
logoUrl: bigqueryLogo,
};

Expand Down
2 changes: 1 addition & 1 deletion datahub-web-react/src/app/ingest/source/conf/glue/glue.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ const glueConfig: SourceConfig = {
type: 'glue',
placeholderRecipe,
displayName: 'Glue',
docsUrl: 'https://datahubproject.io/docs/metadata-ingestion/source_docs/glue',
docsUrl: 'https://datahubproject.io/docs/generated/ingestion/sources/glue',
logoUrl: glueLogo,
};

Expand Down
2 changes: 1 addition & 1 deletion datahub-web-react/src/app/ingest/source/conf/hive/hive.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ const hiveConfig: SourceConfig = {
type: 'hive',
placeholderRecipe,
displayName: 'Hive',
docsUrl: 'https://datahubproject.io/docs/metadata-ingestion/source_docs/hive/',
docsUrl: 'https://datahubproject.io/docs/generated/ingestion/sources/hive/',
logoUrl: hiveLogo,
};

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ const kafkaConfig: SourceConfig = {
type: 'kafka',
placeholderRecipe,
displayName: 'Kafka',
docsUrl: 'https://datahubproject.io/docs/metadata-ingestion/source_docs/kafka/',
docsUrl: 'https://datahubproject.io/docs/generated/ingestion/sources/kafka/',
logoUrl: kafkaLogo,
};

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ const lookerConfig: SourceConfig = {
type: 'looker',
placeholderRecipe,
displayName: 'Looker',
docsUrl: 'https://datahubproject.io/docs/metadata-ingestion/source_docs/looker/',
docsUrl: 'https://datahubproject.io/docs/generated/ingestion/sources/looker/',
logoUrl: lookerLogo,
};

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ const mongoConfig: SourceConfig = {
type: 'mongodb',
placeholderRecipe,
displayName: 'MongoDB',
docsUrl: 'https://datahubproject.io/docs/metadata-ingestion/source_docs/mongodb/',
docsUrl: 'https://datahubproject.io/docs/generated/ingestion/sources/mongodb/',
logoUrl: mongodbLogo,
};

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ const mysqlConfig: SourceConfig = {
type: 'mysql',
placeholderRecipe,
displayName: 'MySQL',
docsUrl: 'https://datahubproject.io/docs/metadata-ingestion/source_docs/mysql/',
docsUrl: 'https://datahubproject.io/docs/generated/ingestion/sources/mysql/',
logoUrl: mysqlLogo,
};

Expand Down
2 changes: 1 addition & 1 deletion datahub-web-react/src/app/ingest/source/conf/okta/okta.ts
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ const oktaConfig: SourceConfig = {
type: 'okta',
placeholderRecipe,
displayName: 'Okta',
docsUrl: 'https://datahubproject.io/docs/metadata-ingestion/source_docs/okta',
docsUrl: 'https://datahubproject.io/docs/generated/ingestion/sources/okta',
logoUrl: oktaLogo,
};

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ const oracleConfig: SourceConfig = {
type: 'oracle',
placeholderRecipe,
displayName: 'Oracle',
docsUrl: 'https://datahubproject.io/docs/metadata-ingestion/source_docs/oracle/',
docsUrl: 'https://datahubproject.io/docs/generated/ingestion/sources/oracle/',
logoUrl: oracleLogo,
};

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ const postgresConfig: SourceConfig = {
type: 'postgres',
placeholderRecipe,
displayName: 'Postgres',
docsUrl: 'https://datahubproject.io/docs/metadata-ingestion/source_docs/postgres/',
docsUrl: 'https://datahubproject.io/docs/generated/ingestion/sources/postgres/',
logoUrl: postgresLogo,
};

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ const redshiftConfig: SourceConfig = {
type: 'redshift',
placeholderRecipe,
displayName: 'Redshift',
docsUrl: 'https://datahubproject.io/docs/metadata-ingestion/source_docs/redshift/',
docsUrl: 'https://datahubproject.io/docs/generated/ingestion/sources/redshift/',
logoUrl: redshiftLogo,
};

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ const snowflakeConfig: SourceConfig = {
type: 'snowflake',
placeholderRecipe,
displayName: 'Snowflake',
docsUrl: 'https://datahubproject.io/docs/metadata-ingestion/source_docs/snowflake/',
docsUrl: 'https://datahubproject.io/docs/generated/ingestion/sources/snowflake/',
logoUrl: snowflakeLogo,
};

Expand Down
2 changes: 1 addition & 1 deletion docs/how/add-custom-data-platform.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ You can also ingest a Data Platform at runtime using either a file-based ingesti

```
---
# see https://datahubproject.io/docs/metadata-ingestion/source_docs/file for complete documentation
# see https://datahubproject.io/docs/generated/ingestion/sources/file for complete documentation
source:
type: "file"
config:
Expand Down
2 changes: 1 addition & 1 deletion docs/how/add-user-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Define an [ingestion recipe](https://datahubproject.io/docs/metadata-ingestion/#

```
---
# see https://datahubproject.io/docs/metadata-ingestion/source_docs/file for complete documentation
# see https://datahubproject.io/docs/generated/ingestion/sources/file for complete documentation
source:
type: "file"
config:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
# see https://datahubproject.io/docs/metadata-ingestion/source_docs/bigquery for complete documentation
# see https://datahubproject.io/docs/generated/ingestion/sources/bigquery for complete documentation
source:
type: "bigquery"
config:
Expand Down
2 changes: 1 addition & 1 deletion metadata-ingestion/examples/recipes/dbt_to_datahub.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
# see https://datahubproject.io/docs/metadata-ingestion/source_docs/dbt for complete documentation
# see https://datahubproject.io/docs/generated/ingestion/sources/dbt for complete documentation
source:
type: "dbt"
config:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# see https://datahubproject.io/docs/metadata-ingestion/source_docs/file for complete documentation
# see https://datahubproject.io/docs/generated/ingestion/sources/file for complete documentation
source:
type: "file"
config:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# see https://datahubproject.io/docs/metadata-ingestion/source_docs/file for complete documentation
# see https://datahubproject.io/docs/generated/ingestion/sources/file for complete documentation
source:
type: "file"
config:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# see https://datahubproject.io/docs/metadata-ingestion/source_docs/file for complete documentation
# see https://datahubproject.io/docs/generated/ingestion/sources/file for complete documentation
source:
type: "file"
config:
Expand Down
2 changes: 1 addition & 1 deletion metadata-ingestion/examples/recipes/feast_to_datahub.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# see https://datahubproject.io/docs/metadata-ingestion/source_docs/feast for complete documentation
# see https://datahubproject.io/docs/generated/ingestion/sources/feast for complete documentation
source:
type: feast
config:
Expand Down
2 changes: 1 addition & 1 deletion metadata-ingestion/examples/recipes/file_to_console.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
# see https://datahubproject.io/docs/metadata-ingestion/source_docs/file for complete documentation
# see https://datahubproject.io/docs/generated/ingestion/sources/file for complete documentation
source:
type: "file"
config:
Expand Down
2 changes: 1 addition & 1 deletion metadata-ingestion/examples/recipes/file_to_datahub.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
# see https://datahubproject.io/docs/metadata-ingestion/source_docs/file for complete documentation
# see https://datahubproject.io/docs/generated/ingestion/sources/file for complete documentation
source:
type: "file"
config:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
# see https://datahubproject.io/docs/metadata-ingestion/source_docs/file for complete documentation
# see https://datahubproject.io/docs/generated/ingestion/sources/file for complete documentation
source:
type: "file"
config:
Expand Down
2 changes: 1 addition & 1 deletion metadata-ingestion/examples/recipes/file_to_file.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
# see https://datahubproject.io/docs/metadata-ingestion/source_docs/file for complete documentation
# see https://datahubproject.io/docs/generated/ingestion/sources/file for complete documentation
source:
type: "file"
config:
Expand Down
2 changes: 1 addition & 1 deletion metadata-ingestion/examples/recipes/glue_to_datahub.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# see https://datahubproject.io/docs/metadata-ingestion/source_docs/glue for complete documentation
# see https://datahubproject.io/docs/generated/ingestion/sources/glue for complete documentation
source:
type: glue
config:
Expand Down
2 changes: 1 addition & 1 deletion metadata-ingestion/examples/recipes/ingest.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# see https://datahubproject.io/docs/metadata-ingestion/source_docs/file for complete documentation
# see https://datahubproject.io/docs/generated/ingestion/sources/file for complete documentation
source:
type: file
config:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
run_id: kafka-connect-test

# see https://datahubproject.io/docs/metadata-ingestion/source_docs/kafka-connect for complete documentation
# see https://datahubproject.io/docs/generated/ingestion/sources/kafka-connect for complete documentation
source:
type: "kafka-connect"
config:
Expand Down
2 changes: 1 addition & 1 deletion metadata-ingestion/examples/recipes/kafka_to_console.toml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# see https://datahubproject.io/docs/metadata-ingestion/source_docs/kafka for complete documentation
# see https://datahubproject.io/docs/generated/ingestion/sources/kafka for complete documentation
[source]
type="kafka"
[source.config.connection]
Expand Down
2 changes: 1 addition & 1 deletion metadata-ingestion/examples/recipes/kafka_to_console.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
# see https://datahubproject.io/docs/metadata-ingestion/source_docs/kafka for complete documentation
# see https://datahubproject.io/docs/generated/ingestion/sources/kafka for complete documentation
source:
type: "kafka"
config:
Expand Down
2 changes: 1 addition & 1 deletion metadata-ingestion/examples/recipes/kafka_to_datahub.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
# see https://datahubproject.io/docs/metadata-ingestion/source_docs/kafka for complete documentation
# see https://datahubproject.io/docs/generated/ingestion/sources/kafka for complete documentation
source:
type: "kafka"
config:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
# see https://datahubproject.io/docs/metadata-ingestion/source_docs/kafka for complete documentation
# see https://datahubproject.io/docs/generated/ingestion/sources/kafka for complete documentation
source:
type: "kafka"
config:
Expand Down
2 changes: 1 addition & 1 deletion metadata-ingestion/examples/recipes/ldap_to_console.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# see https://datahubproject.io/docs/metadata-ingestion/source_docs/ldap for complete documentation
# see https://datahubproject.io/docs/generated/ingestion/sources/ldap for complete documentation
source:
type: "ldap"
config:
Expand Down
2 changes: 1 addition & 1 deletion metadata-ingestion/examples/recipes/metabase_to_rest.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# see https://datahubproject.io/docs/metadata-ingestion/source_docs/metabase for complete documentation
# see https://datahubproject.io/docs/generated/ingestion/sources/metabase for complete documentation
source:
type: "metabase"
config:
Expand Down
2 changes: 1 addition & 1 deletion metadata-ingestion/examples/recipes/mode_to_datahub.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# see https://datahubproject.io/docs/metadata-ingestion/source_docs/metabase for complete documentation
# see https://datahubproject.io/docs/generated/ingestion/sources/metabase for complete documentation
source:
type: "mode"
config:
Expand Down
2 changes: 1 addition & 1 deletion metadata-ingestion/examples/recipes/mongodb_to_datahub.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# see https://datahubproject.io/docs/metadata-ingestion/source_docs/mongodb for complete documentation
# see https://datahubproject.io/docs/generated/ingestion/sources/mongodb for complete documentation
source:
type: "mongodb"
config:
Expand Down
2 changes: 1 addition & 1 deletion metadata-ingestion/examples/recipes/mssql_to_console.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
# see https://datahubproject.io/docs/metadata-ingestion/source_docs/mssql for complete documentation
# see https://datahubproject.io/docs/generated/ingestion/sources/mssql for complete documentation
source:
type: mssql
config:
Expand Down
2 changes: 1 addition & 1 deletion metadata-ingestion/examples/recipes/mssql_to_datahub.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
# see https://datahubproject.io/docs/metadata-ingestion/source_docs/mssql for complete documentation
# see https://datahubproject.io/docs/generated/ingestion/sources/mssql for complete documentation
source:
type: mssql
config:
Expand Down
2 changes: 1 addition & 1 deletion metadata-ingestion/examples/recipes/mysql_to_datahub.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
# see https://datahubproject.io/docs/metadata-ingestion/source_docs/mysql for complete documentation
# see https://datahubproject.io/docs/generated/ingestion/sources/mysql for complete documentation
source:
type: "mysql"
config:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
# see https://datahubproject.io/docs/metadata-ingestion/source_docs/nifi for complete documentation
# see https://datahubproject.io/docs/generated/ingestion/sources/nifi for complete documentation
source:
type: "nifi"
config:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
# see https://datahubproject.io/docs/metadata-ingestion/source_docs/redshift for complete documentation
# see https://datahubproject.io/docs/generated/ingestion/sources/redshift for complete documentation
source:
type: "redshift"
config:
Expand Down
2 changes: 1 addition & 1 deletion metadata-ingestion/examples/recipes/s3_to_file.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
# see https://datahubproject.io/docs/metadata-ingestion/source_docs/s3_data_lake for complete documentation
# see https://datahubproject.io/docs/generated/ingestion/sources/s3_data_lake for complete documentation
source:
type: "s3"
config:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# in this example, AWS creds are detected automatically

# see https://datahubproject.io/docs/metadata-ingestion/source_docs/sagemaker/ for complete documentation
# see https://datahubproject.io/docs/generated/ingestion/sources/sagemaker/ for complete documentation
source:
type: sagemaker
config:
Expand Down
2 changes: 1 addition & 1 deletion metadata-ingestion/examples/recipes/secured_kafka.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# see https://datahubproject.io/docs/metadata-ingestion/source_docs/kafka for complete documentation
# see https://datahubproject.io/docs/generated/ingestion/sources/kafka for complete documentation
source:
type: "kafka"
config:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
# see https://datahubproject.io/docs/metadata-ingestion/source_docs/snowflake/#config-details-1 for complete documentation
# see https://datahubproject.io/docs/generated/ingestion/sources/snowflake/#config-details-1 for complete documentation
source:
type: snowflake-usage
config:
Expand Down
2 changes: 1 addition & 1 deletion metadata-ingestion/examples/recipes/superset_to_rest.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# see https://datahubproject.io/docs/metadata-ingestion/source_docs/superset for complete documentation
# see https://datahubproject.io/docs/generated/ingestion/sources/superset for complete documentation
source:
type: "superset"
config:
Expand Down
2 changes: 1 addition & 1 deletion metadata-ingestion/examples/recipes/tableau_to_datahub.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# see https://datahubproject.io/docs/metadata-ingestion/source_docs/metabase for complete documentation
# see https://datahubproject.io/docs/generated/ingestion/sources/metabase for complete documentation
source:
type: "tableau"
config:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
run_id: kafka-connect-run

# see https://datahubproject.io/docs/metadata-ingestion/source_docs/kafka-connect for complete documentation
# see https://datahubproject.io/docs/generated/ingestion/sources/kafka-connect for complete documentation
source:
type: "kafka-connect"
config:
Expand Down
2 changes: 1 addition & 1 deletion smoke-test/tests/cypress/example_to_datahub_rest.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# see https://datahubproject.io/docs/metadata-ingestion/source_docs/file for complete documentation
# see https://datahubproject.io/docs/generated/ingestion/sources/file for complete documentation
source:
type: "file"
config:
Expand Down