Skip to content

Commit

Permalink
take edk utilities out of preview (#1135)
Browse files Browse the repository at this point in the history
Co-authored-by: Taylor A. Murphy <taylor@meltano.com>
  • Loading branch information
pnadolny13 and tayloramurphy authored Feb 3, 2023
1 parent 30be240 commit 38c34c3
Show file tree
Hide file tree
Showing 20 changed files with 73 additions and 38 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ Markdown pages are rendered using the `MarkdownDocs` template, using `/src/templ

### GraphQL query for markdown docs

To better understand the data model for markdown data files, use the following query at the GraphQL endpoint (usually [http://localhost:8080/\_\_explore](http://localhost:8080/__explore)):
To better understand the data model for markdown data files, use the following query at the GraphQL endpoint (usually [http://localhost:8080/\_\_explore](http://localhost:8080/___explore)):

```graphql
query MarkdownDocs {
Expand Down
1 change: 1 addition & 0 deletions _data/meltano/files/files-airflow/meltano.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
definition: are bundled with the Airflow orchestrator.
domain_url: https://airflow.apache.org/
hidden: true
label: Airflow
logo_url: /assets/logos/files/airflow.png
maintenance_status: active
Expand Down
1 change: 1 addition & 0 deletions _data/meltano/files/files-dbt-bigquery/meltano.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
definition: are bundled with the dbt-bigquery transformer.
domain_url: https://www.getdbt.com/
hidden: true
label: dbt Bigquery
logo_url: /assets/logos/files/dbt-bigquery.png
maintenance_status: active
Expand Down
1 change: 1 addition & 0 deletions _data/meltano/files/files-dbt-duckdb/meltano.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
definition: are bundled with the dbt-duckdb transformer.
domain_url: https://www.getdbt.com/
hidden: true
label: dbt DuckDB
logo_url: /assets/logos/files/dbt-duckdb.png
maintenance_status: active
Expand Down
1 change: 1 addition & 0 deletions _data/meltano/files/files-dbt-postgres/meltano.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
definition: are bundled with the dbt-postgres transformer.
domain_url: https://www.getdbt.com/
hidden: true
label: dbt Postgres
logo_url: /assets/logos/files/dbt-postgres.png
maintenance_status: active
Expand Down
1 change: 1 addition & 0 deletions _data/meltano/files/files-dbt-redshift/meltano.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
definition: are bundled with the dbt-redshift transformer.
domain_url: https://www.getdbt.com/
hidden: true
label: dbt Redshift
logo_url: /assets/logos/files/dbt-redshift.png
maintenance_status: active
Expand Down
1 change: 1 addition & 0 deletions _data/meltano/files/files-dbt-snowflake/meltano.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
definition: are bundled with the dbt-snowflake transformer.
domain_url: https://www.getdbt.com/
hidden: true
label: dbt Snowflake
logo_url: /assets/logos/files/dbt-snowflake.png
maintenance_status: active
Expand Down
1 change: 1 addition & 0 deletions _data/meltano/files/files-dbt/meltano.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
definition: are bundled with the dbt transformer.
domain_url: https://www.getdbt.com/
hidden: true
label: dbt Files
logo_url: /assets/logos/files/dbt.png
maintenance_status: active
Expand Down
7 changes: 2 additions & 5 deletions _data/meltano/utilities/airflow/apache.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,14 @@ commands:
definition: |
is an [orchestrator](https://docs.meltano.com/concepts/plugins#orchestrators) that allows for workflows to be programmatically authored, scheduled, and monitored.
### EDK Preview
This utility plugin is meant to be used in favor of the [Airflow orchestrator plugin type](/orchestrators/airflow).
This utility is in a preview stage of readiness. It is based upon our Extension Developer Kit (EDK) which is the new way to build and add plugins to Meltano Hub.
This preview of Airflow will replace the native orchestrator once it comes out of preview. In the meantime, we would appreciate any feedback in the [EDK repo](https://github.com/meltano/edk/) and in the [Airflow Extension repo](https://github.com/meltano/airflow-ext/).
docs: https://docs.meltano.com/guide/orchestration
executable: airflow_invoker
ext_repo: https://github.com/meltano/airflow-ext
keywords:
- meltano_edk
label: Airflow (EDK preview)
label: Airflow (EDK)
logo_url: /assets/logos/orchestrators/airflow.png
maintenance_status: active
name: airflow
Expand Down
7 changes: 3 additions & 4 deletions _data/meltano/utilities/dbt-bigquery/dbt-labs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,15 +50,14 @@ commands:
definition: |
is an adapter-specific dbt [transformer](https://docs.meltano.com/concepts/plugins#transformers) for running SQL-based transformations on data stored in your warehouse.
### EDK Preview
This utility is in a preview stage of readiness. It is based upon our Extension Developer Kit (EDK) which is the new way to build and add plugins to Meltano Hub.
This preview of dbt will replace the native transformer once it comes out of preview. In the meantime, we would appreciate any feedback in the [EDK repo](https://github.com/meltano/edk/) and in the [dbt Extension repo](https://github.com/meltano/dbt-ext/).
This utility plugin is meant to be used in favor of the [dbt-bigquery transformer plugin type](/transformers/dbt-bigquery).
docs: https://docs.meltano.com/guide/transformation
executable: dbt_invoker
ext_repo: https://github.com/meltano/dbt-ext
keywords:
- meltano_edk
label: dbt BigQuery (EDK preview)
label: dbt BigQuery (EDK)
logo_url: /assets/logos/utilities/dbt.png
maintenance_status: active
name: dbt-bigquery
Expand Down
7 changes: 3 additions & 4 deletions _data/meltano/utilities/dbt-duckdb/jwills.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,16 +50,15 @@ commands:
definition: |
is an adapter-specific dbt [transformer](https://docs.meltano.com/concepts/plugins#transformers) for running SQL-based transformations on data stored in your warehouse.
### EDK Preview
This utility is in a preview stage of readiness. It is based upon our Extension Developer Kit (EDK) which is the new way to build and add plugins to Meltano Hub.
This preview of dbt will replace the native transformer once it comes out of preview. In the meantime, we would appreciate any feedback in the [EDK repo](https://github.com/meltano/edk/) and in the [dbt Extension repo](https://github.com/meltano/dbt-ext/).
This utility plugin is meant to be used in favor of the [dbt-duckdb transformer plugin type](/transformers/dbt-duckdb).
docs: https://docs.meltano.com/guide/transformation
domain_url: https://www.getdbt.com/
executable: dbt_invoker
ext_repo: https://github.com/meltano/dbt-ext
keywords:
- meltano_edk
label: dbt DuckDB (EDK preview)
label: dbt DuckDB (EDK)
logo_url: /assets/logos/utilities/dbt.png
maintenance_status: active
name: dbt-duckdb
Expand Down
8 changes: 3 additions & 5 deletions _data/meltano/utilities/dbt-postgres/dbt-labs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,15 +50,13 @@ commands:
definition: |
is an adapter-specific dbt [transformer](https://docs.meltano.com/concepts/plugins#transformers) for running SQL-based transformations on data stored in your warehouse.
### EDK Preview
This utility is in a preview stage of readiness. It is based upon our Extension Developer Kit (EDK) which is the new way to build and add plugins to Meltano Hub.
This preview of dbt will replace the native transformer once it comes out of preview. In the meantime, we would appreciate any feedback in the [EDK repo](https://github.com/meltano/edk/) and in the [dbt Extension repo](https://github.com/meltano/dbt-ext/).
docs: https://docs.meltano.com/guide/transformation
This utility plugin is meant to be used in favor of the [dbt-postgres transformer plugin type](/transformers/dbt-postgres).
executable: dbt_invoker
ext_repo: https://github.com/meltano/dbt-ext
keywords:
- meltano_edk
label: dbt PostgreSQL (EDK preview)
label: dbt PostgreSQL (EDK)
logo_url: /assets/logos/utilities/dbt.png
maintenance_status: active
name: dbt-postgres
Expand Down
7 changes: 3 additions & 4 deletions _data/meltano/utilities/dbt-redshift/dbt-labs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,15 +50,14 @@ commands:
definition: |
is an adapter-specific dbt [transformer](https://docs.meltano.com/concepts/plugins#transformers) for running SQL-based transformations on data stored in your warehouse.
### EDK Preview
This utility is in a preview stage of readiness. It is based upon our Extension Developer Kit (EDK) which is the new way to build and add plugins to Meltano Hub.
This preview of dbt will replace the native transformer once it comes out of preview. In the meantime, we would appreciate any feedback in the [EDK repo](https://github.com/meltano/edk/) and in the [dbt Extension repo](https://github.com/meltano/dbt-ext/).
This utility plugin is meant to be used in favor of the [dbt-redshift transformer plugin type](/transformers/dbt-redshift).
docs: https://docs.meltano.com/guide/transformation
executable: dbt_invoker
ext_repo: https://github.com/meltano/dbt-ext
keywords:
- meltano_edk
label: dbt Redshift (EDK preview)
label: dbt Redshift (EDK)
logo_url: /assets/logos/utilities/dbt.png
maintenance_status: active
name: dbt-redshift
Expand Down
7 changes: 3 additions & 4 deletions _data/meltano/utilities/dbt-snowflake/dbt-labs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,15 +50,14 @@ commands:
definition: |
is an adapter-specific dbt [transformer](https://docs.meltano.com/concepts/plugins#transformers) for running SQL-based transformations on data stored in your warehouse.
### EDK Preview
This utility is in a preview stage of readiness. It is based upon our Extension Developer Kit (EDK) which is the new way to build and add plugins to Meltano Hub.
This preview of dbt will replace the native transformer once it comes out of preview. In the meantime, we would appreciate any feedback in the [EDK repo](https://github.com/meltano/edk/) and in the [dbt Extension repo](https://github.com/meltano/dbt-ext/).
This utility plugin is meant to be used in favor of the [dbt-snowflake transformer plugin type](/transformers/dbt-snowflake).
docs: https://docs.meltano.com/guide/transformation
executable: dbt_invoker
ext_repo: https://github.com/meltano/dbt-ext
keywords:
- meltano_edk
label: dbt Snowflake (EDK preview)
label: dbt Snowflake (EDK)
logo_url: /assets/logos/utilities/dbt.png
maintenance_status: active
name: dbt-snowflake
Expand Down
6 changes: 2 additions & 4 deletions _data/meltano/utilities/superset/meltano.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,14 @@ commands:
definition: |
is a modern data exploration and visualization platform.
### EDK Preview
This utility is in a preview stage of readiness. It is based upon our Extension Developer Kit (EDK) which is the new way to build and add plugins to Meltano Hub.
This preview of Superset will replace the existing Superset utility once it comes out of preview. In the meantime, we would appreciate any feedback in the [EDK repo](https://github.com/meltano/edk/) and in the [Superset Extension repo](https://github.com/meltano/superset-ext/).
description: A modern, enterprise-ready business intelligence web application.
docs: https://docs.meltano.com/guide/analysis
domain_url: https://superset.apache.org/
executable: superset_invoker
ext_repo: https://github.com/meltano/superset-ext
keywords:
- analysis
label: Superset (EDK preview)
label: Superset (EDK)
logo_url: /assets/logos/utilities/superset.png
maintenance_status: active
name: superset
Expand Down
5 changes: 5 additions & 0 deletions schemas/common/common.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,11 @@
}
}
}
},
"hidden": {
"type": "boolean",
"description": "Whether the plugin should be shown when listing or not.",
"default": false
}
}
}
11 changes: 11 additions & 0 deletions src/components/PluginSidebar.vue
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,16 @@
</ul>
</div>
<div v-if="ext_repo">
<p class="text-lg">EDK Extension Repo</p>
<div>
<img class="w-8 h-4 inline gap-x-11" src="../assets/images/git-alt-brands.svg" /><a
:href="ext_repo"
>{{ ext_repo }}</a
>
</div>
</div>
<div>
<p class="text-lg">Maintainer</p>
<ul class="list-disc list-inside shields">
Expand Down Expand Up @@ -232,6 +242,7 @@ export default {
"metrics",
"maintainer",
"pip_url",
"ext_repo",
],
computed: {
parsedRepo() {
Expand Down
17 changes: 16 additions & 1 deletion src/components/Search.vue
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,22 @@ export default {
<static-query lang="graphql">
query {
allPlugins(
filter: { isDefault: { eq: true }, hidden: { ne: true }, pluginType: { ne: "transform" } }
filter: {
isDefault: { eq: true }
hidden: { ne: true }
pluginType: { nin: ["transform", "orchestrator", "transformer"] }
name: {
nin: [
"files-airflow"
"files-dbt-snowflake"
"files-dbt-redshift"
"files-dbt-postgres"
"files-dbt-duckdb"
"files-dbt-bigquery"
"files-dbt"
]
}
}
) {
edges {
node {
Expand Down
6 changes: 0 additions & 6 deletions src/layouts/Header.vue
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,6 @@ export default {
<g-link class="nav__link" to="/loaders/">
<h3>Loaders</h3>
</g-link>
<g-link class="nav__link" to="/transformers/">
<h3>Transformers</h3>
</g-link>
<g-link class="nav__link" to="/orchestrators">
<h3>Orchestrators</h3>
</g-link>
<g-link class="nav__link" to="/utilities/">
<h3>Utilities</h3>
</g-link>
Expand Down
14 changes: 14 additions & 0 deletions src/templates/Plugins.vue
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,18 @@
v-if="$page.plugins.pluginType === 'file'"
v-html="$page.plugins.definition_rendered"
></span>

<span v-if="$page.plugins.pluginType === 'utility' && $page.plugins.ext_repo">
<p class="text-3xl py-4">EDK Based Plugin</p>

This utility is based on the Meltano Extension Developer Kit (EDK) which is the
preferred way to build and add non-Singer plugins to Meltano Hub. For more
information about the EDK, please read
<a href="https://docs.meltano.com/guide/advanced-topics#extension-developer-kit-edk"
>this section of the Meltano docs</a
>. If you have any feedback or suggestions, add them to the
<g-link to="https://github.com/meltano/edk/">EDK repo</g-link>.
</span>
</p>
<span class="space-y-3" v-if="filteredVariants && filteredVariants.length > 1">
<p class="text-2xl">Available Variants</p>
Expand Down Expand Up @@ -296,6 +308,7 @@
:maintainer="$page.plugins.maintainer"
:pip_url="$page.plugins.pip_url"
:airbyte_name="$page.plugins.airbyte_name"
:ext_repo="$page.plugins.ext_repo"
/>
</div>
</div>
Expand Down Expand Up @@ -357,6 +370,7 @@ query Plugins($path: String!, $name: String!) {
pluginTypePlural
pip_url
repo
ext_repo
maintenance_status
keywords
domain_url
Expand Down

0 comments on commit 38c34c3

Please sign in to comment.