Uploaded image for project: 'Go Driver'
  1. Go Driver
  2. GODRIVER-2955

User-facing Network Compression Drivers Documentation

XMLWordPrintableJSON

    • Type: Icon: Improvement Improvement
    • Resolution: Fixed
    • Priority: Icon: Major - P3 Major - P3
    • 1.13.0, 1.13.1
    • Affects Version/s: None
    • Component/s: None
    • Labels:
      None
    • Hide

      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.

       

      Show
      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.  
    • Needed
    • Hide

      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

      Show
      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

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

            Assignee:
            preston.vasquez@mongodb.com Preston Vasquez
            Reporter:
            dbeng-pm-bot PM Bot
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: