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

Updating data sources docs # 7680 #7800

Merged

Conversation

AntonEliatra
Copy link
Contributor

@AntonEliatra AntonEliatra commented Jul 23, 2024

Description

Updating data sources documentation

Issues Resolved

Closes #7680

Version

2.11-2.16

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.

Copy link

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review.

Signed-off-by: AntonEliatra <[email protected]>
@hdhalter hdhalter added 3 - Tech review PR: Tech review in progress security labels Jul 23, 2024
@hdhalter hdhalter removed their assignment Jul 23, 2024
Copy link
Contributor

@derek-ho derek-ho left a comment

Choose a reason for hiding this comment

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

This mainly looks good to me, but I am no longer working on the feature. @RyanL1997 may be a better person/we probably want him to look over this once.

_dashboards/management/data-sources.md Outdated Show resolved Hide resolved
Comment on lines 39 to 42
1. **Management** -> **Dashboards Management** -> **Data sources**

Can be used for OpenSearch Data Stream Connections, further details are available at [Configuring and using multiple data sources]({{site.url}}{{site.baseurl}}/dashboards/management/multi-data-sources/)
2. **Management** -> **Data sources**
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't know if this is accurate anymore, since I think these two pages merged?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@derek-ho As far as I'm aware the pages are due to be merged in future versions, possibly 2.17, the current state (from 2.11 to current) is still via two separate pages.

Choose a reason for hiding this comment

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

we have merged the experience in 2.16. So this is correct.

Copy link
Contributor

Choose a reason for hiding this comment

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

Sorry for the confusion, @AntonEliatra! They DID make changes in 2.16 to the UI. Since the release is today (8/7), you should be able to see the updates tomorrow in the playground for testing purposes. In addition, @RyanL1997 is going to capture a video of the new flow and add it to a doc issue.

We'll have to update the rest of documentation for the new changes post-2.16.

Copy link
Collaborator

@vagimeli vagimeli Aug 13, 2024

Choose a reason for hiding this comment

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

@RyanL1997 I don't see the option Management > Data sources in my local environment running 2.16. I only have the option to go through Dashboards Management. Please let me know if Management > Data sources is available in 2.16. Please review lines 39--41 and make any necessary changes for technical accuracy.

Comment on lines 39 to 42
1. **Management** -> **Dashboards Management** -> **Data sources**

Can be used for OpenSearch Data Stream Connections, further details are available at [Configuring and using multiple data sources]({{site.url}}{{site.baseurl}}/dashboards/management/multi-data-sources/)
2. **Management** -> **Data sources**

Choose a reason for hiding this comment

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

we have merged the experience in 2.16. So this is correct.

Choose a reason for hiding this comment

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

For this one we may need to change the picture. Since the old datasource in observability has been unregistered

Choose a reason for hiding this comment

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

User can use the create button and navi to the card view for selection:
Screenshot 2024-07-31 at 10 21 03 AM
Screenshot 2024-07-31 at 10 21 13 AM

Copy link
Contributor Author

@AntonEliatra AntonEliatra Aug 1, 2024

Choose a reason for hiding this comment

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

@RyanL1997 Which version of OS are you using? With 2.15 I'm not able to see the view that you pasted above.
Screenshot 2024-08-01 at 17 41 31

Copy link
Collaborator

Choose a reason for hiding this comment

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

@AntonEliatra: The screenshots are from 2.16. We should be releasing in the next couple of days.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@Naarcha-AWS Should I change the version in the PR details to 2.15, as this will still be relevant?

Copy link
Contributor

Choose a reason for hiding this comment

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

Sorry for the confusion, @AntonEliatra! They DID make changes in 2.16 to the UI. Since the release is today (8/7), you should be able to see the updates tomorrow in the playground for testing purposes. In addition, @RyanL1997 is going to capture a video of the new flow and add it to a doc issue.

We'll have to update the rest of documentation for the new changes post-2.16.

Choose a reason for hiding this comment

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

Hi folks, thanks for the fast follow up and here is the issue I created with some details of flow diffs: #7948, feel free to drop some comments/thoughts if you have some questions. Thanks.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm working on updating the documentation based on the above. I think some effort is needed in explaining the difference between Zero-ETL and Managed Data Streams (MDS) before jumping into "How-to", as this can be a point of confusion for many users

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@RyanL1997 are you able to confirm when does the user need to configure :
plugins.query.datasources.encryption.masterkey

Copy link
Collaborator

@vagimeli vagimeli Aug 21, 2024

Choose a reason for hiding this comment

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

