DOCSP-43961: rails qs #52
Conversation
✅ Deploy Preview for docs-mongoid ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
source/quick-start-rails.txt
Outdated
| Ruby. By using {+odm+}, you can easily interact with your data and | ||
| create flexible data models. | ||
|
|
||
| Ruby on Rails, or Rails, is a web application framework for |
There was a problem hiding this comment.
S: for clarity
| Ruby on Rails, or Rails, is a web application framework for | |
| Ruby on Rails, also known as Rails, is a web application framework for |
alternatively, add it in the first paragraph when you intro the term:
This guide shows you how to use {+odm+} in a new Ruby on Rails 7 (Rails) web
There was a problem hiding this comment.
S: You could just say "Rails" or "Ruby on Rails" here, since you've already introduced both terms
source/quick-start-rails.txt
Outdated
| modeled and displayed. {+odm+} replaces Rails' default | ||
| ``ActiveRecord`` adapter for data modeling. |
There was a problem hiding this comment.
S: for clarity, and to avoid the question of whether to add another S after the apostrophe
| modeled and displayed. {+odm+} replaces Rails' default | |
| ``ActiveRecord`` adapter for data modeling. | |
| modeled and displayed. {+odm+} replaces the default | |
| ``ActiveRecord`` adapter for data modeling in Rails. |
source/quick-start-rails.txt
Outdated
| If you prefer to use Sinatra as your web framework, see the | ||
| :ref:`mongoid-quick-start-sinatra` guide. | ||
|
|
||
| MongoDB Atlas is a fully managed cloud database service that hosts your |
There was a problem hiding this comment.
S: These last two paragraphs feel a little tacked on after the pointers to other docs. You could try:
- Moving these two paragraphs to just after the "Ruby on Rails..." paragraph, so the parallel structure with other explanatory paragraph is clear
- Moving the admonition and "To learn more..." paragraph to the end. Could also consider putting this in an admonition
There was a problem hiding this comment.
shuffled paragraphs
|
|
||
| When connecting to an Atlas cluster, you must specify the database that | ||
| you want to interact with as the default database in your connection string. | ||
| You must add the database name to your connection string **after the hostname**. |
There was a problem hiding this comment.
S: I try to use italics for emphasis since we often use bold to introduce new terms (either one is consistent with the style guide)
source/quick-start-rails.txt
Outdated
| Ruby. By using {+odm+}, you can easily interact with your data and | ||
| create flexible data models. | ||
|
|
||
| Ruby on Rails, or Rails, is a web application framework for |
There was a problem hiding this comment.
S: You could just say "Rails" or "Ruby on Rails" here, since you've already introduced both terms
2 participants
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-43961
Staging - https://deploy-preview-52--docs-mongoid.netlify.app/quick-start-rails/
Self-Review Checklist