DOCSP-48860: DOCS+ tutorial - Laravel MongoDB backend #3386

rustagir · 2025-05-22T15:08:57Z

https://jira.mongodb.org/browse/DOCSP-48860

Moves the How To Build a Laravel + MongoDB Back End Service tutorial into docs.

STAGING

Checklist

Add tests and ensure they pass

lindseymoore

A few comments for your consideration!

docs/quick-start/backend-service-tutorial.txt

lindseymoore · 2025-05-28T18:27:26Z

docs/quick-start/backend-service-tutorial.txt

+         php artisan serve
+
+      Navigate to http://127.0.0.1:8000/info to view the PHPinfo page.
+      Verify that the {+php-extension+} is installed.


Q: Is there a line they should check for in the info page to make sure the PHP extension is installed properly? Could be helpful to include.

docs/quick-start/backend-service-tutorial.txt

lindseymoore · 2025-05-28T18:41:37Z

docs/quick-start/backend-service-tutorial.txt

+         'connections' => [
+                 'mongodb' => [
+                     'driver' => 'mongodb',
+                     'dsn' => env('MONGODB_URI'),


Suggested change

'dsn' => env('MONGODB_URI'),

'dsn' => '<mongodb_uri>',

S: The linked to create a connection string page does not talk about setting the connection string as an environment variable. I would use a generic placeholder here instead to avoid confusion. You can also perhaps include a sentence about saving the uri as an environment variable without explicitly saying how.

lindseymoore · 2025-05-28T18:53:51Z

docs/quick-start/backend-service-tutorial.txt

+      ``Model`` classes represent rows of tables in relational
+      databases. In MongoDB, they are documents in the collection.
+
+      Your models can define fillable fields if you want to enforce a


Suggested change

Your models can define fillable fields if you want to enforce a

You can use Eloquent models to define fillable fields if you want to enforce a

S: Just to remain consistent with using the 'Eloquent models' term since 'models' is kind of vague.

lindseymoore · 2025-05-28T19:02:32Z

docs/quick-start/backend-service-tutorial.txt

+      the ``embedsMany()`` and ``embedsOne()`` methods.
+
+      As shown in the preceding step, you can define top-level schema
+      attributes. However, it is more complicated when using arrays


Suggested change

attributes. However, it is more complicated when using arrays

attributes. However, it is more complicated to define top level schema attributes for arrays

S: For present tense and specificity

lindseymoore · 2025-05-28T19:03:25Z

docs/quick-start/backend-service-tutorial.txt

+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1


Suggested change

:depth: 1

:depth: 2

S: To show steps in TOC

lindseymoore · 2025-05-28T19:06:26Z

docs/quick-start/backend-service-tutorial.txt

+
+In this tutorial, you learned how to create a back-end service by using
+Laravel and MongoDB for a front-end web application.
+This tutorial also showed why the document model leads to higher


Suggested change

This tutorial also showed why the document model leads to higher

This tutorial also showed how the document model leads to higher

S: Or 'explained why'

lindseymoore · 2025-05-28T19:09:45Z

docs/quick-start/backend-service-tutorial.txt

+:github:`laravel-mongodb-tutorial
+</mongodb-developer/laravel-mongodb-tutorial/>` repository on GitHub.
+
+See the :ref:`laravel_fundamentals` guides to learn more about


Suggested change

See the :ref:`laravel_fundamentals` guides to learn more about

See the :ref:`<link to Laravel home page>` guides to learn more about

S: Maybe direct to the Laravel docs home page instead bc it looks nicer?
https://deploy-preview-192--docs-laravel.netlify.app/

lindseymoore

LGTM w/ a few comments! Let me know if you want another look :)

lindseymoore · 2025-05-30T20:11:19Z

docs/quick-start/backend-service-tutorial.txt

+                 'mongodb' => [
+                     'driver' => 'mongodb',
+                     'dsn' => env('MONGODB_URI'),
+                     'database' => '<database name>',


I think a placeholder would make more sense, so there is no doubt that the user has to replace the database name. But I'll leave it up to you!

lindseymoore · 2025-05-30T20:24:06Z

docs/quick-start/backend-service-tutorial.txt

+      in the preceding code or set the ``MONGODB_URI`` environment variable to
+      your connection string before you run your application. To learn


Suggested change

in the preceding code or set the ``MONGODB_URI`` environment variable to

your connection string before you run your application. To learn

in the preceding code or set the ``MONGODB_URI`` environment variable to

your connection string and remove the placeholder before you run your application. To learn

S: Just because the code won't work as intended if you leave the placeholder if I'm understanding correctly.

lindseymoore · 2025-05-30T20:28:09Z

docs/quick-start/backend-service-tutorial.txt

+             ]);
+         });
+
+      After inserting the document, you can retrieve it by using the


