search

opensearch-project / dashboards-observability

Visualize and explore your logs, traces and metrics data in OpenSearch Dashboards
https://opensearch.org/docs/latest/observability-plugin/index/
Apache License 2.0
14 stars 46 forks source link

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

Open YANG-DB opened 3 weeks ago

YANG-DB commented 3 weeks ago

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

Swiddis commented 3 weeks ago

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.