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.

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

ccho-mongodb
Copy link
Contributor

@ccho-mongodb ccho-mongodb commented Jan 27, 2022

Pull Request Info

Ensure that the quick start version corresponds to the correct version of the driver.

  • Git clone points to branch that contains the corresponding version.
  • npm command specifies major/minor version

Issue JIRA link:

None

Snooty build log:

https://workerpool-boxgs.mongodbstitch.com/pages/job.html?collName=queue&jobId=61f7fe4f382d7fe4ee3d5ce3

Docs staging link (requires sign-in on MongoDB Corp SSO):

https://docs-mongodbcom-staging.corp.mongodb.com/node/docsworker-xlarge/012722-quickstart-specify-driver-version/quick-start/

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?
  • Does it render on staging correctly?
  • Are all the links working?
  • Are the staging and workerpool job links in the PR description updated?

If your page documents a concept, does it meet the following criteria?

Copy link
Contributor

@biniona-mongodb biniona-mongodb left a comment

Choose a reason for hiding this comment

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

LGTM + comments

Comment on lines 49 to 50
First, ensure you have ``git`` installed in your development
environment or otherwise install Git using `Git's Getting Started Guide
Copy link
Contributor

Choose a reason for hiding this comment

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

Comment: Having monospace and non-monospace "Git" in the same sentence was a bit odd for me. I'm not sure it increases clarity have the initial git in monospace, so might be worth changing. Non-blocking either way you go.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I agree that it should be consistent across the same form when used outside of a title, so the instance within "otherwise install Git using" should be formatted similarly.
However, I was referring to git, the package name (see text-formatting in the style guide). I think I can just use the pronoun "it" in the aforementioned instance and leave the first instance as a monospaced package name.
Does that make sense?

@@ -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.

<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.

@ccho-mongodb ccho-mongodb merged commit 6f142fd into mongodb:master Jan 31, 2022
@ccho-mongodb ccho-mongodb deleted the 012722-quickstart-specify-driver-version branch January 31, 2022 17:39
ccho-mongodb pushed a commit that referenced this pull request Jan 31, 2022
* Specify driver version in quick start

(cherry picked from commit 6f142fd)
ccho-mongodb pushed a commit that referenced this pull request Jan 31, 2022
* Specify driver version in quick start

(cherry picked from commit 6f142fd)
ccho-mongodb pushed a commit that referenced this pull request Jan 31, 2022
* Specify driver version in quick start

(cherry picked from commit 6f142fd)
ccho-mongodb pushed a commit that referenced this pull request Jan 31, 2022
* Specify driver version in quick start

(cherry picked from commit 6f142fd)
ccho-mongodb pushed a commit that referenced this pull request Jan 31, 2022
* Specify driver version in quick start

(cherry picked from commit 6f142fd)
ccho-mongodb pushed a commit that referenced this pull request Jan 31, 2022
* Specify driver version in quick start

(cherry picked from commit 6f142fd)
ccho-mongodb pushed a commit that referenced this pull request Sep 23, 2022
* Specify driver version in quick start

(cherry picked from commit 7fc3cf2)
ccho-mongodb pushed a commit that referenced this pull request Sep 23, 2022
* Specify driver version in quick start

(cherry picked from commit 7fc3cf2)
ccho-mongodb pushed a commit that referenced this pull request Sep 23, 2022
* Specify driver version in quick start

(cherry picked from commit 7fc3cf2)
ccho-mongodb pushed a commit that referenced this pull request Sep 23, 2022
* Specify driver version in quick start

(cherry picked from commit 7fc3cf2)
ccho-mongodb pushed a commit that referenced this pull request Sep 23, 2022
* Specify driver version in quick start

(cherry picked from commit 7fc3cf2)
ccho-mongodb pushed a commit that referenced this pull request Sep 23, 2022
* Specify driver version in quick start

(cherry picked from commit 7fc3cf2)
ccho-mongodb pushed a commit to ccho-mongodb/docs-node that referenced this pull request Sep 23, 2022
* Specify driver version in quick start
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