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

[docs] Info about the help command usage #5312

Merged
merged 3 commits into from Jan 17, 2017

Conversation

Projects
None yet
7 participants
@DirtyF
Member

DirtyF commented Sep 1, 2016

Help users getting help.

A reply to this feedback: #5260 (comment)

/cc @jekyll/documentation, @stffndk

@DirtyF

This comment has been minimized.

Show comment
Hide comment
@DirtyF
Member

DirtyF commented Sep 1, 2016

jekyll-help-command

@stffndk

This comment has been minimized.

Show comment
Hide comment
@stffndk

stffndk Sep 1, 2016

I would love to see it added to the /quickstart/ page as well.

stffndk commented Sep 1, 2016

I would love to see it added to the /quickstart/ page as well.

@parkr

This comment has been minimized.

Show comment
Hide comment
@parkr

parkr Sep 1, 2016

Member

LGTM!

Member

parkr commented Sep 1, 2016

LGTM!

@adamhollett

This comment has been minimized.

Show comment
Hide comment
@adamhollett

adamhollett Sep 1, 2016

Contributor

Nitpick — how about:

You can use the help command to remind you of all available options and usage. It also works with...

That makes the sentence focus on the user and not the command.

Contributor

adamhollett commented Sep 1, 2016

Nitpick — how about:

You can use the help command to remind you of all available options and usage. It also works with...

That makes the sentence focus on the user and not the command.

@chrisfinazzo

This comment has been minimized.

Show comment
Hide comment
@chrisfinazzo

chrisfinazzo Sep 1, 2016

Contributor

@stffndk By this, do you mean the same Information block? Would like to keep things DRY if possible.

Perhaps something like the following:

The help command is available to remind you of all available options and usage patterns. It also works in conjunction with the build, serve, and new subcommands, e.g, jekyll help new or jekyll help build.

Contributor

chrisfinazzo commented Sep 1, 2016

@stffndk By this, do you mean the same Information block? Would like to keep things DRY if possible.

Perhaps something like the following:

The help command is available to remind you of all available options and usage patterns. It also works in conjunction with the build, serve, and new subcommands, e.g, jekyll help new or jekyll help build.

@DirtyF

This comment has been minimized.

Show comment
Hide comment
@DirtyF

DirtyF Sep 1, 2016

Member

@admhlt done.

@chrisfinazzo yeah, I was a bit relunctant too, but I inserted a slightly modified version less visible at the end of the quickstart page to give it a shot though. It can not hurt.

Member

DirtyF commented Sep 1, 2016

@admhlt done.

@chrisfinazzo yeah, I was a bit relunctant too, but I inserted a slightly modified version less visible at the end of the quickstart page to give it a shot though. It can not hurt.

@chrisfinazzo

This comment has been minimized.

Show comment
Hide comment
@chrisfinazzo

chrisfinazzo Sep 1, 2016

Contributor

@DirtyF Gotcha 👍🏻

Contributor

chrisfinazzo commented Sep 1, 2016

@DirtyF Gotcha 👍🏻

@parkr

This comment has been minimized.

Show comment
Hide comment
@parkr

parkr Sep 2, 2016

Member

👍

LGTM!

Member

parkr commented Sep 2, 2016

👍

LGTM!

@benbalter benbalter removed their assignment Jan 9, 2017

@parkr

parkr approved these changes Jan 17, 2017

@parkr

This comment has been minimized.

Show comment
Hide comment
@parkr

parkr Jan 17, 2017

Member

@DirtyF Please fix the conflicts (you should be able to do it in your browser) then merge at will! Thanks!

Member

parkr commented Jan 17, 2017

@DirtyF Please fix the conflicts (you should be able to do it in your browser) then merge at will! Thanks!

@DirtyF

This comment has been minimized.

Show comment
Hide comment
@DirtyF

DirtyF Jan 17, 2017

Member

@jekyllbot: merge +doc

Member

DirtyF commented Jan 17, 2017

@jekyllbot: merge +doc

@DirtyF DirtyF closed this Jan 17, 2017

@jekyllbot jekyllbot merged commit 321364e into jekyll:master Jan 17, 2017

0 of 2 checks passed

continuous-integration/appveyor/pr Waiting for AppVeyor build to complete
Details
continuous-integration/travis-ci/pr The Travis CI build is in progress
Details

jekyllbot added a commit that referenced this pull request Jan 17, 2017

@DirtyF DirtyF deleted the DirtyF:docs-usage-help branch Jan 17, 2017

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