From 38c34c3986a6dde17613d388d845bb834e121497 Mon Sep 17 00:00:00 2001 From: Pat Nadolny Date: Fri, 3 Feb 2023 15:35:52 -0500 Subject: [PATCH] take edk utilities out of preview (#1135) Co-authored-by: Taylor A. Murphy --- CONTRIBUTING.md | 2 +- _data/meltano/files/files-airflow/meltano.yml | 1 + .../files/files-dbt-bigquery/meltano.yml | 1 + .../meltano/files/files-dbt-duckdb/meltano.yml | 1 + .../files/files-dbt-postgres/meltano.yml | 1 + .../files/files-dbt-redshift/meltano.yml | 1 + .../files/files-dbt-snowflake/meltano.yml | 1 + _data/meltano/files/files-dbt/meltano.yml | 1 + _data/meltano/utilities/airflow/apache.yml | 7 ++----- .../meltano/utilities/dbt-bigquery/dbt-labs.yml | 7 +++---- _data/meltano/utilities/dbt-duckdb/jwills.yml | 7 +++---- .../meltano/utilities/dbt-postgres/dbt-labs.yml | 8 +++----- .../meltano/utilities/dbt-redshift/dbt-labs.yml | 7 +++---- .../utilities/dbt-snowflake/dbt-labs.yml | 7 +++---- _data/meltano/utilities/superset/meltano.yml | 6 ++---- schemas/common/common.schema.json | 5 +++++ src/components/PluginSidebar.vue | 11 +++++++++++ src/components/Search.vue | 17 ++++++++++++++++- src/layouts/Header.vue | 6 ------ src/templates/Plugins.vue | 14 ++++++++++++++ 20 files changed, 73 insertions(+), 38 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3b18c7264..76b6e5959 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 { diff --git a/_data/meltano/files/files-airflow/meltano.yml b/_data/meltano/files/files-airflow/meltano.yml index 7c6ff648a..acbf0f93a 100644 --- a/_data/meltano/files/files-airflow/meltano.yml +++ b/_data/meltano/files/files-airflow/meltano.yml @@ -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 diff --git a/_data/meltano/files/files-dbt-bigquery/meltano.yml b/_data/meltano/files/files-dbt-bigquery/meltano.yml index 4b5107db0..58ced0407 100644 --- a/_data/meltano/files/files-dbt-bigquery/meltano.yml +++ b/_data/meltano/files/files-dbt-bigquery/meltano.yml @@ -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 diff --git a/_data/meltano/files/files-dbt-duckdb/meltano.yml b/_data/meltano/files/files-dbt-duckdb/meltano.yml index 136b7cbc0..64d6546ed 100644 --- a/_data/meltano/files/files-dbt-duckdb/meltano.yml +++ b/_data/meltano/files/files-dbt-duckdb/meltano.yml @@ -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 diff --git a/_data/meltano/files/files-dbt-postgres/meltano.yml b/_data/meltano/files/files-dbt-postgres/meltano.yml index 2dd9e4efb..6ad7ed191 100644 --- a/_data/meltano/files/files-dbt-postgres/meltano.yml +++ b/_data/meltano/files/files-dbt-postgres/meltano.yml @@ -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 diff --git a/_data/meltano/files/files-dbt-redshift/meltano.yml b/_data/meltano/files/files-dbt-redshift/meltano.yml index 890c43281..5dc5f7ae8 100644 --- a/_data/meltano/files/files-dbt-redshift/meltano.yml +++ b/_data/meltano/files/files-dbt-redshift/meltano.yml @@ -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 diff --git a/_data/meltano/files/files-dbt-snowflake/meltano.yml b/_data/meltano/files/files-dbt-snowflake/meltano.yml index 72b876799..b98544387 100644 --- a/_data/meltano/files/files-dbt-snowflake/meltano.yml +++ b/_data/meltano/files/files-dbt-snowflake/meltano.yml @@ -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 diff --git a/_data/meltano/files/files-dbt/meltano.yml b/_data/meltano/files/files-dbt/meltano.yml index 77719580e..4a4a7c07c 100644 --- a/_data/meltano/files/files-dbt/meltano.yml +++ b/_data/meltano/files/files-dbt/meltano.yml @@ -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 diff --git a/_data/meltano/utilities/airflow/apache.yml b/_data/meltano/utilities/airflow/apache.yml index bb3528905..7446f3322 100644 --- a/_data/meltano/utilities/airflow/apache.yml +++ b/_data/meltano/utilities/airflow/apache.yml @@ -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 diff --git a/_data/meltano/utilities/dbt-bigquery/dbt-labs.yml b/_data/meltano/utilities/dbt-bigquery/dbt-labs.yml index 5c37823f1..108d6871f 100644 --- a/_data/meltano/utilities/dbt-bigquery/dbt-labs.yml +++ b/_data/meltano/utilities/dbt-bigquery/dbt-labs.yml @@ -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 diff --git a/_data/meltano/utilities/dbt-duckdb/jwills.yml b/_data/meltano/utilities/dbt-duckdb/jwills.yml index e64981b66..846ff14dd 100644 --- a/_data/meltano/utilities/dbt-duckdb/jwills.yml +++ b/_data/meltano/utilities/dbt-duckdb/jwills.yml @@ -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 diff --git a/_data/meltano/utilities/dbt-postgres/dbt-labs.yml b/_data/meltano/utilities/dbt-postgres/dbt-labs.yml index 5e5591b82..1cbc999dc 100644 --- a/_data/meltano/utilities/dbt-postgres/dbt-labs.yml +++ b/_data/meltano/utilities/dbt-postgres/dbt-labs.yml @@ -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 diff --git a/_data/meltano/utilities/dbt-redshift/dbt-labs.yml b/_data/meltano/utilities/dbt-redshift/dbt-labs.yml index f7600ad0c..f93636a48 100644 --- a/_data/meltano/utilities/dbt-redshift/dbt-labs.yml +++ b/_data/meltano/utilities/dbt-redshift/dbt-labs.yml @@ -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 diff --git a/_data/meltano/utilities/dbt-snowflake/dbt-labs.yml b/_data/meltano/utilities/dbt-snowflake/dbt-labs.yml index e2fd6b487..d37379652 100644 --- a/_data/meltano/utilities/dbt-snowflake/dbt-labs.yml +++ b/_data/meltano/utilities/dbt-snowflake/dbt-labs.yml @@ -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 diff --git a/_data/meltano/utilities/superset/meltano.yml b/_data/meltano/utilities/superset/meltano.yml index 433bbefa8..50bf00f6b 100644 --- a/_data/meltano/utilities/superset/meltano.yml +++ b/_data/meltano/utilities/superset/meltano.yml @@ -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 diff --git a/schemas/common/common.schema.json b/schemas/common/common.schema.json index 2d977b4bc..65c6bf9ff 100644 --- a/schemas/common/common.schema.json +++ b/schemas/common/common.schema.json @@ -125,6 +125,11 @@ } } } + }, + "hidden": { + "type": "boolean", + "description": "Whether the plugin should be shown when listing or not.", + "default": false } } } diff --git a/src/components/PluginSidebar.vue b/src/components/PluginSidebar.vue index 977bab80b..91fcf4d5b 100644 --- a/src/components/PluginSidebar.vue +++ b/src/components/PluginSidebar.vue @@ -144,6 +144,16 @@ +
+

EDK Extension Repo

+
+ {{ ext_repo }} +
+
+

Maintainer

    @@ -232,6 +242,7 @@ export default { "metrics", "maintainer", "pip_url", + "ext_repo", ], computed: { parsedRepo() { diff --git a/src/components/Search.vue b/src/components/Search.vue index 76939a2fa..7798da278 100644 --- a/src/components/Search.vue +++ b/src/components/Search.vue @@ -124,7 +124,22 @@ export default { 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 { diff --git a/src/layouts/Header.vue b/src/layouts/Header.vue index 1be606019..56df7ea15 100644 --- a/src/layouts/Header.vue +++ b/src/layouts/Header.vue @@ -34,12 +34,6 @@ export default {

    Loaders

     - -

    Transformers

    -     - -

    Orchestrators

    -

    Utilities

     diff --git a/src/templates/Plugins.vue b/src/templates/Plugins.vue index bb1690f0d..15fdf7aa7 100644 --- a/src/templates/Plugins.vue +++ b/src/templates/Plugins.vue @@ -115,6 +115,18 @@ v-if="$page.plugins.pluginType === 'file'" v-html="$page.plugins.definition_rendered" > + + +

    EDK Based Plugin

    + + 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 + this section of the Meltano docs. If you have any feedback or suggestions, add them to the + EDK repo. +

    Available Variants

    @@ -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" />
@@ -357,6 +370,7 @@ query Plugins($path: String!, $name: String!) { pluginTypePlural pip_url repo + ext_repo maintenance_status keywords domain_url