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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Proofread and fix up the documentation #989

Merged
merged 15 commits into from Apr 26, 2013

Conversation

Projects
None yet
4 participants
@mattr-
Member

mattr- commented Apr 19, 2013

The docs were already awesome to begin with. Now, after sitting down with my trusty copy of Strunk and White, they are even more awesome. 馃挜

mattr- added some commits Apr 19, 2013

Add a missing comma
We have three or more terms with a single conjunction. According to Strunk and
White, we need a comma.
Add a missing 'the'
We're serving the website. There can be only one.
Be explicit about what we require when migrating systems
We require access to the database from the old system and we're generating posts
for Jekyll.
Use 'newer' instead of 'future'
When talking about versions of Drupal greater than 6.1, use the word newer to
indicate that those versions have already been released. The word future implies
that those versions haven't been released yet.
Remove the word 'also' when describing Typo migrations.
The use of the 'also' is out of place here. We're only talking about one thing.
Tell people to update the site not the wiki.
We want to kill the wiki with fire.
@zachgersh

This comment has been minimized.

Contributor

zachgersh commented Apr 19, 2013

Strunk & White have served you well 馃憤

@@ -207,7 +207,7 @@ before your site is served.
<tr class='setting'>
<td>
<p class='name'><strong>Base URL</strong></p>
<p class='description'>Serve website with the given base URL</p>
<p class='description'>Serve the website at the given base URL</p>

This comment has been minimized.

@parkr

parkr Apr 19, 2013

Member

I'd use "from" instead of "at" here

This comment has been minimized.

@mattr-

mattr- Apr 19, 2013

Member

I went around and around as to what word to use here. I'll look at it again.

@@ -53,7 +54,7 @@ There are a number of predefined global variables that you can set in the front-
<p>
If set, this specifies the layout file to use. Use the layout file
name without file extension. Layout files must be placed in the
name without a file extension. Layout files must be placed in the

This comment has been minimized.

@parkr

parkr Apr 19, 2013

Member

without the file extension?

This comment has been minimized.

@mattr-

mattr- Apr 20, 2013

Member

Could go either way. Can't hurt to change it.

@@ -4,11 +4,11 @@ title: Welcome
next_section: installation
---
This site aims to be a comprehensive guide to Jekyll. We鈥檒l cover everything
from getting your site up and running, creating and managing your content,
This site aims to be a comprehensive guide to Jekyll. We鈥檒l cover topics such

This comment has been minimized.

@parkr

parkr Apr 19, 2013

Member

You didn't like the colloquial "we'll cover everything from -- to --"?

This comment has been minimized.

@mattr-

mattr- Apr 19, 2013

Member

That colloquial is fine. There was no 'to' at the end, though, so I changed it.

<p>This migrator was written for Drupal 6.1 and may not work as expected on future versions of Drupal. Please update it and send us a pull request if necessary.</p>
<p>This migrator was written for Drupal 6.1 and may not work as expected with
newer versions of Drupal. Please update it and send us a pull request if
necessary.</p>

This comment has been minimized.

@parkr

parkr Apr 19, 2013

Member

GOOD NEWS! We have both a Drupal 6 and a Drupal 7 migrator now. And I think everything is prefixed with jekyll/jekyll-import/MIGRATOR.rb.

This comment has been minimized.

@mattr-

mattr- Apr 20, 2013

Member

Cool. Noted for later. Won't update that as part of this branch since this was strictly only about proofreading.

@@ -165,14 +199,17 @@ $ ruby -rubygems -e 'require "jekyll/migrators/posterous";
Jekyll::Posterous.process("my_email", "my_pass")'
{% endhighlight %}
For any other Posterous blog on your account, you will need to specify the `blog_id` for the blog:
For any other Posterous blog on your account, you will need to specify the
`blog_id` for the blog:
{% highlight bash %}
$ ruby -rubygems -e 'require "jekyll/migrators/posterous";
Jekyll::Posterous.process("my_email", "my_pass", "blog_id")'

This comment has been minimized.

@parkr

parkr Apr 19, 2013

Member

The importers are also prefixed JekyllImport::MIGRATOR. No clue why @mojombo chose to do that, but it's the current state.

This comment has been minimized.

@mattr-

mattr- Apr 20, 2013

Member

So it's JekyllImport::Posterous, right?

This comment has been minimized.

@parkr

parkr Apr 22, 2013

Member

Yeah in this case and in all the others. We can defer on this until @mojombo comes back from the dead ;)

@@ -201,4 +241,5 @@ $ ruby -rubygems -e 'require "jekyll/migrators/tumblr";
## Other Systems
If you have a system that there isn鈥檛 currently a migrator for, you should consider writing one and sending us a pull request.
If you have a system that there isn鈥檛 currently a migrator for, you should

This comment has been minimized.

@parkr

parkr Apr 19, 2013

Member

"If you have a system for which there is currently no migrator, consider writing one and sending us a pull request."

This comment has been minimized.

@mattr-

mattr- Apr 20, 2013

Member

You fancy! 馃帺 馃榾

@parkr

This comment has been minimized.

Member

parkr commented Apr 19, 2013

The migrator stuff will need to be cleaned up a lot once we get jekyll-import finished.

@mattr-

This comment has been minimized.

Member

mattr- commented Apr 19, 2013

Agreed. That's why I didn't spend a lot of time on it.

@mattr-

This comment has been minimized.

Member

mattr- commented Apr 20, 2013

Good comments. PR updated.

@parkr

This comment has been minimized.

Member

parkr commented Apr 26, 2013

馃憤

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

Merge pull request #989 from mojombo/docs-proofreading
Proofread and fix up the documentation

@parkr parkr merged commit d2f364b into master Apr 26, 2013

1 check passed

default The Travis build passed
Details

@parkr parkr deleted the docs-proofreading branch Apr 26, 2013

parkr added a commit that referenced this pull request Apr 26, 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.