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.

Sign up for GitHub

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

Jump to bottom

Add documentation page for Vega Visualizations #6711

Merged
merged 17 commits into from
Mar 20, 2024
Merged

Add documentation page for Vega Visualizations #6711

merged 17 commits into from
Mar 20, 2024

Conversation

huyaboo
Copy link
Member

@huyaboo huyaboo commented Mar 18, 2024

Description

This PR adds a documentation page for Vega plugin usage, including how to use the plugin when MDS is enabled.

Issues Resolved

Closes #6709

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@huyaboo
Add documentation page for Vega Visualizations
8e5d6d9 
Signed-off-by: Huy Nguyen <73027756+huyaboo@users.noreply.github.com>
@hdhalter hdhalter added 4 - Doc review PR: Doc review in progress release-notes PR: Include this PR in the automated release notes v2.13.0 labels Mar 18, 2024
huyaboo and others added 4 commits March 18, 2024 14:04
@huyaboo
Merge branch 'main' into vega-mds
1baa6b1
@huyaboo
Rename indices to indexes
05af8e2 
Signed-off-by: Huy Nguyen <73027756+huyaboo@users.noreply.github.com>
@huyaboo
Merge branch 'main' into vega-mds
92ac66f
@vagimeli
Update vega.md
463064f 
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli
Copy link
Collaborator

vagimeli commented Mar 19, 2024 •
edited
Loading

@huyaboo Doc review is complete. Please see my edits to confirm they haven't changed technical accuracy. Also, please provide me the Vega plugin README link. We should include the configuration example and a sentence about users enabling Vega in their opensearch_dashboards.yml file. I added the text I think we need to include. Is the plugin enabled:true by default? Please review for technical accuracy. I'll add the link and make any text changes. Thank you, @vagimeli

vagimeli and others added 3 commits March 19, 2024 12:55
@vagimeli
Update vega.md
f8e9a90 
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@huyaboo
Modify the example Vega spec + fix typos
0963a8f 
Signed-off-by: Huy Nguyen <73027756+huyaboo@users.noreply.github.com>
@huyaboo
Merge branch 'main' into vega-mds
22f29c1
@huyaboo
Copy link
Member Author

huyaboo commented Mar 19, 2024

@huyaboo Doc review is complete. Please see my edits to confirm they haven't changed technical accuracy. Also, please provide me the Vega plugin README link. We should include the configuration example and a sentence about users enabling Vega in their opensearch_dashboards.yml file. I added the text I think we need to include. Is the plugin enabled:true by default? Please review for technical accuracy. I'll add the link and make any text changes. Thank you, @vagimeli

Thanks @vagimeli , I changed the Vega spec example and a couple of minor adjustments to the text. vis_type_vega.enabled is true by default. Everything else looks accurate to me.

@vagimeli
Update vega.md
284a07d 
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli
Update vega.md
ffab523 
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
vagimeli
vagimeli approved these changes Mar 19, 2024
View reviewed changes
Copy link
Collaborator

@vagimeli vagimeli left a comment

Choose a reason for hiding this comment

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

Doc review complete. Moving into editorial.

@vagimeli vagimeli added 5 - Editorial review PR: Editorial review in progress and removed 4 - Doc review PR: Doc review in progress labels Mar 19, 2024
natebower
natebower reviewed Mar 20, 2024
View reviewed changes
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

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

@huyaboo @vagimeli Just a few minor changes. Thanks!

_dashboards/management/multi-data-sources.md Outdated
@@ -36,16 +36,16 @@ A data source connection specifies the parameters needed to connect to a data so
To create a new data source connection:

1. From the OpenSearch Dashboards main menu, select **Dashboards Management** > **Data sources** > **Create data source connection**.
2. Add the required information to each field to configure **Connection Details** and **Authentication Method**.

2. Add the required information to each field to configure **Connection Details** and **Authentication Method**.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Should "the" precede Connection Details?

