Skip to content

DOCSP-43617 Remove unsupported versions #163

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
merged 3 commits into from
Oct 11, 2024

Conversation

lindseymoore
Copy link
Collaborator

@lindseymoore lindseymoore commented Oct 4, 2024

Pull Request Info

PR Reviewing Guidelines

JIRA - https://jira.mongodb.org/browse/DOCSP-43617
Staging - https://deploy-preview-163--docs-php-library.netlify.app/compatibility/

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 Oct 4, 2024

Deploy Preview for docs-php-library ready!

Name Link
🔨 Latest commit 917a5fd
🔍 Latest deploy log https://app.netlify.com/sites/docs-php-library/deploys/670965461e7c9a00089137b4
😎 Deploy Preview https://deploy-preview-163--docs-php-library.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.

Copy link
Collaborator

@mongoKart mongoKart left a comment

Choose a reason for hiding this comment

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

lgtm

@lindseymoore lindseymoore requested a review from jmikola October 4, 2024 20:56
@lindseymoore
Copy link
Collaborator Author

lindseymoore commented Oct 4, 2024

@jmikola After a review of docs, this was only unnecessary mention of an older version. Let me know what you think or if there were other particular spots you had in mind, thanks!

@jmikola
Copy link
Member

jmikola commented Oct 7, 2024

After a review of docs, this was only unnecessary mention of an older version

I found four references to older server versions in the docs:

  • The introductory paragraph in decimal128.txt starts with "MongoDB 3.4 introduced support for..." This can be rewritten to just say "The Decimal128 BSON type is a 128-bit decimal-based..."
  • The description of the flags option in MongoDBDatabase-createCollection.txt includes "MongoDB 3.0 and later". I think that entire paragraph can be removed, as the manual links no longer contain any content on the subject. I also opened PHPLIB-1545 and PHPLIB-1546 to deprecate and remove the option in PHPLIB 1.21 an 2.0, respectively. It's a relic of the MMAPv1 storage engine.
  • Also in MongoDBDatabase-createCollection.txt, you can remove "This option has been deprecated since MongoDB 3.2" from the description of the autoIndexId option.
  • collation.txt starts with "MongoDB 3.4 introduced", which can be rewritten as "Collations provide a set of rules..." (preserving the manual link if it's still valid). This is comparable to what I suggested above for Decimal128.

@lindseymoore
Copy link
Collaborator Author

lindseymoore commented Oct 9, 2024

@jmikola Is it safe to remove autoIndexId from MongoDBDatabase-createCollection.txt? I don't see autoIndexId on the manual page, and it seems it can only be set to to true now anyways.
Thanks for flagging the above tickets; we can address these to remove the flag option once the engineering tickets are out of code review.

@jmikola
Copy link
Member

jmikola commented Oct 10, 2024

Is it safe to remove autoIndexId from MongoDBDatabase-createCollection.txt? I don't see autoIndexId on the manual page, and it seems it can only be set to to true now anyways.

Note that autoIndexId can be false when creating a collection in the non-replicated local database. PHPLIB-1159 removes the option in PHPLIB 2.0 and there's already a corresponding docs ticket (DOCSP-44238), so I don't think it needs to be touched in this PR.

As for the server manual, it should be documented as it's is still technically party of the create command API. I opened DOCSP-43428 some time ago to track that, as it looks like it was inadvertently removed from the manual in recent years.

Copy link
Member

@jmikola jmikola left a comment

Choose a reason for hiding this comment

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

One question about adding "the". Regardless of whether that is changed, LGTM and no need to review a second time.

@lindseymoore lindseymoore merged commit 6222278 into mongodb:master Oct 11, 2024
5 checks passed
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