Remove references to the watch command in the docs #2954

Merged
merged 3 commits into from Sep 27, 2014

Conversation

Projects
None yet
3 participants
@chrisfinazzo
Contributor

chrisfinazzo commented Sep 26, 2014

As of 2.4, serve happens automatically every time you make a build. If it's no longer in the gem as a separate feature, this can be removed.

Thoughts?

@chrisfinazzo chrisfinazzo changed the title from Remove references to the watch command in the sample to Remove references to the watch command in the docs Sep 26, 2014

@parkr

View changes

site/_docs/usage.md
@@ -46,9 +46,6 @@ $ jekyll serve --detach
# => Same as `jekyll serve` but will detach from the current terminal.
# If you need to kill the server, you can `kill -9 1234` where "1234" is the PID.
# If you cannot find the PID, then do, `ps aux | grep jekyll` and kill the instance. [Read more](http://unixhelp.ed.ac.uk/shell/jobz5.html).
-
-$ jekyll serve --watch

This comment has been minimized.

@parkr

parkr Sep 26, 2014

Member

Maybe change this to jekyll serve --no-watch?

@parkr

parkr Sep 26, 2014

Member

Maybe change this to jekyll serve --no-watch?

This comment has been minimized.

@chrisfinazzo

chrisfinazzo Sep 26, 2014

Contributor

Either way is fine. It depends on how verbose you think it needs to be.

FWIW, I usually just wrap the commands in a test.sh script and run it that way, so --watch is not a switch I flip frequently (Default behavior is enabled).

If you can think of a use case where a separate command makes sense, go for it.

@chrisfinazzo

chrisfinazzo Sep 26, 2014

Contributor

Either way is fine. It depends on how verbose you think it needs to be.

FWIW, I usually just wrap the commands in a test.sh script and run it that way, so --watch is not a switch I flip frequently (Default behavior is enabled).

If you can think of a use case where a separate command makes sense, go for it.

This comment has been minimized.

@parkr

parkr Sep 26, 2014

Member

I think we should show an example with --no-watch so it's obvious that it exists. We should also add a note to jekyll serve that says it automatically regenerates.

@parkr

parkr Sep 26, 2014

Member

I think we should show an example with --no-watch so it's obvious that it exists. We should also add a note to jekyll serve that says it automatically regenerates.

@parkr parkr merged commit 7539e21 into jekyll:master Sep 27, 2014

1 check passed

continuous-integration/travis-ci The Travis CI build passed
Details

parkr added a commit that referenced this pull request Sep 27, 2014

@chrisfinazzo chrisfinazzo deleted the chrisfinazzo:remove-explicit-serve-from-docs branch Sep 27, 2014

@chrisfinazzo chrisfinazzo restored the chrisfinazzo:remove-explicit-serve-from-docs branch Sep 28, 2014

@jekyll jekyll locked and limited conversation to collaborators Feb 27, 2017

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.