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

Update the multiple data source documentation [Multiple Data Source][2.13.0] #6689

Merged
merged 13 commits into from
Mar 20, 2024

Conversation

Flyingliuhub
Copy link
Member

@Flyingliuhub Flyingliuhub commented Mar 14, 2024

Description

Update the existing multiple data source document to include the new changes introduced in version 2.13.0:

Feature flags:

  • data_source.authTypes
  • data_source.hideLocalCluster

Issues Resolved

Closes #6667

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.

@Flyingliuhub
Copy link
Member Author

@xinruiba @bandinib-amzn @BionIT , please take a look this PR as well.
cc: @seraphjiang

Signed-off-by: Flyingliuhub <[email protected]>
@hdhalter hdhalter added the 4 - Doc review PR: Doc review in progress label Mar 14, 2024
@hdhalter hdhalter added 3 - Tech review PR: Tech review in progress and removed 4 - Doc review PR: Doc review in progress labels Mar 15, 2024
@hdhalter
Copy link
Contributor

Thanks, @Flyingliuhub ! Please let us know when it is ready for a doc review.

@Flyingliuhub
Copy link
Member Author

Thanks, @Flyingliuhub ! Please let us know when it is ready for a doc review.

Thanks @hdhalter , it is ready for a doc review now. Please let us know if there any questions, so we can quickly update PR.

@hdhalter hdhalter added 4 - Doc review PR: Doc review in progress and removed 3 - Tech review PR: Tech review in progress labels Mar 15, 2024
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]>

Signed-off-by: Melissa Vagi <[email protected]>
@vagimeli
Copy link
Collaborator

Thanks, @Flyingliuhub ! Please let us know when it is ready for a doc review.

Thanks @hdhalter , it is ready for a doc review now. Please let us know if there any questions, so we can quickly update PR.

@Flyingliuhub Doc review is completed. I rewrote narrative for improved readability. Please review to confirm information retained technical accuracy. Once you approve, I'll move this into editorial review and then merge the PR. Thank you, Melissa

@Flyingliuhub
Copy link
Member Author

Flyingliuhub commented Mar 15, 2024

@Flyingliuhub Doc review is completed. I rewrote narrative for improved readability. Please review to confirm information retained technical accuracy. Once you approve, I'll move this into editorial review and then merge the PR. Thank you, Melissa

Thanks @vagimeli , There are a few words that need to be changed "This option hides the local cluster from the data source dropdown and index creation page, which is suitable for environments with or without a local OpenSearch cluster."
All others look good to me. Thank you for helping with the document.

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

Signed-off-by: Melissa Vagi <[email protected]>
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 completed. @natebower Editorial review requested via Asana. It's ready for your review. Thanks!

@vagimeli vagimeli removed the 4 - Doc review PR: Doc review in progress label Mar 18, 2024
@vagimeli vagimeli added the 5 - Editorial review PR: Editorial review in progress label Mar 18, 2024
@hdhalter hdhalter added the release-notes PR: Include this PR in the automated release notes label Mar 18, 2024
@Flyingliuhub
Copy link
Member Author

@Flyingliuhub Doc review is completed. I rewrote narrative for improved readability. Please review to confirm information retained technical accuracy. Once you approve, I'll move this into editorial review and then merge the PR.

Thank you Melissa and Heather. It looks good to me.

@hdhalter hdhalter changed the title [Multiple Data Source][2.13.0] Update the existing multiple data source document Update the multiple data source documentation [Multiple Data Source][2.13.0] Mar 18, 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.

@Flyingliuhub @vagimeli Please see my comments and changes and let me know if you have any questions. Thanks!

_dashboards/management/multi-data-sources.md Outdated Show resolved Hide resolved
Introduced 2.13
{: .label .label-purple }

A feature flag in your `opensearch_dashboards.yml` file enables you to show or hide authentication methods within the `data_source` plugin. The following example setting hides the authentication method for `AWSSigV4`, and the following 10-second demo shows the feature in action.
Copy link
Collaborator

Choose a reason for hiding this comment

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

"The following example setting, shown in a 10-second demo, hides the authentication method for AWSSigV4"?

_dashboards/management/multi-data-sources.md Outdated Show resolved Hide resolved
Introduced 2.13
{: .label .label-purple }

A feature flag in your `opensearch_dashboards.yml` file enables you to hide the local cluster option within the `data_source` plugin. This option hides the local cluster from the data source dropdown and index creation page, which is suitable for environments with or without a local OpenSearch cluster. The following example setting hides the local cluster, and the following 20-second demo shows the feature in action.
Copy link
Collaborator

Choose a reason for hiding this comment

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

"The following example setting, shown in a 20-second demo, hides the local cluster"? "ideal" instead of "suitable"?

Flyingliuhub and others added 6 commits March 19, 2024 14:02
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]>
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 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 9f85a88 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
…2.13.0] (opensearch-project#6689)

* adding two feature flags to doc

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

* fix style check

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

* Update multi-data-sources.md

Signed-off-by: Melissa Vagi <[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]>

* Update multi-data-sources.md

Signed-off-by: Melissa Vagi <[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]>

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

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Tao Liu <[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]>

* Update multi-data-sources.md

Signed-off-by: Melissa Vagi <[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: Flyingliuhub <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Tao Liu <[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] Update multiple data sources exiting documents to include the recently changes
4 participants