-
Notifications
You must be signed in to change notification settings - Fork 29
DOCSP-45358: documents #67
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
✅ Deploy Preview for docs-mongoid ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks pretty good! Requesting changes mainly based on the page flow
source/data-modeling/documents.txt
Outdated
{+odm+}. The ``Document`` module is a representation of a MongoDB | ||
document. To learn more about the terminology, structure, and limitations of |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
{+odm+}. The ``Document`` module is a representation of a MongoDB | |
document. To learn more about the terminology, structure, and limitations of | |
{+odm+}. The ``Document`` module represents a MongoDB | |
document. To learn more about the terminology, structure, and limitations of |
source/data-modeling/documents.txt
Outdated
MongoDB Representation | ||
---------------------- | ||
|
||
The representation of a ``Document`` in MongoDB is a BSON object that is |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The representation of a ``Document`` in MongoDB is a BSON object that is | |
A ``Document`` in MongoDB is represented by a BSON object that is |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
reworded
source/data-modeling/documents.txt
Outdated
|
||
The representation of a ``Document`` in MongoDB is a BSON object that is | ||
similar to a {+language+} hash or JSON object. You can store instances | ||
of your models directly in a collection in the database, or you can |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
of your models directly in a collection in the database, or you can | |
of your models directly in a collection, or you can |
or "database collection"?
source/data-modeling/documents.txt
Outdated
You can find more information about the ``Document`` module in the `API | ||
documentation <{+api-root+}/Document.html>`__. | ||
|
||
MongoDB Representation |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
S: in my opinion, main focus of this section is an example on using the .create()
method - might be worth changing the title to reflect that.
And/or, the representation paragraph kinda feels like it splits apart the section about the Document
class and its methods. Some alternatives could be moving the below method example to the preceding section (and leaving this title as is), or putting the representation paragraph into an admonition.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
moved the text around/reworded
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
To learn more about how to model your data by using {+odm+} models, | ||
see the :ref:`mongoid-data-modeling` guides. | ||
|
||
.. TODO Add link to field types guide. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i'm assuming this guide hasn't been created yet, but pointing this out just in case it has!
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-45358
Staging - https://deploy-preview-67--docs-mongoid.netlify.app/data-modeling/documents/
Self-Review Checklist