Document preferred plural: indexes vs indices
What does this MR do?
In some work for groupdatabase, I wondered if we were consistent in using indexes
vs indices
. As it turns out, we aren't -- and we can't be consistent:
- The database world has settled on
indexes
. https://www.postgresql.org/docs/15/glossary.html doesn't have an explicit statement preferringindexes
but the documentation consistently uses it instead ofindices
. - ElasticSearch explicitly uses
indices
: https://brand.elastic.co/302f66895/p/194a3b-writing-style-guide/t/60bf66
I'll have to think about how to implement this as a test, because this would be a good one to catch, but for now getting the explanation in the word list would be good.
Related issues
Closes Plural of index: indexes, or indices? (#411930 - closed)
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding or changing the main heading of the page (H1), ensure that the product tier badge is added. -
If you are a GitLab team member, request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
If you are a GitLab team member and only adding documentation, do not add any of the following labels:
~"frontend"
~"backend"
~"type::bug"
~"database"
These labels cause the MR to be added to code verification QA issues.
Reviewer's checklist
Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.
If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.
-
If the content requires it, ensure the information is reviewed by a subject matter expert. - Technical writer review items:
-
Ensure docs metadata is present and up-to-date. -
Ensure the appropriate labels are added to this MR. -
Ensure a release milestone is set. - If relevant to this MR, ensure content topic type principles are in use, including:
-
The headings should be something you'd do a Google search for. Instead of Default behavior
, say something likeDefault behavior when you close an issue
. -
The headings (other than the page title) should be active. Instead of Configuring GDK
, say something likeConfigure GDK
. -
Any task steps should be written as a numbered list. - If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
-
-
-
Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.