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

Clean up site docs to prepare for 1.0 release. #918

Merged
merged 7 commits into from Apr 7, 2013

Conversation

Projects
None yet
5 participants
@mojombo
Contributor

mojombo commented Apr 3, 2013

I spent a bunch of hours on the docs in the new site trying to bring them up to speed with the current master branch. There is still more work to do, but I this is a good start.

would be appreciated, and once merged it will be transferred over to the main
wiki.
* If your contribution changes any Jekyll behavior, make sure to update the
documentation. It lives in `site/_posts`. If the docs are missing information,

This comment has been minimized.

@parkr

parkr Apr 3, 2013

Member

Why are we only asking for docs for updated/changed features? Shouldn't new features also require documentation?

To run the test suite and build the gem you’ll need to install Jekyll’s dependencies. Jekyll uses Bundler, so a quick run of the bundle command and you’re all set!
To run the test suite and build the gem you'll need to install Jekyll's
dependencies. Jekyll uses Bundler, so a quick run of the bundle command and

This comment has been minimized.

@parkr

parkr Apr 3, 2013

Member

Should we use backticks for the bundle command?

...of the `bundle` command...
pip install pygments
$ easy_install pip
$ pip install --upgrade distribute
$ pip install pygments

This comment has been minimized.

@parkr

parkr Apr 3, 2013

Member

The $ makes it harder to copy and paste them in, unless that doesn't matter?

This comment has been minimized.

@mojombo

mojombo Apr 7, 2013

Contributor

I don't think it's a huge problem. I like having these be consistent across the site, and the $ gives context. Honestly, I'd rather have people think about what they're copy/pasting into their terminals, instead of just blindly doing it with a bunch of lines.

If set, this specifies the layout file to use. Use the layout file
name without file extension. Layout files must be placed in the
<code>_layouts</code> directory.

This comment has been minimized.

@parkr

parkr Apr 3, 2013

Member

Why the extra space here and above?

This comment has been minimized.

@mojombo

mojombo Apr 7, 2013

Contributor

Because it allows the hard wrapping command in Vim, Sublime, etc to work properly. Otherwise it gets greedy and acts upon the surrounding lines too. I left it this way to make it easier for future contributes to change the content and run the same command without having to manually add those blank lines.

@parkr

This comment has been minimized.

Member

parkr commented Apr 3, 2013

Looks like there are some visual issues with breaking up certain things:

Screen Shot 2013-04-03 at 7 26 31 PM

<p>
If you need your processed blog post URLs to be something other than
the default <code>/year/month/day/title.html</code> then you can set

This comment has been minimized.

@parkr

parkr Apr 3, 2013

Member

Why don't we use backticks here?

This comment has been minimized.

@mojombo

mojombo Apr 7, 2013

Contributor

Markdown does not operate inside HTML.

{% endhighlight %}
<div class="note warning">
<h5>Beware the page one edge-case</h5>
<p>Jekyll does not generate a ‘page1’ folder, so the above code will not work when a <code>/page1</code> link is produced. See below for a way to handle this if it’s a problem for you.</p>
<p>
Jekyll does not generate a ‘page1’ folder, so the above code will not work

This comment has been minimized.

@parkr

parkr Apr 3, 2013

Member

Are those fancy quotes or are they backwards backticks? :-)

This comment has been minimized.

@mattr-

mattr- Apr 3, 2013

Member

They're fancy quotes. http://quotesandaccents.com/ has a nice reference on the various quotes and accent styles.

This comment has been minimized.

@parkr

parkr Apr 5, 2013

Member

The font GitHub uses doesn't render them like smartquotes I'm used to, but I could see them properly in vim so I'm convinced.

This comment has been minimized.

@mojombo

mojombo Apr 7, 2013

Contributor

I'm guessing all the Unicode smart quotes arrived somehow during the port of the wiki to these Jekyll pages. Ideally we'd replace all smart quotes with dumb apostrophes and let the renderer do it. I was too lazy to actually go through and fix them.

@mattr-

This comment has been minimized.

Member

mattr- commented on site/_posts/2012-07-01-home.md in 17bb13a Apr 3, 2013

I know these are just reformatting changes, but I think we can remove the word 'yourself' here. The revised version would read, “If you come across anything along the way that we haven’t covered, or if you know of a tip you think others would find handy”.

I went ahead and updated the branch to reflect my suggestion. 😄

This comment has been minimized.

Member

parkr replied Apr 3, 2013

Good catch. It could have worked if it were "you yourself" but it is redundant anyway. 👍

@tomde61

This comment has been minimized.

tomde61 commented Apr 4, 2013

Hello all, this is new to me here in GitHub and would like to know if there are any additions from outside users for this setup in the site. At the present time I do not know what I could do to help, in addition, would like to follow along with the procedures and then maybe add to the process if possible. Thanks for the help and guidance with this matter. At present, I attend college in final term majoring in Information Systems Security. tomde61

parkr added a commit that referenced this pull request Apr 7, 2013

Merge pull request #918 from mojombo/awesome-docs
Clean up site docs to prepare for 1.0 release.

@parkr parkr merged commit 3e968ad into master Apr 7, 2013

1 check failed

default The Travis build failed
Details

@parkr parkr deleted the awesome-docs branch Apr 7, 2013

parkr added a commit that referenced this pull request Apr 7, 2013

@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.