-
-
Notifications
You must be signed in to change notification settings - Fork 4.2k
Update getting-started.md #1985
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
phated
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Followed up
docs/getting-started.md
Outdated
|
|
||
| *If you've previously installed gulp globally, run `npm rm --global gulp` before following these instructions.* | ||
|
|
||
| *Make sure that you've installed Node and NPM before attempting to install gulp.* |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this be a separate step? It seems to blend with the other notice.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changed
docs/getting-started.md
Outdated
| @@ -1,13 +1,22 @@ | |||
| # Getting Started | |||
|
|
|||
| *If you've previously installed gulp globally, run `npm rm --global gulp` before following these instructions.* | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this be the place where we point to the Gulp Sip article or further below?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it should go here. In the part below, I think you want people focusing on npm and node installation.
| #### Install the `gulp` command | ||
|
|
||
| ```sh | ||
| npm install --global gulp-cli |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It might make sense to mention the Sip in this section instead?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the other one's better.
docs/getting-started.md
Outdated
| ``` | ||
|
|
||
| #### Create a package.json | ||
| If you don't have a package.json, create one. If you need help, run an npm init which will walk you through giving it a name, version, and description. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
wrap package.json in code ticks. Same with npm init; should probably say "etc" of things it walks through.
docs/getting-started.md
Outdated
| If you don't have a package.json, create one. If you need help, run an npm init which will walk you through giving it a name, version, and description. | ||
|
|
||
| ```sh | ||
| npm init |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this needed if it's above?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed. Deleted.
docs/getting-started.md
Outdated
| #### Create a `gulpfile` | ||
|
|
||
| Create a file called `gulpfile.js` in your project root with these contents: | ||
| In your project directory create a file called `gulpfile.js` in your project root with these contents: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
comma after "In your project directory"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"called" -> "named"?
|
|
||
| #### Result | ||
|
|
||
| Voila! The default task will run and do nothing. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How does this happen?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What do you mean? Isn't all of this just magic?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missed a part, this is fine.
docs/getting-started.md
Outdated
| Voila! The default task will run and do nothing. | ||
|
|
||
| ```sh | ||
| Using gulpfile ~/gulp/gulpfile.js |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Change /gulp/ to my-project?
docs/getting-started.md
Outdated
| [11:15:51] Finished 'default' after 103 μs | ||
| ``` | ||
|
|
||
| To run multiple tasks, you can use `gulp <task> <othertask>`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does this help or confuse?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No idea whether it helps or confuses, because I don't really know what it means. Maybe a screenshot instead? Or we could just delete it? Do people know what it should look like when it "does nothing"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should be moved into "Test it out" section
|
|
||
| To run multiple tasks, you can use `gulp <task> <othertask>`. | ||
|
|
||
| ## Where do I go now? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Want to do any improvements to this section?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure!
docs/getting-started.md
Outdated
| # Getting Started | ||
|
|
||
| *If you've previously installed gulp globally, run `npm rm --global gulp` before following these instructions.* | ||
| *If you've [previously installed](https://medium.com/gulpjs/gulp-sips-command-line-interface-e53411d4467) gulp globally, run `npm rm --global gulp` before following these instructions.* |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't like "previously installed" as the link text
docs/getting-started.md
Outdated
| #### Check for Node and npm | ||
| Make sure that you've installed Node and npm before attempting to install gulp. | ||
|
|
||
| ```node --version``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should have the npm --version command also.
|
|
||
| #### Result | ||
|
|
||
| Voila! The default task will run and do nothing. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missed a part, this is fine.
docs/getting-started.md
Outdated
| [11:15:51] Finished 'default' after 103 μs | ||
| ``` | ||
|
|
||
| To run multiple tasks, you can use `gulp <task> <othertask>`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should be moved into "Test it out" section
|
Thanks! |
No description provided.