Skip to content

Conversation

rustagir
Copy link
Contributor

@rustagir rustagir commented Oct 1, 2024

Pull Request Info

PR Reviewing Guidelines

JIRA - https://jira.mongodb.org/browse/DOCSP-44008
Staging:

  1. read
  2. write
  3. next steps

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 1, 2024

Deploy Preview for docs-mongoid ready!

Name Link
🔨 Latest commit b7de8b0
🔍 Latest deploy log https://app.netlify.com/sites/docs-mongoid/deploys/66fc3173b657a500088884e4
😎 Deploy Preview https://deploy-preview-50--docs-mongoid.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
Contributor

@norareidy norareidy left a comment

Choose a reason for hiding this comment

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

LGTM with some non-blocking suggestions


In the ``app.rb`` file, create a model called ``Restaurant``
to represent data from the sample ``restaurants`` collection in
your MongoDB database:
Copy link
Contributor

Choose a reason for hiding this comment

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

S: specify the database

Suggested change
your MongoDB database:
the ``sample_restaurants`` database:

Comment on lines 49 to 50
To display your data in a specified way by using HTML, you can
create a **view**.
Copy link
Contributor

Choose a reason for hiding this comment

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

S: since this is a procedure step, I'd change the verb tense:

Suggested change
To display your data in a specified way by using HTML, you can
create a **view**.
Create a **view** to display your data in a specified way by using HTML.

use the ``to_json()`` method to display your results in JSON
format.

Replace the ``list_restaurants`` route with the following code to
Copy link
Contributor

Choose a reason for hiding this comment

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

S: clarify which file you're editing

Suggested change
Replace the ``list_restaurants`` route with the following code to
Replace the ``list_restaurants`` route in the ``app.rb`` file with the following code to

.. step:: Post a request to create a restaurant entry

Send a ``Restaurant`` instance to the ``add_restaurant`` endpoint
by running the following command in your shell:
Copy link
Contributor

Choose a reason for hiding this comment

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

S: Clarify where you should run the command

Suggested change
by running the following command in your shell:
from the application root directory:


.. TODO Learn more about {+odm+} features from the following resources:

.. - :ref:`mongoid-fundamentals-connection`: learn how to configure your MongoDB
Copy link
Contributor

Choose a reason for hiding this comment

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

S: capitalize the first word after these colons

Suggested change
.. - :ref:`mongoid-fundamentals-connection`: learn how to configure your MongoDB
.. - :ref:`mongoid-fundamentals-connection`: Learn how to configure your MongoDB

@rustagir rustagir merged commit a1a3bb3 into mongodb:standardized Oct 14, 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.

2 participants