_dashboards/management/multi-data-sources.md Outdated Show resolved Hide resolved
_dashboards/management/multi-data-sources.md Outdated Show resolved Hide resolved
_dashboards/management/multi-data-sources.md Outdated Show resolved Hide resolved
_dashboards/visualize/vega.md Outdated Show resolved Hide resolved
_dashboards/visualize/vega.md Outdated Show resolved Hide resolved
huyaboo and others added 2 commits March 20, 2024 09:40
@huyaboo @natebower
Update _dashboards/management/multi-data-sources.md
12749fe 
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Huy Nguyen <73027756+huyaboo@users.noreply.github.com>
@huyaboo @natebower
Update _dashboards/visualize/vega.md
dbe043b 
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Huy Nguyen <73027756+huyaboo@users.noreply.github.com>
huyaboo and others added 5 commits March 20, 2024 09:42
@huyaboo @natebower
Update _dashboards/visualize/vega.md
53443e2 
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Huy Nguyen <73027756+huyaboo@users.noreply.github.com>
@huyaboo @natebower
Update _dashboards/management/multi-data-sources.md
4800380 
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Huy Nguyen <73027756+huyaboo@users.noreply.github.com>
@vagimeli @natebower
Update _dashboards/management/multi-data-sources.md
3d42822 
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli
Update multi-data-sources.md
ea2f3fd 
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli
Merge branch 'main' into vega-mds
81200d6
@vagimeli vagimeli added 3 - Done Issue is done/complete and removed 5 - Editorial review PR: Editorial review in progress labels Mar 20, 2024
@vagimeli vagimeli merged commit 1feb4d3 into opensearch-project:main Mar 20, 2024
4 checks passed
CaptainDredge pushed a commit to CaptainDredge/documentation-website that referenced this pull request Mar 22, 2024
@huyaboo @vagimeli @natebower
Add documentation page for Vega Visualizations (opensearch-project#6711)
cf70b86 
* Add documentation page for Vega Visualizations

Signed-off-by: Huy Nguyen <73027756+huyaboo@users.noreply.github.com>

* Rename indices to indexes

Signed-off-by: Huy Nguyen <73027756+huyaboo@users.noreply.github.com>

* Update vega.md

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

* Update vega.md

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

* Modify the example Vega spec + fix typos

Signed-off-by: Huy Nguyen <73027756+huyaboo@users.noreply.github.com>

* Update vega.md

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

* Update vega.md

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

* Update _dashboards/management/multi-data-sources.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Huy Nguyen <73027756+huyaboo@users.noreply.github.com>

* Update _dashboards/visualize/vega.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Huy Nguyen <73027756+huyaboo@users.noreply.github.com>

* Update _dashboards/visualize/vega.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Huy Nguyen <73027756+huyaboo@users.noreply.github.com>

* Update _dashboards/management/multi-data-sources.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Huy Nguyen <73027756+huyaboo@users.noreply.github.com>

* Update _dashboards/management/multi-data-sources.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

* Update multi-data-sources.md

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

---------

Signed-off-by: Huy Nguyen <73027756+huyaboo@users.noreply.github.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@natebower natebower natebower left review comments

@vagimeli vagimeli vagimeli approved these changes

@hdhalter hdhalter Awaiting requested review from hdhalter

@kolchfa-aws kolchfa-aws Awaiting requested review from kolchfa-aws kolchfa-aws is a code owner

@Naarcha-AWS Naarcha-AWS Awaiting requested review from Naarcha-AWS Naarcha-AWS is a code owner

@AMoo-Miki AMoo-Miki Awaiting requested review from AMoo-Miki AMoo-Miki is a code owner

@dlvenable dlvenable Awaiting requested review from dlvenable dlvenable is a code owner

@stephen-crawford stephen-crawford Awaiting requested review from stephen-crawford stephen-crawford is a code owner

Assignees

@vagimeli vagimeli

Labels
3 - Done Issue is done/complete release-notes PR: Include this PR in the automated release notes v2.13.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[DOC] Add documentation about how to use Vega Visualization plugin in OpenSearch Dashboards
4 participants
@huyaboo @vagimeli @natebower @hdhalter