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

take edk utilities out of preview #1135

Merged
merged 14 commits into from
Feb 3, 2023
Merged

Conversation

pnadolny13
Copy link
Contributor

@pnadolny13 pnadolny13 commented Jan 26, 2023

Closes #1115

  • hides transformers, ochestrators, and associated files from search.
  • removes the transformer and orchestrator options from the plugin drop down menu
  • those pages still exist if you have a url and are still served via the API
  • adds the edk repo url to the side bar in the plugin page below repo
  • I drafted some changes to the Airflow plugin page to remove "preview" and the description. I figured once we get airflow in a good place I can update the other 6-7 utilities with the same language.
    • do we still want a section to mention that its EDK based and what the EDK is? or does it not matter anymore?
    • we need some consistency with our edk naming convention, some are named after meltano and some are named after the source package owner i.e. airflow is the apache variant, most dbt plugins are the dbt-labs variant, but dbt-duckdb is jwillis, and superset has both apache and meltano. I think if we use an edk then it should be the variant.

Update: I added a section to every edk based plugin that explains what it is. I also adjusted how I hide those plugins from search so they still exists on plugin landings pages (i.e. transformers) but dont show up in search, this includes the associated files bundles.

@tayloramurphy what do you think?

Deploy preview:

@netlify
Copy link

netlify bot commented Jan 26, 2023

Deploy Preview for meltano-hub ready!

Name Link
🔨 Latest commit d649866
🔍 Latest deploy log https://app.netlify.com/sites/meltano-hub/deploys/63dbd85e7b19ed000828918b
😎 Deploy Preview https://deploy-preview-1135--meltano-hub.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@pnadolny13 pnadolny13 temporarily deployed to preview January 26, 2023 20:56 — with GitHub Actions Inactive
@pnadolny13 pnadolny13 temporarily deployed to preview January 26, 2023 22:27 — with GitHub Actions Inactive
@pnadolny13 pnadolny13 temporarily deployed to preview January 26, 2023 22:28 — with GitHub Actions Inactive
@pnadolny13 pnadolny13 temporarily deployed to preview January 26, 2023 22:30 — with GitHub Actions Inactive
@tayloramurphy
Copy link
Collaborator

@pnadolny13 excited to see this. We need to pair this with a corresponding PR to the docs themselves as there are several resources that recommend the non-utility versions of these plugins. I chatted this morning with @sbalnojan and @aaronsteers about this and we're generally supportive of it, but there are some considerations for existing users that we may want to account for.

@pnadolny13
Copy link
Contributor Author

pnadolny13 commented Jan 27, 2023

@tayloramurphy sounds good! Since the legacy pages still exist and are still served with the API I figured this wasnt blocked by the docs updates. We're only excluding these plugins from being discoverable on the hub. I'm totally fine with waiting though.

Let me know if you have opinions for the content on the EDK plugin pages.

@pnadolny13
Copy link
Contributor Author

we need some consistency with our edk naming convention, some are named after meltano and some are named after the source package owner i.e. airflow is the apache variant, most dbt plugins are the dbt-labs variant, but dbt-duckdb is jwillis, and superset has both apache and meltano. I think if we use an edk then it should be the variant.

@tayloramurphy related to variant names and ^^ I still think Superset is still a weird case. We have apache for the direct pip install and meltano for the extension version, both would be apache if we went by the source code naming. I also think theres a chance that we will get multiple EDK variants that have different features, what do you think about doing <source code org name>-<edk extension org name> (or a similar combo of the 2 names) as the variant so we'd have:

  • apache and apache-meltano for superset
  • dbt-snowflake -> dbt-labs-meltano
  • dbt-duckdb -> jwills-meltano

@tayloramurphy
Copy link
Collaborator

@pnadolny13 since we're not focused on superset right now I'm okay to just leave it as-is for now. There's an open issue around using a plugin_id instead of the variant to uniquely identify something. Until we have true competing ext implementations I'd rather just push this off to the future.

@pnadolny13 pnadolny13 temporarily deployed to preview January 30, 2023 21:30 — with GitHub Actions Inactive
@pnadolny13 pnadolny13 temporarily deployed to preview January 30, 2023 21:32 — with GitHub Actions Inactive
@pnadolny13 pnadolny13 temporarily deployed to preview January 30, 2023 21:33 — with GitHub Actions Inactive
@pnadolny13 pnadolny13 temporarily deployed to preview January 30, 2023 21:34 — with GitHub Actions Inactive
@pnadolny13 pnadolny13 temporarily deployed to preview January 30, 2023 21:36 — with GitHub Actions Inactive
@pnadolny13
Copy link
Contributor Author

@tayloramurphy I made the updates that we talked about. Let me know what you think.

Copy link
Collaborator

@tayloramurphy tayloramurphy left a comment

Choose a reason for hiding this comment

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

I think this is looking pretty good! I just wanted to add a link to the new docs section as well.

src/templates/Plugins.vue Outdated Show resolved Hide resolved
@tayloramurphy
Copy link
Collaborator

@pnadolny13 what do you think about hiding the related files (dbt, airflow)? That would bring it back down to just datahub, docker, docker compose, gitlab ci, and great expectations.

Co-authored-by: Taylor A. Murphy <taylor@meltano.com>
@pnadolny13 pnadolny13 temporarily deployed to preview January 31, 2023 17:37 — with GitHub Actions Inactive
@pnadolny13 pnadolny13 temporarily deployed to preview January 31, 2023 17:38 — with GitHub Actions Inactive
@pnadolny13
Copy link
Contributor Author

@tayloramurphy hiding from search and the files plugin page? Right now it should already be hidden in search but I can switch to remove them from the plugin page too. I think that makes sense and might be less confusing for users to not see those at all.

@pnadolny13 pnadolny13 temporarily deployed to preview January 31, 2023 17:41 — with GitHub Actions Inactive
@pnadolny13 pnadolny13 temporarily deployed to preview January 31, 2023 17:42 — with GitHub Actions Inactive
@pnadolny13 pnadolny13 temporarily deployed to preview January 31, 2023 17:43 — with GitHub Actions Inactive
@pnadolny13 pnadolny13 temporarily deployed to preview January 31, 2023 17:44 — with GitHub Actions Inactive
@tayloramurphy tayloramurphy requested review from aaronsteers and removed request for afolson February 1, 2023 16:26
@tayloramurphy tayloramurphy temporarily deployed to preview February 1, 2023 16:28 — with GitHub Actions Inactive
@tayloramurphy tayloramurphy temporarily deployed to preview February 1, 2023 16:30 — with GitHub Actions Inactive
@tayloramurphy
Copy link
Collaborator

tayloramurphy commented Feb 1, 2023

@pnadolny13 I just pushed up a change to hide the dbt files. confirming that links like https://deploy-preview-1135--meltano-hub.netlify.app/files/files-dbt-snowflake/ still work but they're not in search or on the files page 🙌

@pnadolny13
Copy link
Contributor Author

pnadolny13 commented Feb 1, 2023

@tayloramurphy once #1146 merges with schema support for the hidden attributes (once we decide if they should flow through the API or not) then these tests should pass.

UPDATE: that PR merged and I pulled it into this branch, looks like those errors are resolved.

@pnadolny13 pnadolny13 temporarily deployed to preview February 2, 2023 15:36 — with GitHub Actions Inactive
@pnadolny13 pnadolny13 temporarily deployed to preview February 2, 2023 15:38 — with GitHub Actions Inactive
@tayloramurphy
Copy link
Collaborator

Docs PR is merged. We can merge this on 2/3 it looks like.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Make EDK preview utilities default
2 participants