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

[BUG]Replace "resource" vocabulary with "workflow" in integration installation #1881

Open
YANG-DB opened this issue Jun 7, 2024 · 1 comment
Labels
bug Something isn't working integrations Used to denote items related to the Integrations project

Comments

@YANG-DB
Copy link
Member

YANG-DB commented Jun 7, 2024

What is the bug?
Existing documentation misguides the phrase "resource" with "workflow" in integration installation
This is confusing and misleading into thinking of how to install the different workflows in each integration

How can one reproduce the bug?
Steps to reproduce the behavior:

  1. Go to integration
  2. Click on set-up
  3. Select S3 data-source
  4. Scroll down to resources
  5. See list of workflow described as resources

What is the expected behavior?
Rephrase the text and add link for each integration to the documentation page of the integration itself that explains about the different workflows

@YANG-DB YANG-DB added bug Something isn't working untriaged integrations Used to denote items related to the Integrations project labels Jun 7, 2024
@Swiddis Swiddis removed the untriaged label Jun 7, 2024
@Swiddis
Copy link
Collaborator

Swiddis commented Jun 7, 2024

The intended interpretation here was that workflows are sets of resources (= assets in the integration config), and selecting workflows is equivalent to toggling resources in bulk. How should we make the terminology clear such that users are aware of this mapping?

The best way to approach this may be the proposal by @brijos to add a display of the toggled resources during workflow selection. Then we get two fixes for the cost of one: the connection between workflows and resources is made immediately obvious, and the users are more aware of what they're actually installing with their workflow selection. If we do it right we probably won't even need to document it: the UI will do the explaining.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working integrations Used to denote items related to the Integrations project
Projects
None yet
Development

No branches or pull requests

2 participants