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

Add documentation page for Vega Visualizations #6711

Merged
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.

@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
@vagimeli
Copy link
Contributor

vagimeli 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

vagimeli and others added 3 commits March 19, 2024 12:55
@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.

Signed-off-by: Melissa Vagi <[email protected]>

Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

Signed-off-by: Melissa Vagi <[email protected]>
Copy link
Contributor

@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
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!

@@ -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
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Huy Nguyen <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Huy Nguyen <[email protected]>
huyaboo and others added 5 commits March 20, 2024 09:42
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Huy Nguyen <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Huy Nguyen <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

Signed-off-by: Melissa Vagi <[email protected]>
@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
* Add documentation page for Vega Visualizations

Signed-off-by: Huy Nguyen <[email protected]>

* Rename indices to indexes

Signed-off-by: Huy Nguyen <[email protected]>

* Update vega.md

Signed-off-by: Melissa Vagi <[email protected]>

Signed-off-by: Melissa Vagi <[email protected]>

* Update vega.md

Signed-off-by: Melissa Vagi <[email protected]>

Signed-off-by: Melissa Vagi <[email protected]>

* Modify the example Vega spec + fix typos

Signed-off-by: Huy Nguyen <[email protected]>

* Update vega.md

Signed-off-by: Melissa Vagi <[email protected]>

Signed-off-by: Melissa Vagi <[email protected]>

* Update vega.md

Signed-off-by: Melissa Vagi <[email protected]>

Signed-off-by: Melissa Vagi <[email protected]>

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

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Huy Nguyen <[email protected]>

* Update _dashboards/visualize/vega.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Huy Nguyen <[email protected]>

* Update _dashboards/visualize/vega.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Huy Nguyen <[email protected]>

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

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Huy Nguyen <[email protected]>

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

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update multi-data-sources.md

Signed-off-by: Melissa Vagi <[email protected]>

Signed-off-by: Melissa Vagi <[email protected]>

---------

Signed-off-by: Huy Nguyen <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3 - Done Issue is done/complete release-notes PR: Include this PR in the automated release notes v2.13.0
Projects
None yet
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