Skip to content
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
Merged

[docs] Info about the help command usage #5312

merged 3 commits into from
Jan 17, 2017

Conversation

DirtyF
Copy link
Member

@DirtyF DirtyF commented Sep 1, 2016

Help users getting help.

A reply to this feedback: #5260 (comment)

/cc @jekyll/documentation, @stffndk

@DirtyF
Copy link
Member Author

DirtyF commented Sep 1, 2016

jekyll-help-command

@stffndk
Copy link

stffndk commented Sep 1, 2016

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

@parkr
Copy link
Member

parkr commented Sep 1, 2016

LGTM!

@adamhollett
Copy link
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
Copy link
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.

@DirtyF
Copy link
Member Author

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
Copy link
Contributor

@DirtyF Gotcha 👍🏻

@parkr
Copy link
Member

parkr commented Sep 2, 2016

👍

LGTM!

@benbalter benbalter removed their assignment Jan 9, 2017
@parkr
Copy link
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
Copy link
Member Author

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
jekyllbot added a commit that referenced this pull request Jan 17, 2017
@DirtyF DirtyF deleted the docs-usage-help branch January 17, 2017 08:34
@jekyll jekyll locked and limited conversation to collaborators Jul 11, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants