documentation-website icon indicating copy to clipboard operation
documentation-website copied to clipboard

[Styling] Indexes vs Indices

Open nhtruong opened this issue 1 year ago • 5 comments

We currently have a style rule that says Use 'indexes' instead of 'indices'. However, the OpenSearch cluster and clients refer to the plural of index as indices instead of indexes:

  • We have a namespace called indices that all clients use. Eg client.indices.delete()
  • indices is used in OpenSearch cluster code 2900 times while indexes is used much more sporadically with 139 usages.
  • On the spec, indices is also used as fields for request and response bodies. While indexes is only used in descriptions.

I believe we should have the opposite rule instead: Replace indexes with indices.

nhtruong avatar Nov 07 '24 22:11 nhtruong

Considering the amount indices is used in code, I'm generally for this.

@natebower, @kolchfa-aws, @vagimeli: What are your thoughts?

Naarcha-AWS avatar Nov 19 '24 19:11 Naarcha-AWS

I was always for keeping indices.

kolchfa-aws avatar Nov 19 '24 21:11 kolchfa-aws

Regarding the Vale rule, it stems from our terms list:

index, indexes

In technical documentation and the UI, use indexes as the plural form of index. Use indices only in the context of mathematical expressions. Variable and setting names should not be changed.

In blog posts, use the plural indexes unless there is a domain-specific reason (for example, a mathematical or financial context) to use indices.

kolchfa-aws avatar Nov 19 '24 21:11 kolchfa-aws

I don't have a personal opinion, but for context, our style guide prescribes the use of indexes because it appears to be industry standard:

  • Microsoft: Use indexes as the plural form of index. Use indices only in the context of mathematical expressions.

  • Google: Use the plural indexes unless there is a domain-specific reason (for example, a mathematical or financial context) to use indices.

  • AWS: Use indexes as the plural form of index. Use indices only in context of mathematical expressions.

natebower avatar Nov 25 '24 11:11 natebower

Notwithstanding the context above, I will leave it up to you all. If we feel that indices is more appropriate to our use case, I'm fine with that and have no problem changing the style guide, but I would expect for the change to be applied across the docs site 😄.

natebower avatar Nov 25 '24 15:11 natebower

Closing as stale

natebower avatar Jul 14 '25 19:07 natebower