[COMPASS-3921] Compass Custom Collation feature doesn't match Online Documentation Created: 04/Oct/19  Updated: 29/Oct/23  Resolved: 14/Jun/21

Status: Closed
Project: Compass
Component/s: Compass, Documentation
Affects Version/s: 1.19.12
Fix Version/s: 1.27

Type: Bug Priority: Minor - P4
Reporter: Felicia Hsieh Assignee: Rhys Howell
Resolution: Fixed Votes: 0
Labels: documentation
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified
Environment:

MacOS 10.14.6


Attachments: PNG File Screen Shot 2019-10-04 at 5.23.38 PM.png     PNG File Screen Shot 2019-10-04 at 5.59.28 PM.png     PNG File screenshot-1.png    
Issue Links:
Documented
Story Points: 1
Documentation Changes: Needed
Documentation Changes Summary:

We've updated the names of these collation field options in Compass to better reflect the MongoDB documentation. Thanks!


 Description   

The feature as described doesn't seem to match the Compass application. I don't know which is authoritative.

The documentation at https://docs.mongodb.com/manual/reference/collation/

 

Steps in Compass app:

Create a new Database

Checkmark "Use Custom Collation"

1.

App says, "Use Case-level" is a boolean. Maybe remove the text, "Use "

Doc says "caseLevel" is a string.

2.

App says, "Select a Backwards" as the field description for "Backwards". Text seems a little awkward.

3.

App says "Normalization" is false or true. There is no "<optional value>" But, I expected "false (default)" to be chosen because it is the default.

Doc says "Optional. Flag that determines whether to check if text require normalization and to perform normalization. " Documentation is missing the "Normalization" value in the graphic. See attached graphic.



 Comments   
Comment by Maurizio Casimirri [ 03/May/21 ]

After triaging:
1) `caseLevel` is a boolean and has a weird relation with strenght, it would be great to replace "true" and "false" with something more descriptive like "include case comparison" but is not that simple. The label "Use case-level" is incorrect, we could make it "Case Level" to be consistent with "Case first".

2) "App says, "Select a Backwards" as the field description for "Backwards". Text seems a little awkward.", We can replace the placeholder everywhere with "Select a value for "

3) As Alena said "normalization" is actually optional.

Generated at Wed Feb 07 22:34:41 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.