Skip to content

DOCSP-51416 Network Compression #162

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

jordan-smith721
Copy link
Collaborator

@jordan-smith721 jordan-smith721 commented Jul 9, 2025

Pull Request Info

PR Reviewing Guidelines

JIRA - https://jira.mongodb.org/browse/DOCSP-51416

Staging Links

  • connect/network-compression
  • connect
  • connect/connection-options
  • Self-Review Checklist

    • Is this free of any warnings or errors in the RST?
    • Did you run a spell-check?
    • Did you run a grammar-check?
    • Are all the links working?
    • Are the facets and meta keywords accurate?
    • Are the page titles greater than 20 characters long and SEO relevant?

    Copy link

    netlify bot commented Jul 9, 2025

    Deploy Preview for docs-ruby ready!

    Name Link
    🔨 Latest commit 75b7957
    🔍 Latest deploy log https://app.netlify.com/projects/docs-ruby/deploys/686fc62ec4a0ce000811b40d
    😎 Deploy Preview https://deploy-preview-162--docs-ruby.netlify.app
    📱 Preview on mobile
    Toggle QR Code...

    QR Code

    Use your smartphone camera to open QR code link.

    To edit notification comments on pull requests, go to your Netlify project configuration.

    @docs-builder-bot
    Copy link

    docs-builder-bot commented Jul 9, 2025

    🔄 Deploy Preview for docs-ruby processing

    Item Details
    🔨 Latest Commit 299e7e0379cc780bc929d083174960dcc89921fe
    😎 Deploy Preview https://deploy-preview-162--docs-ruby.netlify.app
    🔍 Build Logs View Logs

    @jordan-smith721 jordan-smith721 requested a review from Copilot July 9, 2025 18:17
    @jordan-smith721 jordan-smith721 marked this pull request as ready for review July 9, 2025 18:17
    Copy link

    @Copilot Copilot AI left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Pull Request Overview

    This PR introduces a new guide on configuring network compression in the Ruby driver and updates the navigation to surface that content.

    • Adds a “Compress Network Traffic” page outlining supported algorithms and configuration methods.
    • Updates connection-options.txt to include the new compression page in its toctree and removes obsolete entries from connect.txt.
    • Registers connect/connection-options as a landing page in snooty.toml.

    Reviewed Changes

    Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

    File Description
    source/connect/network-compression.txt New documentation page for enabling network compression
    source/connect/connection-options.txt Added “Compress Network Traffic” entry to toctree
    source/connect.txt Removed outdated links (Stable API, TLS, CSTO)
    snooty.toml Added connect/connection-options to landing pages
    Comments suppressed due to low confidence (2)

    source/connect/network-compression.txt:30

    • [nitpick] The section heading ‘Specify Connection Algorithms’ may be unclear; consider renaming it to ‘Specify Compression Algorithms’ to better reflect the topic.
    Specify Connection Algorithms
    

    source/connect/network-compression.txt:15

    • Consider adding a note about the minimum supported MongoDB server version (e.g., MongoDB 3.4+) for network compression to clarify compatibility requirements.
    The {+driver-short+} supports network compression to reduce the amount
    

    Copy link
    Collaborator

    @shuangela shuangela left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    nice job! some nits/suggestions, lgtm

    @jordan-smith721 jordan-smith721 requested review from a team and jamis and removed request for a team July 11, 2025 14:10
    @jordan-smith721 jordan-smith721 merged commit 6118893 into mongodb:comp-cov Jul 17, 2025
    5 checks passed
    rachel-mack pushed a commit to rachel-mack/docs-ruby that referenced this pull request Jul 30, 2025
    rachel-mack added a commit that referenced this pull request Jul 30, 2025
    * DOCSP-51932: v2.21.2 patch release (#163)
    
    * change TOC name (#165)
    
    * add a redirect (#169)
    
    * [Ruby] TOC Reorg (#160)
    
    * toc reorg
    
    * tweaks
    
    * DOCSP-51415 Add causal consistency section (#161)
    
    * [Ruby] CRUD - Upsert (#164)
    
    * DOCSP-51932: v2.21.2 patch release (#163)
    
    * add upsert section
    
    * reference
    
    * LM feedback
    
    * checkout snooty
    
    ---------
    
    Co-authored-by: Nora Reidy <nora.reidy@mongodb.com>
    
    * DOCSP-51416 Network Compression (#162)
    
    * [Ruby] Load Balancers (#166)
    
    * DOCSP-51932: v2.21.2 patch release (#163)
    
    * client option
    
    * undo snooty change
    
    * formatting
    
    * formatting
    
    * DR feedback
    
    ---------
    
    Co-authored-by: Nora Reidy <nora.reidy@mongodb.com>
    
    * [Ruby] Extended JSON (#168)
    
    * DOCSP-51932: v2.21.2 patch release (#163)
    
    * shared content
    
    * write
    
    * link formatting
    
    * link formatting
    
    * NR feedback
    
    * NR feedback
    
    * JB feedback
    
    * rephrase
    
    * remove extra change
    
    ---------
    
    Co-authored-by: Nora Reidy <nora.reidy@mongodb.com>
    
    ---------
    
    Co-authored-by: Nora Reidy <nora.reidy@mongodb.com>
    Co-authored-by: shuangela <angela.shu@mongodb.com>
    Co-authored-by: Jordan Smith <45415425+jordan-smith721@users.noreply.github.com>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    None yet
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    4 participants