I'm working on updating the documentation based on the above. I think some effort is needed in explaining the difference between Zero-ETL and Managed Data Streams (MDS) before jumping into "How-to", as this can be a point of confusion for many users

@AntonEliatra @RyanL1997 Suggested text: When the multiple data sources feature is disabled (data_source.enabled: false), you can only see and work with local, unmanaged data sources on your cluster, and cannot work with or manage multiple data sources.

add prometheus in next steps

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]>
Signed-off-by: Melissa Vagi <[email protected]>
@vagimeli vagimeli merged commit fd709a1 into opensearch-project:main Aug 28, 2024
5 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Aug 28, 2024
* Updating data sources docs # 7680

Signed-off-by: AntonEliatra <[email protected]>

* Update connect-prometheus.md

Signed-off-by: AntonEliatra <[email protected]>

* Update data-sources.md

Signed-off-by: AntonEliatra <[email protected]>

* removing the screenshot from data sources

Signed-off-by: AntonEliatra <[email protected]>

* Revise text for accuracy and readability

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

* Copy edits to headings

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

* Revise lines 39-42

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

* Update connect-prometheus.md

Copy edits

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

* Update _dashboards/management/connect-prometheus.md

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

* Update _dashboards/management/connect-prometheus.md

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

* Update _dashboards/management/connect-prometheus.md

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

* Update connect-prometheus.md

revised text for conciseness and clarity

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

* Update _dashboards/management/data-sources.md

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

* Update _dashboards/management/data-sources.md

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

* Update data-sources.md

address editorial feedback

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

* Update _dashboards/management/connect-prometheus.md

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

* Update _dashboards/management/connect-prometheus.md

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

* Update _dashboards/management/connect-prometheus.md

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

* Update _dashboards/management/connect-prometheus.md

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

* Update _dashboards/management/connect-prometheus.md

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

* Update data-sources.md

add prometheus in next steps

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

* Address editorial feedback

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

* Update connect-prometheus.md

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

* Update connect-prometheus.md

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

* Update data-sources.md

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

* Update _dashboards/management/connect-prometheus.md

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

* Update _dashboards/management/connect-prometheus.md

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

* Update connect-prometheus.md

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

* Update connect-prometheus.md

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

* Update connect-prometheus.md

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

* Update connect-prometheus.md

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

* Update _dashboards/management/data-sources.md

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

* Update connect-prometheus.md

address editorial feedback

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

---------

Signed-off-by: AntonEliatra <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Heather Halter <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
Co-authored-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
(cherry picked from commit fd709a1)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
epugh pushed a commit to o19s/documentation-website that referenced this pull request Sep 12, 2024
* Updating data sources docs # 7680

Signed-off-by: AntonEliatra <[email protected]>

* Update connect-prometheus.md

Signed-off-by: AntonEliatra <[email protected]>

* Update data-sources.md

Signed-off-by: AntonEliatra <[email protected]>

* removing the screenshot from data sources

Signed-off-by: AntonEliatra <[email protected]>

* Revise text for accuracy and readability

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

* Copy edits to headings

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

* Revise lines 39-42

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

* Update connect-prometheus.md

Copy edits

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

* Update _dashboards/management/connect-prometheus.md

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

* Update _dashboards/management/connect-prometheus.md

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

* Update _dashboards/management/connect-prometheus.md

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

* Update connect-prometheus.md

revised text for conciseness and clarity

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

* Update _dashboards/management/data-sources.md

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

* Update _dashboards/management/data-sources.md

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

* Update data-sources.md

address editorial feedback

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

* Update _dashboards/management/connect-prometheus.md

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

* Update _dashboards/management/connect-prometheus.md

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

* Update _dashboards/management/connect-prometheus.md

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

* Update _dashboards/management/connect-prometheus.md

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

* Update _dashboards/management/connect-prometheus.md

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

* Update data-sources.md

add prometheus in next steps

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

* Address editorial feedback

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

* Update connect-prometheus.md

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

* Update connect-prometheus.md

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

* Update data-sources.md

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

* Update _dashboards/management/connect-prometheus.md

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

* Update _dashboards/management/connect-prometheus.md

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

* Update connect-prometheus.md

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

* Update connect-prometheus.md

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

* Update connect-prometheus.md

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

* Update connect-prometheus.md

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

* Update _dashboards/management/data-sources.md

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

* Update connect-prometheus.md

address editorial feedback

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

---------

Signed-off-by: AntonEliatra <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Heather Halter <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
Co-authored-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Eric Pugh <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
7 participants