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

[FEATURE]Add Getting-Started Tab in the integration dialog #1934

Closed
YANG-DB opened this issue Jul 9, 2024 · 0 comments
Closed

[FEATURE]Add Getting-Started Tab in the integration dialog #1934

YANG-DB opened this issue Jul 9, 2024 · 0 comments
Labels
enhancement New feature or request integrations Used to denote items related to the Integrations project untriaged

Comments

@YANG-DB
Copy link
Member

YANG-DB commented Jul 9, 2024

Is your feature request related to a problem?
Today as part of the getting started campaign we would like to be able to see the getting started process for each integration as part of the integration dialog itself.

What solution would you like?
The following assets have been added to the catalog content

  • getting-started schema json field
  • getting-started.md markdown document in the getting-started folder of the integration
  • getting-started-1.0.0.ndjson asset containing the markdown document in the form of a dashboard
  "getting-started": {
    "ingestion": ["otel-collector","data-prepper"],
    "structured": "true",
    "technology": "OpenTelemetry",
    "protocol": ["otel"],
    "info": "https://github.com/opensearch-project/opensearch-catalog/tree/main/integrations/observability/otel-services/info/Tutorial.md",
    "live-sample": "true",
    "workflows": [
      {

We would like to add a tab containing the getting-started markdown rendered as a dialog to show the steps needed for using this integration.

img

Selecting the Getting-Started button would produce the content of the getting-started markdown :

Screenshot 2024-07-09 at 3 28 45 PM

Do you have any additional context?

@YANG-DB YANG-DB added enhancement New feature or request untriaged integrations Used to denote items related to the Integrations project labels Jul 9, 2024
@YANG-DB YANG-DB closed this as completed Jul 19, 2024
@YANG-DB YANG-DB mentioned this issue Jul 19, 2024
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request integrations Used to denote items related to the Integrations project untriaged
Projects
None yet
Development

No branches or pull requests

1 participant