DOCSP-44903 Shorten TOC Labels by lindseymoore · Pull Request #176 · mongodb/docs-php-library

lindseymoore · 2024-10-31T20:55:04Z

Pull Request Info

PR Reviewing Guidelines

JIRA - https://jira.mongodb.org/browse/DOCSP-44903
Staging - https://deploy-preview-176--docs-php-library.netlify.app/

Current TOC: https://www.mongodb.com/docs/php-library/current/

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?

netlify · 2024-10-31T20:55:22Z

✅ Deploy Preview for docs-php-library ready!

Name	Link
🔨 Latest commit	`9840e62`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-php-library/deploys/672931ed039a420008f24fcd
😎 Deploy Preview	https://deploy-preview-176--docs-php-library.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

lindseymoore · 2024-10-31T22:03:56Z

@mongoKart How do you feel about keeping toc titles action-oriented (starting with action verb)? Makes titles long, but I tried to keep it action-oriented if the title didn't take up more than two lines. Let me know!

mongoKart · 2024-11-01T13:39:14Z

@mongoKart How do you feel about keeping toc titles action-oriented (starting with action verb)? Makes titles long, but I tried to keep it action-oriented if the title didn't take up more than two lines. Let me know!

Good question! When I started, I was told to keep headings task-oriented, but I don't know if we're still doing that and if it also applies to the TOC.

@sarahemlin Do you have thoughts on this from an IA/SEO perspective?

mongoKart

LGTM w/ a couple suggestions

source/data-formats.txt

mongoKart · 2024-11-01T14:45:51Z

source/reference/result-classes.txt

-   CollectionInfo Class </reference/class/MongoDBModelCollectionInfo>
-   DatabaseInfo Class </reference/class/MongoDBModelDatabaseInfo>
-   IndexInfo Class </reference/class/MongoDBModelIndexInfo>
+   BulkWriteResult </reference/class/MongoDBBulkWriteResult>


great change for this group

source/write.txt

source/get-started.txt

source/index.txt

github-actions · 2024-11-07T23:03:09Z

The backport to v1.20 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-v1.20 v1.20
# Navigate to the new working tree
cd .worktrees/backport-v1.20
# Create a new branch
git switch --create backport-176-to-v1.20
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 b9fda162ecdbb9aa04a44cb2bb5ff3b594352afb
# Push it to GitHub
git push --set-upstream origin backport-176-to-v1.20
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-v1.20

Then, create a pull request where the base branch is v1.20 and the compare/head branch is backport-176-to-v1.20.

* DOCSP-44903 Shorten TOC Labels * rest of pages * angle brackets * fixes * internal review * updates based on Mike's PR * review comments and consistency (cherry picked from commit b9fda16)

* use sharedincludes in compat page * add source constants for versions * delete files for old build system (cherry picked from commit 55daa82) * adds more info to v1.20 whats new (cherry picked from commit 302bcd5) * Fix compatibility table (cherry picked from commit 4fba22f) * (DOCSP-44298) Removed EOL'd v1.16 and earlier. (#165) (#166) * DOCSP-44903 Shorten TOC Labels (#176) * DOCSP-44903 Shorten TOC Labels * rest of pages * angle brackets * fixes * internal review * updates based on Mike's PR * review comments and consistency (cherry picked from commit b9fda16) * PHPLIB-1278: FAQ entry on connection persistence * Address vale lint checks on word usage * Docs edits * Merge pull request #181 from mcmorisi/DRIVERS-2658-hint DOCSP-45139: Add Hint option for Distinct operation * (DOCSP-45749) Denests last phase 1 nested components (#182) * (DOCSP-45749) Denests last phase 1 nested components * Update build * DOCSP-45100: Delete and rename by name (#187) * DOCSP-45100: Delete and rename by name * edits * JM feedback (cherry picked from commit 343f339) * bring master changes into v1.21 * DOCSP-44644: db/coll accessor methods * fix spacing * vale action dependency * vale action dependency * DOCSP-45100: GridFS methods api docs (#196) * DOCSP-45100: GridFS methods api docs * edits * RR feedback * JT feedback * DOCSP-45100: GridFS methods api docs (#196) * DOCSP-45100: GridFS methods api docs * edits * RR feedback * JT feedback (cherry picked from commit 1442347) * DOCSP-43365: type specification for createSearchIndex(es) * indentation fix * indentation fix * add whats new entry * indentation fix * SA PR fixes 1 * DOCSP-43365: type specification for createSearchIndex(es) (cherry picked from commit e09b124) * indentation fix (cherry picked from commit cd6a586) * indentation fix (cherry picked from commit 3b3ec37) * add whats new entry (cherry picked from commit f821030) * SA PR fixes 1 (cherry picked from commit 7d9bfe8) * DOCSP-43457: builderEncoder option (#200) * DOCSP-43457: builderEncoder option * fix * fix type * go back * codec * JT feedback * DOCSP-43457: builderEncoder option (#200) * DOCSP-43457: builderEncoder option * fix * fix type * go back * codec * JT feedback (cherry picked from commit e1ed056) * DOCSP-44237 flags Option deprecation on v2.21 (#201) * DOCSP-44237 flags Option deprecation on v2.21 * add what's new note * Rea review comments * DOCSP-45770: atlas search queries (#197) * DOCSP-45770: atlas search queries * fix indentation * fix indentation * fix indentation * fix indentation * snooty landing page * snooty landing page * indentation fix * netlify trigger * whats new * RM PR fixes 1 * comments * small fix * JT tech review 1 * indentation fix * fix * small fixes * small fixes * remov Pipeline type * DOCSP-45878: Transactions parallelism note (#204) * DOCSP-45878: Transactions parallelism note (#204) (cherry picked from commit ba91a37) * DOCSP-43919: aggregation builder (#203) * DOCSP-43919: aggregation builder * indentation fix * remov Pipeline type * LM PR fixes 1 * fp fixes * todo fixes * small fixes * JM tech review 1 * DOCSP-46127: Update manual link (#205) * DOCSP-46127: Update manual link * MW feedback * DOCSP-46127: Update manual link (#205) * DOCSP-46127: Update manual link * MW feedback (cherry picked from commit bf6ac8a) * DOCSP-47690: aws lambda tutorial (#207) * DOCSP-47690: aws lambda tutorial * fixes * fixes * fixes * MM PR fixes 1 * remove section * RB small fix * DOCSP-47690: aws lambda tutorial (#207) * DOCSP-47690: aws lambda tutorial * fixes * fixes * fixes * MM PR fixes 1 * remove section * RB small fix (cherry picked from commit 8ed8dde) * add redirect for aws lambda page * change title to avoid duplicate * change toc * change url and add redirects * add back old ref based on rea's feedback * change redirect * fix merge issues * use regular includes on master * DOCSP-47970: v1.21 release (#212) * DOCSP-47970: v1.21 release * JM combine v's * JT small fix (#209) * DOCSP-43464: operations with builders (#206) * DOCSP-43464: operations with builders * fix desc * shared include fix? * shared include fix? * revert * netlify trigger * small fix * LM PR fixes 1 * LM PR fixes 2 * link fix * reformat comments * JT tech review 2 * fix code example * JT tech review comments --------- Co-authored-by: Jordan Smith <jordan.smith@mongodb.com> Co-authored-by: Elyse Foreman <elyse.foreman@mongodb.com> Co-authored-by: lindseymoore <71525840+lindseymoore@users.noreply.github.com> Co-authored-by: Jeremy Mikola <jmikola@gmail.com> Co-authored-by: Michael Morisi <michael.morisi@mongodb.com> Co-authored-by: Sarah Simpers <82042374+sarahsimpers@users.noreply.github.com> Co-authored-by: Nora Reidy <nora.reidy@mongodb.com> Co-authored-by: Angela <angelashu103@gmail.com> Co-authored-by: shuangela <angela.shu@mongodb.com>

DOCSP-44903 Shorten TOC Labels

853b542

lindseymoore added 3 commits October 31, 2024 17:38

rest of pages

39adc15

angle brackets

faecb85

fixes

2bc1a34

mongoKart approved these changes Nov 1, 2024

View reviewed changes

mongoKart requested a review from sarahemlin November 1, 2024 14:47

lindseymoore added 2 commits November 1, 2024 10:58

internal review

0cdc36d

updates based on Mike's PR

0f44fe2

sarahemlin requested changes Nov 1, 2024

View reviewed changes

source/get-started.txt Outdated Show resolved Hide resolved

source/index.txt Outdated Show resolved Hide resolved

review comments and consistency

9840e62

lindseymoore requested a review from sarahemlin November 4, 2024 20:44

sarahemlin approved these changes Nov 7, 2024

View reviewed changes

lindseymoore added backport v1.19 backport v1.18 backport v1.17 backport v1.20 and removed backport v1.19 backport v1.18 backport v1.17 labels Nov 7, 2024

lindseymoore merged commit b9fda16 into mongodb:master Nov 7, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOCSP-44903 Shorten TOC Labels#176

DOCSP-44903 Shorten TOC Labels#176
lindseymoore merged 7 commits intomongodb:masterfrom
lindseymoore:DOCSP-44903

lindseymoore commented Oct 31, 2024 •

edited

Loading

Uh oh!

netlify bot commented Oct 31, 2024 •

edited

Loading

Uh oh!

lindseymoore commented Oct 31, 2024

Uh oh!

mongoKart commented Nov 1, 2024

Uh oh!

mongoKart left a comment

Uh oh!

Uh oh!

mongoKart Nov 1, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Nov 7, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

lindseymoore commented Oct 31, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Info

Self-Review Checklist

Uh oh!

netlify bot commented Oct 31, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for docs-php-library ready!

Uh oh!

lindseymoore commented Oct 31, 2024

Uh oh!

mongoKart commented Nov 1, 2024

Uh oh!

mongoKart left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mongoKart Nov 1, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Nov 7, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

lindseymoore commented Oct 31, 2024 •

edited

Loading

netlify bot commented Oct 31, 2024 •

edited

Loading