[DRIVERS-2693] User-facing Network Compression Drivers Documentation Created: 16/Aug/23  Updated: 01/Nov/23

Status: Implementing
Project: Drivers
Component/s: Docs
Fix Version/s: None

Type: Improvement Priority: Major - P3
Reporter: Alex Bevilacqua Assignee: Unassigned
Resolution: Unresolved Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Issue split
split to CDRIVER-4710 User-facing Network Compression Drive... Closed
split to CXX-2736 User-facing Network Compression Drive... Closed
split to GODRIVER-2955 User-facing Network Compression Drive... Closed
split to JAVA-5118 User-facing Network Compression Drive... Closed
split to MONGOID-5649 User-facing Network Compression Drive... Closed
split to NODE-5569 User-facing Network Compression Drive... Closed
split to PHPLIB-1219 User-facing Network Compression Drive... Closed
split to PYTHON-3930 User-facing Network Compression Drive... Closed
split to RUST-1738 User-facing Network Compression Drive... Closed
split to MOTOR-1175 User-facing Network Compression Drive... Scheduled
Related
related to PHPLIB-1224 Create Connection Guide for all clien... Backlog
Epic Link: Improve Awareness of Network Compressors for Drivers
Driver Changes: Needed
Quarter: FY24Q3
Downstream Changes Summary:

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.

 

Product Manager: Alex Bevilacqua Alex Bevilacqua
Start date:
Driver Compliance:
Key Status/Resolution FixVersion
CDRIVER-4710 Fixed 1.25.0
CXX-2736 Fixed 3.9.0
GODRIVER-2955 Fixed 1.13.0, 1.13.1
JAVA-5118 Works as Designed
NODE-5569 Done
MOTOR-1175 Scheduled 3.4
PYTHON-3930 Fixed 4.6
PHPLIB-1219 Duplicate
MONGOID-5649 Done 9.0.0
RUST-1738 Works as Designed
SWIFT-1710 Won't Do

 Description   

Not all languages currently have user docs regarding network compressor configuration and usage.

C
C++
C#
Go
Java
Node
PHP
Python (documented with mongo_client options only)
Ruby
Rust (mentioned with regards to feature flags only)

These will be required for upstream links from Atlas (the Connect modal).



 Comments   
Comment by Tom Selander [ 22/Aug/23 ]

Drivers Triage: There is no unified format for how all of the team docs look but the goal is that we want to ensure this information is obvious to the consuming user. For teams that have existing documentation around this, they will need to look at what exists and then move it into the current docs location (updating if necessary)

 

Tagging this for Q3 as this is a high priority and teams should triage and find time to slot this into their current quarterly plan.

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