[CCI] Create advanced index actions guide #363

Nicksqain · 2023-04-08T19:31:42Z

Description

Create advanced index actions guide

Issues Resolved

closes [Guide] Advanced Index Actions #350

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

Signed-off-by: Alexei Karikov <[email protected]>

harshavamsi · 2023-04-18T17:00:08Z

@Nicksqain can you add a change in the CHANGELOG file?

codecov-commenter · 2023-04-18T17:05:53Z

Codecov Report

Merging #363 (2e0a08d) into main (c8b04a5) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #363   +/-   ##
=======================================
  Coverage   70.92%   70.92%           
=======================================
  Files          81       81           
  Lines        7732     7732           
=======================================
  Hits         5484     5484           
  Misses       2248     2248

Nicksqain · 2023-04-18T17:11:12Z

@harshavamsi Could you suggest which section and version?

@Nicksqain can you add a change in the CHANGELOG file?

Signed-off-by: Alexei Karikov <[email protected]>

saimedhi · 2023-06-05T18:51:19Z

@harshavamsi Could you suggest which section and version?

@Nicksqain can you add a change in the CHANGELOG file?

@Nicksqain, please add changelog to unreleased - added section. And also merge all the commits into single commit.

saimedhi · 2023-06-05T23:45:21Z

Code tested and Its working.

dblock

We've made some improvements to the users guide since this.

Resolve conflicts.
Link from users guide.
Add a working sample.

Let's finish this!

Nicksqain · 2023-08-03T15:48:26Z

@dblock Yes, I'll be sure to add the necessary changes on a free day!

saimedhi · 2023-08-29T19:36:59Z

@Nicksqain, Could you please make the requested changes when you have a moment? Thank you!

Signed-off-by: Alexei Karikov <[email protected]>

dblock

Looks good, let's fix capitalization?

We've also started adding working samples that are mentioned in guides to avoid copy-paste errors. Consider writing the code that's described in this guide in https://github.com/opensearch-project/opensearch-py/tree/main/samples?

dblock · 2023-09-05T14:43:38Z

USER_GUIDE.md

@@ -153,6 +153,7 @@ print(response)
 - [Search](guides/search.md)
 - [Point in Time](guides/point_in_time.md)
 - [Using a Proxy](guides/proxy.md)
+- [Advanced index actions](guides/advanced_index_actions.md)


Capitalize Index Actions

guides/advanced_index_actions.md

dblock · 2023-09-05T14:44:13Z

guides/advanced_index_actions.md

+
+## API Actions
+
+### Clear index cache


Do other guides capitalize Clear Index Cache?

Signed-off-by: Alexei Karikov <[email protected]>

saimedhi · 2023-09-05T16:52:00Z

guides/advanced_index_actions.md

