search

lostintangent / node-azure

Tutorials that illustrate how to build Node.js apps with VS Code, and deploy them to Azure
http://azure.com/node
10 stars 7 forks source link

Miscellaneous doc clarifications/corrections #12

Open nicolehaugen opened 7 years ago

nicolehaugen commented 7 years ago

I recently went through this walk-through and noticed that the following clarifications/corrections need to be made:

1.) Under the Project/Code Navigation section, it says to use CMD+P to open the file drop-down - instead it should be CTRL+P.

2.) Make sure that in the pre-reqs section (or somewhere else) that it mentions that Chrome must be installed so that the Chrome extension works later for launching the app. You get a straightforward error if it's not installed, but best to have the user install it first so that they don't run into this.

3.) In the Full Stack Debugging section, the instructions have you copy and paste launch.json file which has the port hard-coded. Make sure that this port number matches the port specified in the app - I believe it's 1337 in the server.js file.

4.) In the Deploying Your App section when you push the app to docker hub, the user must first authenticate with docker from the command line, otherwise when you attempt to push you'll get a straightforward error saying that access to the resource is denied. At a minimum, the user needs to type "docker login" in order to authenticate. But more ideal, would be if the Docker extension included a "Docker: Login" command or if the "Docker: Push" command prompted for login when necessary.

lostintangent commented 7 years ago

This is great feedback! I just updated this repo to address #2-4.

Regarding #1, are you running this on Windows? On macOS, the correct shortcut is CMD+P, so I may need to mention this disparity throughout the tutorial.

nicolehaugen commented 7 years ago

I used Windows (but on a side note, I do plan to do the walk through on a Mac too since this is the more common scenario) - most of the doc appears to be geared toward Windows which was why I was surprised to see CMD+P there. For example, I see use of CTRL+P throughout the rest of the doc. Anyway, breaking the doc into sections based on Mac vs. Windows will help clarify these differences.