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

[DOC-META] Replace "indices" with "indexes" #1046

Closed
JeffHuss opened this issue Aug 31, 2022 · 2 comments
Closed

[DOC-META] Replace "indices" with "indexes" #1046

JeffHuss opened this issue Aug 31, 2022 · 2 comments
Labels
1 - Backlog Issue: The issue is unassigned or assigned but not started v-All This issue is valid for all versions through 1.3

Comments

@JeffHuss
Copy link

What do you want to do?

Existing documentation is inconsistent with references to "indices" and "indexes" often sitting right next to each other within the same page.

We'll need to review each page on an individual basis to determine whether the reference is hard coded into the OpenSearch product (e.g., the actual button in the interface says indices or a property in a configuration file must say indices), or if it's just part of the narrative.

For instances where indices is used, but it is not hard coded into the product, we should replace it with indexes.

List of PRs

@JeffHuss JeffHuss added good first issue Good for newcomers 1 - Backlog Issue: The issue is unassigned or assigned but not started v-All This issue is valid for all versions through 1.3 labels Aug 31, 2022
@JeffHuss JeffHuss self-assigned this Aug 31, 2022
@JeffHuss JeffHuss assigned carolxob and unassigned JeffHuss Sep 15, 2022
@JeffHuss
Copy link
Author

JeffHuss commented Sep 15, 2022

This issue can be used for tracking PRs and progress in making the edits. First step will be to identify where indices exists in the documentation when it is not referring to a hardcoded property called indices.

Once that's done, small PRs for individual changes would be optimal, maybe targeting one page at a time to reduce the likelihood of merge conflict.

@Naarcha-AWS
Copy link
Collaborator

Closing this in favor of #2358

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1 - Backlog Issue: The issue is unassigned or assigned but not started v-All This issue is valid for all versions through 1.3
Projects
None yet
Development

No branches or pull requests

3 participants