+    - [Open/Close Index](#open-close-index)
+    - [Force merge index](#force-merge-index)
+    - [Clone index](#clone-index)
+    - [Split index](#split-index)


Capitalize Split index, Clone index, Force merge index

Signed-off-by: Alexei Karikov <[email protected]>

dblock · 2023-09-05T17:23:15Z

guides/advanced_index_actions.md

+client.indices.open(index='movies')
+```
+
+### Force merge index


saimedhi · 2023-09-05T17:23:18Z

@Nicksqain, Thanks for your contribution. Please add a working sample if possible.

dblock

Will you write a sample as part of this PR?

guides/advanced_index_actions.md

Signed-off-by: Alexei Karikov <[email protected]>

Nicksqain · 2023-09-05T17:35:51Z

@dblock
I don't really understand how to do it, I've already forgotten everything.
I don't have a lot of time right now. So, thought I'd contribute in my spare time. Could you pass it on to a more competent applicant?

dblock · 2023-09-06T16:54:55Z

We can merge the guide, thanks for your help.

dblock · 2023-09-06T16:55:25Z

@saimedhi you're good with this?

saimedhi

@Nicksqain, Thank you for contributing :) Could you kindly make those two small changes mentioned below?

I tested the code its working fine. And we can merge this PR after those 2 small changes. Thanks!

saimedhi · 2023-09-06T17:31:51Z

guides/advanced_index_actions.md

+    - [Clear Index Cache](#clear-index-cache)
+    - [Flush Index](#flush-index)
+    - [Refresh Index](#refresh-index)
+    - [Open/Close Index](#open-close-index)


This link is not working.

@dblock This guide has broken linking because of the use of [Open/Close Index](#open-close-index) syntax. I think the / character is breaking the #open-close-index link, but not sure. Regardless, I need to change the section title to use a Open or close index & make the hash link #open-or-close-index.(or something similar)

This isn't an issue in the Ruby guide version because those guides don't include the MD hash linking at the top of the guide

Is the section title I suggested okay to you? Or would you prefer some other title/hash-link?

Perfectly fine!

saimedhi · 2023-09-06T17:33:12Z

guides/advanced_index_actions.md

+client.indices.clear_cache(index='movies')
+```
+
+By default, the `indices.clear_cache` API action clears all types of cache. To clear specific types of cache pass the the `query`, `fielddata`, or `request` parameter to the API action:


remove one "the" after cache pass.

saimedhi · 2023-09-12T17:20:09Z

@Nicksqain, kindly make the above changes and lets merge this :)

saimedhi · 2023-09-27T16:56:22Z

@Nicksqain, kindly make the above changes and lets merge this :)

saimedhi · 2023-10-11T16:06:10Z

@Nicksqain, kindly make the above changes and resolve merge conflicts. Thanks :)

Djcarrillo6 · 2023-10-13T00:55:49Z

Hi @saimedhi I see on 9/5/2023 Nicksquain requested that another contributor take over the PR to complete the requested changes. I believe I can complete the requested changes & add a sample guide as was originally requested. Would it be ok with you to take over the resolution of issue #350?

dblock · 2023-10-13T14:39:44Z

@Djcarrillo6 please do it!

Djcarrillo6 · 2023-10-13T16:56:05Z

@dblock ok great I'm on it!

Djcarrillo6 · 2023-10-13T22:33:13Z

@dblock @saimedhi I opened a new PR that when approved & merged, will allow for the closure of this PR.

saimedhi · 2023-10-13T22:45:06Z

@Djcarrillo6, please consider committing small fixes to the Nicksqain:advanced-index-actions-py-guide branch instead of creating new PR.

If needed, create a separate PR for sample.

Thank you.

Djcarrillo6 · 2023-10-13T23:18:45Z

@saimedhi I opened a PR with my fixes/additions for this issue into @Nicksqain's open PR(this one) however I'm realizing now that he would have to accept it for those changes to be merged into this PR. Unless I'm mistaken, I don't think I can get my commit directly to his Nicksqain:advanced-index-actions-py-guide branch. Is there another way to get my branch into "Nicksqain:advanced-index-actions-py-guide"?

saimedhi · 2023-10-13T23:22:30Z

@saimedhi I opened a PR with my fixes/additions for this issue into @Nicksqain's open PR(this one) however I'm realizing now that he would have to accept it for those changes to be merged into this PR. Unless I'm mistaken, I don't think I can get my commit directly to his Nicksqain:advanced-index-actions-py-guide branch. Is there another way to get my branch into "Nicksqain:advanced-index-actions-py-guide"?

I am sorry, you are right. please reopen your PR with all the changes.

Djcarrillo6 · 2023-10-13T23:23:38Z

@saimedhi I opened a PR with my fixes/additions for this issue into @Nicksqain's open PR(this one) however I'm realizing now that he would have to accept it for those changes to be merged into this PR. Unless I'm mistaken, I don't think I can get my commit directly to his Nicksqain:advanced-index-actions-py-guide branch. Is there another way to get my branch into "Nicksqain:advanced-index-actions-py-guide"?

I am sorry, you are right. please reopen your PR with all the changes.

No worries! It will be opened shortly!

Create advanced index actions guide

797630a

Signed-off-by: Alexei Karikov <[email protected]>

Nicksqain requested review from VachaShah, dblock, harshavamsi, axeoman, deztructor and Shephalimittal as code owners April 8, 2023 19:31

Nicksqain changed the title ~~Create advanced index actions guide~~ [CCI] Create advanced index actions guide Apr 8, 2023

Nicksqain mentioned this pull request Apr 8, 2023

[Guide] Advanced Index Actions #350

Closed

harshavamsi added the CCI label Apr 18, 2023

Add changelog entry

c885074

Signed-off-by: Alexei Karikov <[email protected]>

dblock requested changes Jul 26, 2023

View reviewed changes

Nicksqain added 3 commits September 5, 2023 18:29

Merge branch 'main' into advanced-index-actions-py-guide

64eb6c5

Signed-off-by: Alexei Karikov <[email protected]>

Add changelog entry

a055400

Signed-off-by: Alexei Karikov <[email protected]>

Add link from users guide

764686f

Signed-off-by: Alexei Karikov <[email protected]>

Nicksqain requested review from saimedhi and florianvazelle as code owners September 5, 2023 12:36

dblock requested changes Sep 5, 2023

View reviewed changes

Add a TOC and capitalize anchors

170f076

Signed-off-by: Alexei Karikov <[email protected]>

Nicksqain requested a review from dblock September 5, 2023 15:14

Capitalize Index Actions

aa842bb

Signed-off-by: Alexei Karikov <[email protected]>

saimedhi requested changes Sep 5, 2023

View reviewed changes

Capitalize Split index, Clone index, Force merge index

3264254

Signed-off-by: Alexei Karikov <[email protected]>

Nicksqain requested a review from saimedhi September 5, 2023 17:19

dblock reviewed Sep 5, 2023

View reviewed changes

guides/advanced_index_actions.md Outdated

client.indices.open(index='movies')

```

### Force merge index

Copy link

Member

dblock Sep 5, 2023

Choose a reason for hiding this comment

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

One more.

dblock reviewed Sep 5, 2023

View reviewed changes

guides/advanced_index_actions.md Outdated Show resolved Hide resolved

Capitalize Split index, Clone index, Force merge index

2e0a08d

Signed-off-by: Alexei Karikov <[email protected]>

Nicksqain requested a review from dblock September 5, 2023 17:36

dblock approved these changes Sep 6, 2023

View reviewed changes

saimedhi requested changes Sep 6, 2023

View reviewed changes

Djcarrillo6 mentioned this pull request Oct 13, 2023

Added advanced index actions API guide & sample. #539

Closed

Djcarrillo6 mentioned this pull request Oct 13, 2023

Fix/issue350/advanced action guide and sample Nicksqain/opensearch-py#1

Closed

This was referenced Oct 13, 2023

Fix/issue350/advanced action guide and sample #540

Closed

Added advanced index actioins guide & sample code file. #541

Merged

saimedhi closed this Oct 16, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[CCI] Create advanced index actions guide #363

[CCI] Create advanced index actions guide #363

Nicksqain commented Apr 8, 2023 •

edited

Loading

harshavamsi commented Apr 18, 2023

codecov-commenter commented Apr 18, 2023 •

edited by codecov bot

Loading

Nicksqain commented Apr 18, 2023

saimedhi commented Jun 5, 2023

saimedhi commented Jun 5, 2023

dblock left a comment

Nicksqain commented Aug 3, 2023

saimedhi commented Aug 29, 2023

dblock left a comment

dblock Sep 5, 2023

dblock Sep 5, 2023

saimedhi Sep 5, 2023

dblock Sep 5, 2023

saimedhi commented Sep 5, 2023

dblock left a comment

Nicksqain commented Sep 5, 2023

dblock commented Sep 6, 2023

dblock commented Sep 6, 2023

saimedhi left a comment

saimedhi Sep 6, 2023

Djcarrillo6 Oct 13, 2023

dblock Oct 16, 2023

saimedhi Sep 6, 2023

saimedhi commented Sep 12, 2023

saimedhi commented Sep 27, 2023

saimedhi commented Oct 11, 2023

Djcarrillo6 commented Oct 13, 2023

dblock commented Oct 13, 2023

Djcarrillo6 commented Oct 13, 2023

Djcarrillo6 commented Oct 13, 2023 •

edited

Loading

saimedhi commented Oct 13, 2023

Djcarrillo6 commented Oct 13, 2023

saimedhi commented Oct 13, 2023

Djcarrillo6 commented Oct 13, 2023

[CCI] Create advanced index actions guide #363

[CCI] Create advanced index actions guide #363

Conversation

Nicksqain commented Apr 8, 2023 • edited Loading

Description

Issues Resolved

harshavamsi commented Apr 18, 2023

codecov-commenter commented Apr 18, 2023 • edited by codecov bot Loading

Codecov Report

Nicksqain commented Apr 18, 2023

saimedhi commented Jun 5, 2023

saimedhi commented Jun 5, 2023

dblock left a comment

Choose a reason for hiding this comment

Nicksqain commented Aug 3, 2023

saimedhi commented Aug 29, 2023

dblock left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

saimedhi commented Sep 5, 2023

dblock left a comment

Choose a reason for hiding this comment

Nicksqain commented Sep 5, 2023

dblock commented Sep 6, 2023

dblock commented Sep 6, 2023

saimedhi left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

saimedhi commented Sep 12, 2023

saimedhi commented Sep 27, 2023

saimedhi commented Oct 11, 2023

Djcarrillo6 commented Oct 13, 2023

dblock commented Oct 13, 2023

Djcarrillo6 commented Oct 13, 2023

Djcarrillo6 commented Oct 13, 2023 • edited Loading

saimedhi commented Oct 13, 2023

Djcarrillo6 commented Oct 13, 2023

saimedhi commented Oct 13, 2023

Djcarrillo6 commented Oct 13, 2023

Nicksqain commented Apr 8, 2023 •

edited

Loading

codecov-commenter commented Apr 18, 2023 •

edited by codecov bot

Loading

Djcarrillo6 commented Oct 13, 2023 •

edited

Loading