[DOCS-15975] [Server] Improve ChangeStream pre-and-post image page Created: 22/Mar/23 Updated: 22/Jan/24 |
|
| Status: | Backlog |
| Project: | Documentation |
| Component/s: | manual, Server |
| Affects Version/s: | None |
| Fix Version/s: | None |
| Type: | Task | Priority: | Major - P3 |
| Reporter: | Adam Harrison | Assignee: | Unassigned |
| Resolution: | Unresolved | Votes: | 0 |
| Labels: | backlog, proactive, release | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Participants: | |
| Days since reply: | 44 weeks, 1 day ago |
| Description |
|
Please add an example for enabling changeStreamPreAndPostImages into the documentation for Change Streams with Document Pre- and Post-Images. The current layout can be misread to believe that it would be necessary to run the setClusterParameter command which configures preAndPostImages.expireAfterSeconds. To improve this, we could change the third bullet point ("Enable changeStreamPreAndPostImages for a collection using ...") to provide an example of a createCollection or collMod command which would enable the setting necessary to enable pre-and-post images. This would break up the flow and make it clear that the later command is a separate concept entirely. Example / Proposed Language Document Pre-and-Post-Images on a collection can be enabled by enabling the option changeStreamPreAndPostImages using createCollection or collMod. For example: db.createCollection(<collection>, { changeStreamPreAndPostImages:{{{} { enabled: true }{}}} }) Other Thoughts There's a lot of good information in the expireAfterSeconds section, but I think a lot of it may be out of place. Most of this seems to be duplicated from the entry for this parameter in Cluster Parameters - so it may make this section easier to parse if we just link there instead. |
| Comments |
| Comment by Ashley Brown [ 04/Apr/23 ] |
|
Thanks Jason – I've removed the ticket from the epic. You've estimated this work will take about three days. For now, we're not sure when we'll get to it, given that we are prioritizing 7.0 work. |
| Comment by Ashley Brown [ 22/Mar/23 ] |
|
Perfect, thanks! adam.harrison@mongodb.com, we'll plan to handle this in time for the Server 7.0 release. |
| Comment by Jason Price [ 22/Mar/23 ] |
|
ashley.brown@mongodb.com for the entire project related to this for 7.0, around 15 days. Cheers. Tickets are this one, plus: |
| Comment by Ashley Brown [ 22/Mar/23 ] |
|
jason.price@mongodb.com I can't tell how big a project this is - would you mind taking a look at this and scoping the work? |