Suggested change

After inserting the document, you can retrieve it by using the

After you insert the document, you can retrieve it by using the

S: present tense

lindseymoore · 2025-05-30T20:29:26Z

docs/quick-start/backend-service-tutorial.txt

+
+      MongoDB provides the Query API for optimized queries.
+
+      You can begin building a query from a ``collection`` object.


Suggested change

You can begin building a query from a ``collection`` object.

You can build a query by using a ``collection`` object.

S: present tense, simplicity

lindseymoore · 2025-05-30T20:30:06Z

docs/quick-start/backend-service-tutorial.txt

+             $result->getDeletedCount() ];
+         });
+
+      To learn more about performing CRUD operations, see the


Suggested change

To learn more about performing CRUD operations, see the

To learn more about how to perform CRUD operations, see the

S: present tense

lindseymoore · 2025-05-30T20:30:42Z

docs/quick-start/backend-service-tutorial.txt

+   .. step:: Use indexes to optimize query performance.
+
+      You can create indexes to support your queries and improve
+      performance. To learn more about creating indexes


Suggested change

performance. To learn more about creating indexes

performance. To learn more about how to create indexes

S: present tense

DOCSP-48860: DOCS+ tutorial WIP

8313c15

github-actions bot added the docs label May 22, 2025

wip

4bd065b

rustagir changed the title ~~DOCSP-48860: DOCS+ tutorial WIP~~ DOCSP-48860: DOCS+ tutorial - Laravel MongoDB backend May 27, 2025

rustagir marked this pull request as ready for review May 27, 2025 18:18

rustagir requested a review from a team as a code owner May 27, 2025 18:18

rustagir requested a review from lindseymoore May 27, 2025 18:18

add to toc

6520c2f

lindseymoore requested changes May 28, 2025

View reviewed changes

rustagir added 2 commits May 29, 2025 16:25

LM PR fixes 1

eae3ba2

fix spacing

a21fc65

lindseymoore approved these changes May 30, 2025

View reviewed changes

	Your models can define fillable fields if you want to enforce a
	You can use Eloquent models to define fillable fields if you want to enforce a

	attributes. However, it is more complicated when using arrays
	attributes. However, it is more complicated to define top level schema attributes for arrays

	This tutorial also showed why the document model leads to higher
	This tutorial also showed how the document model leads to higher

	See the :ref:`laravel_fundamentals` guides to learn more about
	See the :ref:`<link to Laravel home page>` guides to learn more about

		in the preceding code or set the ``MONGODB_URI`` environment variable to
		your connection string before you run your application. To learn

	After inserting the document, you can retrieve it by using the
	After you insert the document, you can retrieve it by using the


		MongoDB provides the Query API for optimized queries.

		You can begin building a query from a ``collection`` object.

	You can begin building a query from a ``collection`` object.
	You can build a query by using a ``collection`` object.

	To learn more about performing CRUD operations, see the
	To learn more about how to perform CRUD operations, see the

	performance. To learn more about creating indexes
	performance. To learn more about how to create indexes

DOCSP-48860: DOCS+ tutorial - Laravel MongoDB backend #3386

Are you sure you want to change the base?

DOCSP-48860: DOCS+ tutorial - Laravel MongoDB backend #3386

Uh oh!

Conversation

rustagir commented May 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Uh oh!

lindseymoore left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

lindseymoore May 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

lindseymoore left a comment

Choose a reason for hiding this comment

Uh oh!

lindseymoore May 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

rustagir commented May 22, 2025 •

edited

Loading

lindseymoore May 28, 2025 •

edited

Loading

lindseymoore May 30, 2025 •

edited

Loading