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

[DOC] Create new page and content for Using Vega and Vega-Lite #1178

Closed
alicejw1 opened this issue Sep 12, 2022 · 9 comments
Closed

[DOC] Create new page and content for Using Vega and Vega-Lite #1178

alicejw1 opened this issue Sep 12, 2022 · 9 comments
Assignees
Milestone

Comments

@alicejw1
Copy link
Contributor

alicejw1 commented Sep 12, 2022

What do you want to do?

  • [ X] Add new documentation
    This ticket will write the Vega documentation for OpenSearch.
    About this request:
    This ticket will write the Vega documentation for OpenSearch. After docs are written, need to add the UI Help menu item back to the Dashboards to link to this document.
    See ticket 658 to remove link in Dashboards Help menu for docs that do not yet exist.

Basic doc outline

  1. Vega overview - Vega is a visualization type that you can create in OS Dashboards. Vega uses a declarative language that you can use to describe your data.
  2. How to create a Vega visualization in OS Dashboards. (steps)
  3. References - List of Vega docs: Tutorials and examples

[Feature Proposal]:Vega Visualizations

What other resources are available?
Elastic documentation for Vega can be used as a conceptual resource: https://www.elastic.co/guide/en/kibana/7.10/vega-reference.html

Vega's documentation: https://vega.github.io/vega/about/.

Image of Dashboards Vega help menu: https://user-images.githubusercontent.com/32652829/172729444-98aee7f1-c191-4dfb-87c8-01bd067d7dc8.png

@alicejw1
Copy link
Contributor Author

Hi @vagimeli - This is for a new dashboards doc. I'm starting an outline with overview and how-to steps after some research.

@vagimeli
Copy link
Collaborator

Hi @alicejw-aws I'll schedule a brainstorming session. Here's working draft for the visualizations section, which will include documentation for each visualization type. The initial outline I started follows:

Visualizations (main page)

  • L1 Page: Visualizations overview - give user high-level overview of what, when, and why to use visualizations and types [META-DOC] Dashboards - Visualize new site page and content #992
  • L2: Pages: Separate page for each visualization type, including details about that specific type - give users how to each the specific type

@Naarcha-AWS Naarcha-AWS added 2 - In progress Issue/PR: The issue or PR is in progress. and removed untriaged labels Sep 13, 2022
@Naarcha-AWS Naarcha-AWS added this to the 2022-Q3 milestone Sep 13, 2022
@alicejw1 alicejw1 removed their assignment Oct 4, 2022
@alicejw1
Copy link
Contributor Author

alicejw1 commented Oct 4, 2022

Hi @vagimeli , sounds good. Let's meet to discuss the 1-pager first draft.

@vagimeli
Copy link
Collaborator

@kavilla Please let me know if you're the appropriate technical reviewer for the new content. Draft is in progress.

@vagimeli
Copy link
Collaborator

vagimeli commented Nov 3, 2022

Addressing @joshuarrrr feedback. UX working on UI steps graphic

@vagimeli vagimeli linked a pull request Dec 5, 2022 that will close this issue
1 task
@vagimeli vagimeli added v2.5.0 'Issues and PRs related to version v2.5.0' and removed 2 - In progress Issue/PR: The issue or PR is in progress. labels Dec 16, 2022
@vagimeli
Copy link
Collaborator

@joshuarrrr and @vagimeli working to wrap this up for 2.5

@vagimeli vagimeli changed the title [DOC] Write OpenSearch Vega documentation [DOC] New content visualization type: OpenSearch Vega and Vega-Lite How-to Dec 30, 2022
@vagimeli vagimeli changed the title [DOC] New content visualization type: OpenSearch Vega and Vega-Lite How-to [DOC] New content: Viz type - OpenSearch Vega and Vega-Lite Dec 30, 2022
@vagimeli
Copy link
Collaborator

@joshuarrrr Can we publish the foundational content we have to date and iterate as needed?

@vagimeli vagimeli changed the title [DOC] New content: Viz type - OpenSearch Vega and Vega-Lite [DOC] Visualization types - Vega and Vega-Lite Dec 30, 2022
@Naarcha-AWS Naarcha-AWS removed the v2.5.0 'Issues and PRs related to version v2.5.0' label Jan 3, 2023
@vagimeli vagimeli changed the title [DOC] Visualization types - Vega and Vega-Lite [DOC] Visualization types - Using Vega and Vega-Lite Jan 9, 2023
@vagimeli vagimeli changed the title [DOC] Visualization types - Using Vega and Vega-Lite [DOC] Create new page and content for Using Vega and Vega-Lite Jan 20, 2023
@joshuarrrr
Copy link
Member

We'll also want to capture usage of built-in event handlers such as adding filters: opensearch-project/OpenSearch-Dashboards#3640

@joshuarrrr
Copy link
Member

@vagimeli Is there a draft of this doc? I don't see anything linked here.

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