Uploaded image for project: 'Drivers'
  1. Drivers
  2. DRIVERS-2693

User-facing Network Compression Drivers Documentation

XMLWordPrintableJSON

    • Type: Icon: Improvement Improvement
    • Resolution: Done
    • Priority: Icon: Major - P3 Major - P3
    • None
    • Component/s: Docs
    • None
    • Needed
    • Hide

      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
      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.  
    • $i18n.getText("admin.common.words.hide")
      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 Fixed 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
      $i18n.getText("admin.common.words.show")
      #scriptField, #scriptField *{ border: 1px solid black; } #scriptField{ border-collapse: collapse; } #scriptField td { text-align: center; /* Center-align text in table cells */ } #scriptField td.key { text-align: left; /* Left-align text in the Key column */ } #scriptField a { text-decoration: none; /* Remove underlines from links */ border: none; /* Remove border from links */ } /* Add green background color to cells with FixVersion */ #scriptField td.hasFixVersion { background-color: #00FF00; /* Green color code */ } #scriptField td.willNotDo { background-color: #FF0000; /* Red color code */ } /* Center-align the first row headers */ #scriptField th { text-align: center; } 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 Fixed 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

      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).

            Assignee:
            Unassigned Unassigned
            Reporter:
            alex.bevilacqua@mongodb.com Alex Bevilacqua
            Alex Bevilacqua Alex Bevilacqua
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated:
              Resolved: