DOCSP-43396: Cleanup #151

norareidy · 2024-09-25T16:09:55Z

Pull Request Info

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

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-09-25T16:10:12Z

✅ Deploy Preview for docs-php-library ready!

Name	Link
🔨 Latest commit	`b764364`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-php-library/deploys/66f714a5603dbe00087bf74d
😎 Deploy Preview	https://deploy-preview-151--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.

…P-43396-cleanup

rustagir

good work! Happy to take another look if needed

rustagir · 2024-09-27T19:41:05Z

snooty.toml

@@ -39,7 +39,6 @@ php-library = "MongoDB PHP Library"

 [constants]
 php-library = "MongoDB PHP Library"
-driver-short = "PHP library"


S: I might have suggested removing this in the past, but I think it is actually good to have in here, even as a repeat. There are some sharedincludes that we might use that might use this source constant. Maybe you can just do this:
driver-short = "{+library-short+}"

rustagir · 2024-09-27T19:42:23Z

source/includes/connect/atlas.php

 echo json_encode($result), "\n";
-echo "Pinged your deployment. You successfully connected to MongoDB!\n";
+echo 'Pinged your deployment. You successfully connected to MongoDB!\n';


S: should we replace all \n chars with , PHP_EOL?

sure I can do that

rustagir · 2024-09-27T19:42:59Z

source/includes/get-started/quickstart.php

@@ -13,5 +16,5 @@
 if ($result) {
    echo json_encode($result, JSON_PRETTY_PRINT);
 } else {
-    echo "Document not found";
+    echo "Document not found';


Suggested change

echo "Document not found';

echo 'Document not found';

rustagir · 2024-09-27T19:43:14Z

source/includes/read/count.php

@@ -13,13 +13,13 @@
 // Counts all documents in the collection
 // start-count-all
 $result = $collection->countDocuments([]);
-echo "Number of documents: " . $result;
+echo "Number of documents: ", $result;


S: single quotes?

rustagir · 2024-09-27T19:43:24Z

source/includes/read/count.php

 // end-count-all

 // Counts documents that have a "founded_year" value of 2010
 // start-count-accurate
 $result = $collection->countDocuments(['founded_year' => 2010]);
-echo "Number of companies founded in 2010: " . $result;
+echo "Number of companies founded in 2010: ", $result;


S: Single quotes - nit

rustagir · 2024-09-27T19:43:37Z

source/includes/read/retrieve.php

@@ -11,7 +11,7 @@
 // Finds one document with a "name" value of "LinkedIn"
 // start-find-one
 $document = $collection->findOne(['name' => 'LinkedIn']);
-echo json_encode($document) , "\n";
+echo json_encode($document), "\n";


S: use PHP_EOL?

rustagir · 2024-09-27T19:45:35Z

source/write/update.txt

+- :phpmethod:`MongoDB\Collection::updateOne()`
+- :phpmethod:`MongoDB\Collection::updateMany()`
+- :phpclass:`MongoDB\UpdateResult`


Q: are there also places that need to use the :php: role to reference extension API docs?

fixed the remaining ones!

…P-43396-cleanup

* Add PR template * Scaffolding * DOCSP-41953: Create a deployment (#93) * DOCSP-41953: Create a deployment * toc * add troubleshoot file * DOCSP-41954: Create a connection string (#99) * DOCSP-41954: Create a connection string * edits * spacing * DOCSP-42388: Next steps (#101) * DOCSP-41975: Retrieve data (#102) * DOCSP-41975: Retrieve data * fixes * quotes * code fix * JS feedback * JT feedback * code format * fix * JT feedback 2 * edit * DOCSP-41952: Download and Install (#92) * DOCSP-41952: Download and Install * edits * toc, fixes * AS feedback * AS feedback 2 * typo * JT feedback * DOCSP-41976: Projection guide (#104) * DOCSP-41976: Projection guide * edits * fixes * code edits, output * JS feedback * JT feedback * DOCSP-41955: Connect to MongoDB (#100) * DOCSP-41955: Connect to MongoDB * edits * edit * RR feedback * typo * code edit * DOCSP-41974: Specify a query (#103) * DOCSP-41974: Specify a query * edits * output * fix * snooty.toml * RR feedback * code edits * DOCSP-41977: Specify documents to return (#105) * DOCSP-41977: Specify documents to return * edits * code output * toc * MM feedback, code edits * edit * JT feedback * edit * test * MM feedback 2 * DOCSP-41957 - Mongo Client (#106) Co-authored-by: Rea Rustagi <85902999+rustagir@users.noreply.github.com> * DOCSP-41960 - TLS (#114) * DOCSP-41978: Count documents (#108) * DOCSP-41978: Count documents * edits * code ex format * link * RR feedback * DOCSP-41979: Distinct values (#109) Adds a Distinct Values guide. * DOCSP-41981: Change streams (#113) Adds a Change Streams guide. * DOCSP-41993 Compatibility Table * test webhook * toc and sharedincludes * lang table * edits * headings * retry on shared include * shared includes * callout * help links * DOCSP-41958 - Connection Targets (#107) Co-authored-by: Nora Reidy <nora.reidy@mongodb.com> Co-authored-by: Andreas Braun <git@alcaeus.org> * tech review * DOCSP-41968: Update documents (#118) * DOCSP-41968: Update documents * snooty fix * edits * DOCSP-41967: Insert documents (#116) * DOCSP-41967: Insert documents * build * snooty * edit * JS feedback * JT feedback * JT feedback 2 * DOCSP-41980: Cursor guide (#110) * DOCSP-41980: Cursor guide * edits * code edits * output * vale fix * MM feedback * edit * fix code ex * edit * JT feedback * DOCSP-41988: Aggregation (#115) * DOCSP-41988: Aggregation * toc * edits * code edit * JS feedback * dev center * JM feedback * explain api link * JM feedback 2 * DOCSP-41983: indexes landing pg * wip * wip * MM PR fixes 1 * JM tech review 1 * JM tech review 1 * wip * wip * DOCSP-41969: Replace documents (#125) * DOCSP-41969: Replace documents * edits * wording * SA * JT feedback * JM tech review 2 * Add files via upload * DOCSP-41970: Delete documents (#128) Adds a guide that shows how to delete documents. * DOCSP-41984: single field index * wip * JS PR fixes 1 * wip * DOCSP-41986: multikey indexes * links * bullet pts * JS suggestion * fix whitespace per JM comment * uncomment * DOCSP-41985: compound idx * small fix * DOCSP-41966: Write operations landing (#135) * DOCSP-41966: Write operations landing * edits * RR feedback * JT feedback * JT feedback 2 * gridfs examples * DOCSP-42026: In use encryption (#142) * DOCSP-42026: In use encryption * edit * DOCSP-41972: GridFS guide (#133) * DOCSP-41972: GridFS guide * fixes * code edits * fix * RR feedback * phpmethod * fix * JM most feedback * alternate upload/download methods * file revisions * code fix * tojson * edits * JM feedback 2 * edits * JM last feedback * DOCSP-41971: Bulk write (#130) * DOCSP-41971: Bulk write * edits * JS feedback * api links * DOCSP-41987: atlas search idx * resolve todos * toc * DOCSP-41963: Databases and collections (#136) * DOCSP-41963: Databases and collections * edits * phpmethod * code fix * MW feedback * fix * MW feedback 2 * JM feedback * JM feedback 2 * JS fix * internal review * DOCSP-41982: cluster monitoring * small fixes * MW PR fixes 1 * test netlify * spacing * try using out of repo ref and add back legend * ou of repo ref * legend glitch * JM tech review 1 * single quotes * links * vale * remove older driver version past 1.15 * DOCSP-41991 What's New * add rest of versions * fix links * fix links * JM tech review 2 * DOCSP-41964: Time series collections (#138) * DOCSP-41964: Time series collections * toc * edits * keywords * SA feedback * JT feedback * JM final fixes * review comments * typo * DOCSP-41973 Read Landing Page * review comments * vale errors * small thing * full page with ex * add page * meta * DOCSP-41965: Read and write settings (#146) * DOCSP-41965: Read and write settings * more info * edits * edits * headers * fix link * fix * RR feedback * api docs * fix * fix * DOCSP-41950: Landing page (#150) * DOCSP-41950: Landing page * fix build errors * fixes, data formats * toc * fix * data formats folder * RR feedback * fix * remove file * edit sample app intro * change links in count sections * update sample app intro * DOCSP-41990: Authentication mechanisms (#139) * DOCSP-41990: Authentication mechanisms * client tabs * edits * edits * add info * reduce repetition * add section * fix link * MW feedback * fix * JM most feedback * move to code file * more JM edits * JM feedback 2 * DOCSP-41989: Security landing page (#149) * DOCSP-41989: Security landing page * more info * edits * snooty.toml * edits * RR feedback * JM feedback * DOCSP-41962 - Stable API (#117) Co-authored-by: Jeremy Mikola <jmikola@gmail.com> * DOCSP-41992 Upgrade versions * toc * edits * how to upgrade sections * style * edit * edit * review comments * ref * Revise descriptions for server opening/closed events * DOCSP-43204: Connection landing page (#147) * DOCSP-43204: Connection landing page * toc edit * edits * remove compression * fix * sample app * snooty * JM feedback * replica set * JM feedback 2 * JM last feedback * DOCSP-43819: php 1.20 release * fix * DOCSP-41956: run a command * wip * formatting fix * JS PR fixes 1 * link fix * style fixes * JT tech review 1 * wip * JM tech review * tree * api links * links * JM tech review 2 * small fixes * add ext upgrade command * DOCSP-41995: transaction * wip * update code * NR PR fixes 1 * wip * add emphasis * add with_txn() method to api links * cxn string env * edit * JM tech review 1 * remove dupe sc * tech review * wrap fix * edit copy * DOCSP-41959 - Connection Options (#112) Co-authored-by: Nora Reidy <nora.reidy@mongodb.com> Co-authored-by: Jeremy Mikola <jmikola@gmail.com> * DOCSP-43396: Cleanup (#151) * DOCSP-43396: Cleanup * quickstart fix * code fixes * edit * snooty * edit * code output * build log errors * another build fix * add info * upgrade guide to landing * fix * driver mentions * RR feedback * build fix * build fix * php directives --------- Co-authored-by: Mike Woofter <108414937+mongoKart@users.noreply.github.com> Co-authored-by: Rea Rustagi <85902999+rustagir@users.noreply.github.com> Co-authored-by: Lindsey Moore <lindsey.moore@mongodb.com> Co-authored-by: Andreas Braun <git@alcaeus.org> Co-authored-by: rustagir <rea.rustagi@mongodb.com> Co-authored-by: Brandon Ly <brandonly@lostcoding.com> Co-authored-by: lindseymoore <71525840+lindseymoore@users.noreply.github.com> Co-authored-by: Jeremy Mikola <jmikola@gmail.com>

DOCSP-43396: Cleanup

491a06a

norareidy added 14 commits September 25, 2024 17:12

quickstart fix

809b539

code fixes

785262a

edit

c654e6b

Merge remote-tracking branch 'upstream/php-standardization' into DOCS…

235a448

…P-43396-cleanup

snooty

be667e6

edit

ef69038

code output

1b87a90

build log errors

6ea7b82

another build fix

4de73cd

add info

4d73c43

Merge remote-tracking branch 'upstream/php-standardization' into DOCS…

e7b3bd2

…P-43396-cleanup

upgrade guide to landing

114801e

fix

cea8e3c

driver mentions

0175012

rustagir approved these changes Sep 27, 2024

View reviewed changes

norareidy added 3 commits September 27, 2024 16:08

Merge remote-tracking branch 'upstream/php-standardization' into DOCS…

d0f5a1e

…P-43396-cleanup

RR feedback

ed486c7

build fix

b764364

norareidy merged commit 1274cc6 into mongodb:php-standardization Sep 27, 2024
4 of 5 checks passed

norareidy deleted the DOCSP-43396-cleanup branch September 27, 2024 20:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

DOCSP-43396: Cleanup #151

DOCSP-43396: Cleanup #151

Uh oh!

norareidy commented Sep 25, 2024 •

edited

Loading

Uh oh!

netlify bot commented Sep 25, 2024 •

edited

Loading

Uh oh!

rustagir left a comment

Uh oh!

rustagir Sep 27, 2024

Uh oh!

rustagir Sep 27, 2024

Uh oh!

norareidy Sep 27, 2024

Uh oh!

rustagir Sep 27, 2024

Uh oh!

rustagir Sep 27, 2024

Uh oh!

rustagir Sep 27, 2024

Uh oh!

rustagir Sep 27, 2024

Uh oh!

rustagir Sep 27, 2024

Uh oh!

norareidy Sep 27, 2024

Uh oh!

Uh oh!

Uh oh!

DOCSP-43396: Cleanup #151

DOCSP-43396: Cleanup #151

Uh oh!

Conversation

norareidy commented Sep 25, 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 Sep 25, 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!

rustagir left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

norareidy commented Sep 25, 2024 •

edited

Loading

netlify bot commented Sep 25, 2024 •

edited

Loading