[GODRIVER-2955] User-facing Network Compression Drivers Documentation Created: 22/Aug/23  Updated: 06/Dec/23  Resolved: 26/Sep/23

Status: Closed
Project: Go Driver
Component/s: None
Affects Version/s: None
Fix Version/s: 1.13.0, 1.13.1

Type: Improvement Priority: Major - P3
Reporter: PM Bot Assignee: Preston Vasquez
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Documented
Issue split
split from DRIVERS-2693 User-facing Network Compression Drive... Implementing
Quarter: FY24Q3, FY24Q4
Upstream Changes Summary:

DRIVERS-2693:
Ensure Network Compression documentation is present. Network compression info should be clearly documented and easy to find by our users via a top-level section/tutorial in the docs. For teams that have existing documentation around this (such as on github.io,etc), they will need to take stock of what is documented and then move it into the current docs location (updating the content if necessary). For teams that work with Doc Team, file a DOCSP ticket.

High priority for Q3.

 

Documentation Changes: Needed
Documentation Changes Summary:

1. What would you like to communicate to the user about this feature? How to use network compression in the Go Driver. The Docs team can use what has been put into the README.md file as part of this ticket: https://github.com/mongodb/mongo-go-driver#network-compression . The goal is to do something similar as the Java Driver: https://www.mongodb.com/docs/drivers/java/sync/current/fundamentals/connection/network-compression/
2. Would you like the user to see examples of the syntax and/or executable code and its output? The code doesn't have to be executable, but there should be an example of how to (1) define compressors in a connection string, (2) define compressors using the Go options.Client() builder API . Examples for both are in the README.md file linked in Q1.
3. Which versions of the driver/connector does this apply to? v1


 Description   

This ticket was split from DRIVERS-2693, please see that ticket for a detailed description.



 Comments   
Comment by Githook User [ 28/Sep/23 ]

Author:

{'name': 'Steven Silvester', 'email': 'steven.silvester@ieee.org', 'username': 'blink1073'}

Message: GODRIVER-2955 [master] Add user-facing network compression documentation (#1404)

Co-authored-by: Preston Vasquez <prestonvasquez@icloud.com>
Branch: master
https://github.com/mongodb/mongo-go-driver/commit/cd3c6996acf2db8eb02df0966fa6f76168ab1abf

Comment by Preston Vasquez [ 25/Sep/23 ]

We need to add a Network Compression section in the style of Java: https://www.mongodb.com/docs/drivers/java/sync/current/fundamentals/connection/network-compression/ to the Go Driver documentation, the wording can be the same as what the Go Driver is including in the top-level README.md file as a part of this ticket.

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