DOCSP-42732: qs download (sinatra) #47
Conversation
✅ Deploy Preview for docs-mongoid ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
source/quick-start-sinatra.txt
Outdated
| Ruby. By using {+odm+}, you can easily interact with your data and | ||
| create flexible data models. | ||
|
|
||
| Sinatra is a Domain Specific Language (DSL) for creating web |
There was a problem hiding this comment.
I: Doesn't look like this needs capitalization
| Sinatra is a Domain Specific Language (DSL) for creating web | |
| Sinatra is a domain-specific language (DSL) for creating web |
| - `Ruby <https://www.ruby-lang.org/en/documentation/installation/>`__ | ||
| - `RubyGems package manager <https://rubygems.org/pages/download>`__ |
There was a problem hiding this comment.
| - `Ruby <https://www.ruby-lang.org/en/documentation/installation/>`__ | |
| - `RubyGems package manager <https://rubygems.org/pages/download>`__ | |
| - `Ruby. <https://www.ruby-lang.org/en/documentation/installation/>`__ | |
| - `RubyGems package manager. <https://rubygems.org/pages/download>`__ |
|
|
||
| gem install mongoid | ||
|
|
||
| In {+language+}, packages are called **gems**. |
There was a problem hiding this comment.
S: Move this line to immediately before "Run the following command..." a few lines up
| - A terminal app and shell. For MacOS users, use Terminal or a similar app. | ||
| For Windows users, use PowerShell. | ||
|
|
||
| Download and Install the Mongoid Gem |
There was a problem hiding this comment.
S: You could use the {+odm+} constant here (I know that makes the heading dashes weird
| Ensure that the version of {+odm+} you install is compatible with the | ||
| version of {+language+} installed on your operating system. To | ||
| learn which versions are compatible, see the | ||
| :ref:`mongoid-compatibility` page. |
There was a problem hiding this comment.
S: Could add a second source constant for lowercase mongoid, since it's used several times on this page
There was a problem hiding this comment.
if it's used in anchors, I am good to leave it as written
|
|
||
| .. step:: Install gems | ||
|
|
||
| Run the following command to install the list of gems into your |
There was a problem hiding this comment.
S:
| Run the following command to install the list of gems into your | |
| Run the following command to install the gems into your |
| bundle install | ||
|
|
||
| When the command runs successfully, the output in your | ||
| shell contains a ``Bundle complete!`` message. |
There was a problem hiding this comment.
Q: Is "Bundle complete!" just part of the message? If so, this makes sense; otherwise, you could say "displays a...message"
There was a problem hiding this comment.
The message has info about the number of gems installed and some other info, which is why I phrased it this way. I think pasting the full message might be confusing as the number of installed packages could differ between users.
2 participants
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-42732
Staging - https://deploy-preview-47--docs-mongoid.netlify.app/quick-start-sinatra/download-and-install/
Self-Review Checklist