[DOCS-15971] [Server] ClusterParameter - Change Stream preAndPostImages.expireAfterSeconds Created: 21/Mar/23  Updated: 30/Oct/23  Resolved: 22/Mar/23

Status: Closed
Project: Documentation
Component/s: Server
Affects Version/s: None
Fix Version/s: Server_Docs_20231030

Type: Task Priority: Major - P3
Reporter: Adam Harrison Assignee: Unassigned
Resolution: Won't Do Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Participants:
Days since reply: 46 weeks ago

 Description   

I think it may be possible to improve the description of changeStreamOptions.preAndPostImages.expireAfterSeconds - particularly this portion:

To specify the minimum pre- and post- image retention time:

Referring to 'minimum' and 'retention' feels a little disorienting since the name of the parameter is referring to expiration - not retention.

Could we perhaps change the description to something along the lines of:

"To configure the time window after which pre- and post- images can be expired:" ?



 Comments   
Comment by Ashley Brown [ 22/Mar/23 ]

Hi Adam, thanks for raising this issue! After doing some research, I'm not convinced the suggested edits will improve user comprehension, and we may not get to a minor edit like this for some time due to workload constraints, so I'm going to go ahead and close this ticket. Please feel free to reach out if you'd like to discuss further.

Generated at Thu Feb 08 08:14:17 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.