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

phase_took documentation #5154

Merged
merged 3 commits into from
Oct 17, 2023
Merged

Conversation

dzane17
Copy link
Contributor

@dzane17 dzane17 commented Oct 4, 2023

Description

Added documentation for:

  1. phase_took _search api request parameter
  2. search.phase_took_enabled cluster setting

OpenSearch PR: opensearch-project/OpenSearch#10351
GitHub Issue: opensearch-project/OpenSearch#9650

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.

Signed-off-by: David Zane <davizane@amazon.com>
@hdhalter
Copy link
Contributor

hdhalter commented Oct 4, 2023

@dzane17 - Is this related to a new feature, say, in 2.11? Or is it just missing content from a previous release? Thanks.

@dzane17
Copy link
Contributor Author

dzane17 commented Oct 4, 2023

@hdhalter This is a new feature in 2.11 or 2.12. I added the PR in the description

@hdhalter hdhalter added this to the v2.12 milestone Oct 11, 2023
@hdhalter hdhalter added the 1 - Backlog Issue: The issue is unassigned or assigned but not started label Oct 11, 2023
@hdhalter
Copy link
Contributor

Thanks! I added the 2.12 label. Can you please add the dev issue to the unified project?

@dzane17
Copy link
Contributor Author

dzane17 commented Oct 16, 2023

@hdhalter Done ✅

@vagimeli
Copy link
Contributor

vagimeli commented Oct 17, 2023

@hdhalter @dzane17 Are these changes to be merged for 2.12 documentation? Or, do they need to be backported to 2.11 documentation? If these changes need to be applied to 2.11 documentation, then we need to remove the 2.12 label and add the backport 2.11 label, and merge the backport PR.

Once the changes go through doc review (that is, content review by a technical writer), the doc reviewer will approve the changes, and then @dzane17 can merge this PR.

visibility cc: @kolchfa-aws

Copy link
Collaborator

@kolchfa-aws kolchfa-aws left a comment

Choose a reason for hiding this comment

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

LGTM. Suggested rewording for clarity. Thanks, @dzane17!

_api-reference/cluster-api/cluster-settings.md Outdated Show resolved Hide resolved
_api-reference/search.md Outdated Show resolved Hide resolved
dzane17 and others added 2 commits October 17, 2023 09:29
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: David Z <38449481+dzane17@users.noreply.github.com>
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: David Z <38449481+dzane17@users.noreply.github.com>
@dzane17
Copy link
Contributor Author

dzane17 commented Oct 17, 2023

@vagimeli 2.12 is correct

@kolchfa-aws Updated the wording. Thanks for the suggestions

@vagimeli vagimeli merged commit 678ca91 into opensearch-project:main Oct 17, 2023
3 checks passed
@dzane17 dzane17 deleted the latency-doc branch October 17, 2023 18:03
@hdhalter hdhalter added release-notes PR: Include this PR in the automated release notes and removed 1 - Backlog Issue: The issue is unassigned or assigned but not started labels Oct 20, 2023
harshavamsi pushed a commit to harshavamsi/documentation-website that referenced this pull request Oct 31, 2023
* phase_took documentation

Signed-off-by: David Zane <davizane@amazon.com>

* Update _api-reference/cluster-api/cluster-settings.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: David Z <38449481+dzane17@users.noreply.github.com>

* Update _api-reference/search.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: David Z <38449481+dzane17@users.noreply.github.com>

---------

Signed-off-by: David Zane <davizane@amazon.com>
Signed-off-by: David Z <38449481+dzane17@users.noreply.github.com>
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
vagimeli pushed a commit that referenced this pull request Dec 21, 2023
* phase_took documentation

Signed-off-by: David Zane <davizane@amazon.com>

* Update _api-reference/cluster-api/cluster-settings.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: David Z <38449481+dzane17@users.noreply.github.com>

* Update _api-reference/search.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: David Z <38449481+dzane17@users.noreply.github.com>

---------

Signed-off-by: David Zane <davizane@amazon.com>
Signed-off-by: David Z <38449481+dzane17@users.noreply.github.com>
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release-notes PR: Include this PR in the automated release notes v2.12.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants