Skip to content

Specify driver version in quick start #281

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Jan 31, 2022
Merged

Specify driver version in quick start #281

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4afdc0b
Specify driver version in quick start
Jan 27, 2022
ac188c6
reverse
Jan 27, 2022
53a1454
PR review fixes
Jan 31, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions source/quick-start.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,20 +37,25 @@ to check your version of Node and npm, as well as installation
instructions, see `downloading and installing Node.js and npm
<https://docs.npmjs.com/downloading-and-installing-node-js-and-npm>`_.

Select the :guilabel:`Clone the Project` tab if you want to build your
project from a premade dependency file or the :guilabel:`Create the Project`
Copy link
Contributor

Choose a reason for hiding this comment

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

Comment: I've never heard a package.json referred to as a dependency file (not wrong, but just doesn't seem quite right to me). I googled around a bit this site refers to it as a "manifest" which sounds like a better descriptor to me (captures more than listing dependencies). Non-blocking either way.

Suggested change
project from a premade dependency file or the :guilabel:`Create the Project`
project from a premade manifest file or the :guilabel:`Create the Project`

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Manifest files are a more general category, more often used to describe metadata (a description of a package).

A "dependency file" is a term used for any file that contains dependencies and is used across languages. I haven't found any other term used to classify package.json. If you know of one that is not jargon, let me know.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Also, from the link you posted:

The package.json file is kind of a manifest for your project.

This is not the same as calling it a manifest file.

tab if you want to create the project dependency file yourself.

.. tabs::

.. tab:: Clone the Project
:tabid: clone the project

First, install Git using `Git's Getting Started Guide
First, ensure you have Git installed in your development
environment or otherwise install it using `Git's Getting Started Guide
<https://git-scm.com/book/en/v2/Getting-Started-Installing-Git>`__.

Then, in your shell, clone the `js-starter repository
Then, from your shell, clone the `js-starter repository
<https://github.com/mongodb-university/js-starter>`__:

.. code-block:: bash

git clone https://github.com/mongodb-university/js-starter.git
git clone --branch v{+version+} https://github.com/mongodb-university/js-starter.git
Copy link
Contributor

Choose a reason for hiding this comment

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

Praise: Awesome job versioning the starter project, really like how version-sensitive the docs are becoming.


Next, navigate into the repository:

Expand Down Expand Up @@ -103,7 +108,7 @@ instructions, see `downloading and installing Node.js and npm

.. code-block:: bash

npm install mongodb
npm install mongodb@{+version+}

This command performs the following actions:

Expand Down