DOCSP-44647: add to existing app #55

rustagir · 2024-10-23T15:24:37Z

Pull Request Info

JIRA - https://jira.mongodb.org/browse/DOCSP-44647
Staging - https://deploy-preview-55--docs-mongoid.netlify.app/add-existing/

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-23T15:24:53Z

✅ Deploy Preview for docs-mongoid ready!

Name	Link
🔨 Latest commit	`b876e64`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-mongoid/deploys/672123690d0c84000813a496
😎 Deploy Preview	https://deploy-preview-55--docs-mongoid.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.

mongoKart

very solid. some suggestions and questions

mongoKart · 2024-10-23T18:46:51Z

source/add-existing.txt

+-------------------
+
+To start using {+odm+} in an existing Sinatra application, you can follow
+the same steps described in the


S:

Suggested change

the same steps described in the

the steps described in the

mongoKart · 2024-10-23T18:47:19Z

source/add-existing.txt

+#. Create a ``config/mongoid.yml`` configuration file and specify your
+   connection target.
+
+#. Create an application file and load your configuration file.


Q: This is something users will know how to do?

I can link to the example in the QS

mongoKart · 2024-10-23T18:49:22Z

source/add-existing.txt

+-----------------
+
+You can add {+odm+} to an existing Rails application to run alongside
+other ActiveRecord adapters. To use a combination of adapters, you


S: looks to me like there's "Active Record" (the framework) and ActiveRecord (the module). Not sure which one is appropriate throughout this page.

I think I'll replace with the spaced version, as I am using it the same way as Mongoid

mongoKart · 2024-10-23T18:50:15Z

source/add-existing.txt

+   gem 'mongoid'
+
+To use {+odm+} as the *only* database adapter, remove or comment out any
+RDBMS libraries such as ``sqlite`` or ``pg`` listed in the ``Gemfile``.


Suggested change

RDBMS libraries such as ``sqlite`` or ``pg`` listed in the ``Gemfile``.

RDBMS libraries listed in the ``Gemfile``, such as ``sqlite`` or ``pg``.

mongoKart · 2024-10-23T18:52:48Z

source/add-existing.txt

+To verify the contents of ``rails/all`` for Rails 7, see the
+:github:`rails GitHub repository
+</rails/rails/blob/7-0-stable/railties/lib/rails/all.rb>`.


S: tip admonition

Suggested change

To verify the contents of ``rails/all`` for Rails 7, see the

:github:`rails GitHub repository

</rails/rails/blob/7-0-stable/railties/lib/rails/all.rb>`.

.. tip:: rails/all Components

To verify the contents of ``rails/all`` for Rails 7, see the

:github:`rails GitHub repository. </rails/rails/blob/7-0-stable/railties/lib/rails/all.rb>`

I actually think we can just delete this note.

mongoKart · 2024-10-23T19:07:48Z

source/add-existing.txt

+If your application already uses models, you must adjust them to
+migrate from using ActiveRecord to {+odm+}.
+
+ActiveRecord models derive from ``ApplicationRecord`` and do not have


Suggested change

ActiveRecord models derive from ``ApplicationRecord`` and do not have

ActiveRecord models derive from the ``ApplicationRecord`` class and do not have

mongoKart · 2024-10-23T19:10:30Z

source/add-existing.txt

+ActiveRecord models derive from ``ApplicationRecord`` and do not have
+column definitions. {+odm+} models generally have no superclass but must
+include the ``Mongoid::Document`` attribute. {+odm+} models usually
+define fields explicitly. You can also use :ref:`dynamic fields
+<mongoid-dynamic-fields>` instead of explicit field definitions.


S: is there a way to tie these four sentences together more? i'm guessing it's explaining how you need to change your models to use Mongoid, but it reads more like a list--in which case, maybe just make it an actual list?

will workshop

mongoKart · 2024-10-23T19:11:04Z

source/add-existing.txt

+     has_many :comments, dependent: :destroy
+   end
+
+Or, you can define the ``Post`` model by using dynamic fields, as shown


Suggested change

Or, you can define the ``Post`` model by using dynamic fields, as shown

