Skip to content
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

DOSCP-43051 Get Started landing and Install #32

Conversation

jordan-smith721
Copy link
Collaborator

@jordan-smith721 jordan-smith721 commented Sep 13, 2024

Pull Request Info

PR Reviewing Guidelines

JIRA - https://jira.mongodb.org/browse/DOCSP-43052
https://jira.mongodb.org/browse/DOCSP-43051

Staging -
Get Started
Install

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?

Copy link

netlify bot commented Sep 13, 2024

Deploy Preview for docs-c ready!

Name Link
🔨 Latest commit 7da30f0
🔍 Latest deploy log https://app.netlify.com/sites/docs-c/deploys/66e8541aea89f10008f01979
😎 Deploy Preview https://deploy-preview-32--docs-c.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 site configuration.

@jordan-smith721 jordan-smith721 marked this pull request as ready for review September 13, 2024 15:48
Copy link
Collaborator

@mcmorisi mcmorisi left a comment

Choose a reason for hiding this comment

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

LGTM with an open question and a few tweaks!

Copy link
Collaborator

Choose a reason for hiding this comment

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

So, the Linux installation instructions are technically correct. However, I fear that they way they are currently written could lead users to incorrectly assume that the version of the C driver provided by a particular version of a particular distro is adequate when it may not be for some given set of circumstances. For reference, here are the C driver versions shipped by the current active/stable distros:

EPEL7 1.3.6
EPEL8 1.27.6
EPEL9 1.27.6
Debian 10 1.14.0
Debian 11 1.17.6
Debian 12 1.23.1
Ubuntu 18.04 LTS 1.9.2
Ubuntu 20.04 LTS 1.16.1
Ubuntu 22.04 LTS 1.21.0
Ubuntu 24.04 LTS 1.26.0

Some of those are, well, really old.

Given this, it probably makes sense to recommend that before installing the available version of the C driver should be checked (with a command like apt-cache policy libmongoc-dev on Debian/Ubuntu or sudo dnf info mongo-c-driver-devel on RHEL/Fedora). If the version is sufficiently recent, then the package manager installation can be completed, otherwise installation should be done from source.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Good to know! Added some instructions to check the version before the installation instructions

Copy link
Collaborator

@rcsanchez97 rcsanchez97 left a comment

Choose a reason for hiding this comment

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

LGTM

(I am assuming that the TODO regarding installation from source will be resolved at some point, but I don't think I need to wait for that; however, I am happy to review again if more gets added for that.)

@jordan-smith721
Copy link
Collaborator Author

(I am assuming that the TODO regarding installation from source will be resolved at some point, but I don't think I need to wait for that; however, I am happy to review again if more gets added for that.)

@rcsanchez97 Yes, the TODO will just be adding the link to that page once it gets standardized, but the "install from source" page itself will be reviewed separately then.

@kevinAlbs kevinAlbs removed their request for review September 16, 2024 17:06
@jordan-smith721 jordan-smith721 merged commit 6925e53 into mongodb:standardization Sep 16, 2024
5 of 6 checks passed
@jordan-smith721 jordan-smith721 deleted the DOCSP-43051-getting-started branch September 16, 2024 20:34
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.

3 participants