[DOC] Change non-hardcoded references to "indices" to "indexes"

[natebower]

What do you want to do?

• Request a change to existing documentation
• Add new documentation
• Report a technical problem with the documentation
• Other

Tell us about your request. Provide a summary of the request and all versions that are affected.
Please change non-hardcoded references to indices to indexes.

What other resources are available? Provide links to related issues, POCs, steps for testing, etc.
For example, the heading of this page should be "System indexes", and the second sentence should read "Even if your user account has read permissions for all indexes..."

[Naarcha-AWS]

This is the same as #1046. I'm ok with closing that one and tracking against this if you would prefer.

[natebower]

Yeah, let's do that so that we're more current.

[hdhalter]

This one has been fixed: https://opensearch.org/docs/latest/security/configuration/system-indices/, but there are still others.

[BigSamu]

@Naarcha-AWS, can I take this issue?

[BigSamu]

This one has been fixed: https://opensearch.org/docs/latest/security/configuration/system-indices/, but there are still others.

@hdhalter should be URLs also updated? In the quote you described thinking the URL should be https://opensearch.org/docs/latest/security/configuration/system-indixes/ instead of https://opensearch.org/docs/latest/security/configuration/system-indices/. Just to keep consistency. Of course, the 1st link is not already setup for getting to the expected site (Documentation System Indexes)

[hdhalter]

Hi @BigSamu - Thanks so much for taking this on! I didn't change the URL at the time because changing the URL has a ripple effect, that is, you have to make sure you're not introducing any broken links. You also have to add a redirect in the file. Let me know if you need more info.

[BigSamu]

Hey @hdhalter, thanks for your reply. So after looking the documentation I have the following questions if you don't mind so I can proceed:

• What does @natebower refer to when he asks for changes in non-harcoded references? Look at references that are defined as indices or Indices and change them to indexes or Indexes, respectively. Here, the problem is that we need an update of the base code before proceeding for a change like this. Or not?
• Following the previous point, I did a lookup in the documentation-website base code for the word indices. The results I got were the ones in this link. For tackling this issue, I see in this search results many places for doing updates. Wondering how I should proceed. I think this issue should be worked on incrementally. For instance:
• For the search results in the about.md file (screenshot below), we can make updates now with no problems because this will not break anything. It is just updating strings in the documentation from indices or Indices to indexes or Indexes

• For the search results in the _api-reference/popular-api.md and _security/configuration/system-indices.md files (screenshots below), the changes you mentioned imply changes in URLs and properties, which means the base code has to be updated, before proceeding making these changes.

So what I believe is the best approach as the first task is only to change the documentation where I find ONLY strings with the word indices or Indices and changes to indexes or Indexes. Later in the new steps, we should start updating the documentation once the base code is updated, which will mean a collaborative approach with maintainers. Make sense?

@Naarcha-AWS I accept suggestions from your side too.

Regards,

Samuel

[BigSamu]

@Naarcha-AWS @hdhalter,

I just finished opening PR #5353 for this issue. After further inspection, the change of non-harcoded variables is going to be tricky and needs a planning with the owners of each part of the source code, I think.

The PR created in this case is replacing the references of 'indices' to 'indexes' ONLY in the cases of description texts. Those changes were NOT executed for the cases where the 'indices' term was used as variables, in links, as properties, or another part in the code base.

I would appreciate your feedback to see how I can continue helping on this issue. Maybe it will be useful to open a set of individual issues, bringing the owners of each part of the source code to work together with the documentation team, so the update for the code and the documentation could be done in parallel at the same time.

Also, I suggest to add may be a banner in the documentation website detailing that OpenSearch is in the process of changing 'indices' references to 'indexes'. That will avoid confusions I believe.

Regards,

Samuel

[Naarcha-AWS]

Closing this issue for now. We can start an initiative to update the other plugins in a separate issue.

[BigSamu]

Closing this issue for now. We can start an initiative to update the other plugins in a separate issue.

@Naarcha-AWS count with me for that initiative.