Instead of using [blank], you can define the ``Post`` model by using dynamic fields, as shown

mongoKart · 2024-10-23T19:12:38Z

source/add-existing.txt

+{+odm+} does not use ActiveRecord migrations, because MongoDB does not
+require a defined schema before you can store data.


S: maybe my own ignorance, but this feels tacked on to the previous section instead of a logical continuation, so maybe a note admonition would be useful. maybe even move to the next section (or delete altogether), since it makes this same point.

Suggested change

{+odm+} does not use ActiveRecord migrations, because MongoDB does not

require a defined schema before you can store data.

.. note:: ActiveRecord Migrations

{+odm+} does not use ActiveRecord migrations, because MongoDB does not

require a defined schema before you can store data.

mongoKart · 2024-10-23T19:14:25Z

source/quick-start-sinatra.txt

 connect to a MongoDB cluster hosted on MongoDB Atlas, and perform
 read and write operations on the data in your cluster.

+To learn how to migrate an existing application to use {+odm+}, see the


S: my ear says you either migrate to Mongoid or adapt the application to use Mongoid, but not a combo

THis is meant to differentiate between starting a new app or integrating Mongoid into your existing app. I can make that more clear

mongoKart

looks great! a few small suggestions

mongoKart · 2024-10-28T19:39:16Z

source/add-existing.txt

-:ref:`Sinatra Quick Start <mongoid-quick-start-sinatra>` guide.
-
-The following steps describe how to add {+odm+} to a Sinatra application:
+the following steps:


S: change line to "perform the following steps:" or something similar to avoid double "follow"

mongoKart · 2024-10-28T19:39:36Z

source/add-existing.txt

+Open the ``config/application.rb`` file and examine the contents. If the
+file uses the ``require "rails/all"`` statement to load all Rails components,
+delete this statement. You must add a separate ``require`` statement
+for each Rails component, as shown the following sample


Suggested change

for each Rails component, as shown the following sample

for each Rails component, as shown in the following sample

mongoKart · 2024-10-28T19:41:14Z

source/add-existing.txt

+Even though {+odm+} supports a superset of Active Record associations,
 the way that model references are stored in collections is different between
-{+odm+} and ActiveRecord.
+{+odm+} and Active Record.


S: "{+odm+} and Active Record store model references in collections differently."

DOCSP-44647: add to existing app

a25eede

rustagir added 3 commits October 23, 2024 11:25

fix vale action

78083c9

vale fixes

8310a07

depth

c3592be

mongoKart requested changes Oct 23, 2024

View reviewed changes

MW PR fixes 1

85f7765

rustagir requested a review from mongoKart October 24, 2024 14:49

fixes

772600e

mongoKart approved these changes Oct 28, 2024

View reviewed changes

rustagir and others added 2 commits October 29, 2024 14:02

MW PR fixes 2

6b38408

Merge branch 'standardized' into DOCSP-44647-add-to-app

b876e64

rustagir merged commit 5328c20 into mongodb:standardized Oct 29, 2024
1 check failed

	RDBMS libraries such as ``sqlite`` or ``pg`` listed in the ``Gemfile``.
	RDBMS libraries listed in the ``Gemfile``, such as ``sqlite`` or ``pg``.

	ActiveRecord models derive from ``ApplicationRecord`` and do not have
	ActiveRecord models derive from the ``ApplicationRecord`` class and do not have

	Or, you can define the ``Post`` model by using dynamic fields, as shown
	Instead of using [blank], you can define the ``Post`` model by using dynamic fields, as shown

		{+odm+} does not use ActiveRecord migrations, because MongoDB does not
		require a defined schema before you can store data.

	for each Rails component, as shown the following sample
	for each Rails component, as shown in the following sample

DOCSP-44647: add to existing app #55

DOCSP-44647: add to existing app #55

Uh oh!

Conversation

rustagir commented Oct 23, 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 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for docs-mongoid ready!

Uh oh!

mongoKart 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!

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!

mongoKart 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!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

rustagir commented Oct 23, 2024 •

edited

Loading

netlify bot commented Oct 23, 2024 •

edited

Loading