[5pt] Indexes: Community review

Indexes: Community review

Product: Tarantool
Since: latest
Audience/target: all Tarantool users
Root document: https://www.tarantool.io/en/doc/latest/book/box/indexes/
https://www.tarantool.io/en/doc/latest/reference/reference_lua/box_space/create_index/
SME:
Peer reviewer: @NickVolynkin

Details

This is the forth step in revising our documentation about indexes. (See #1691, #1820 and #1871.)
Here we want to understand whether the revised documents became more informative and clear or not and what is left to write.
We have some concerns about the structure and the completeness of the provided information.

We suggest answering the following questions:

1. Can you easily find any information about indexes you need via this page?
2. Do you think the current structure of the document is appropriate?
3. Should we write a special section about index features (such as, functional, multikey indexes, partial search, etc.)?
4. What features did we lost?
5. How can we improve the page about index creation?

Please, leave your feedback here in comments.

Definition of done

• collect feedback from developers and users
• rewrite dubious places

To be done with: #1782 #1737

Start by reviewing the indexes guide and the box_space/create_index reference page linked in the issue, then compare their structure and completeness against the five review questions. Gather feedback from developers and users, identify dubious or missing information, and update the documented pages. Done means feedback has been collected and the agreed unclear sections have been rewritten.