Skip to content

Commit

Permalink
Eventually consistent.
Browse files Browse the repository at this point in the history
  • Loading branch information
Michael Aufreiter committed Aug 1, 2012
1 parent a8ba5b6 commit 4941644
Show file tree
Hide file tree
Showing 15 changed files with 87 additions and 131 deletions.
51 changes: 50 additions & 1 deletion _includes/styles/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -1575,7 +1575,8 @@ ul.site li a {

.help {
width: 960px;
margin: 20px auto;
margin: 0px auto;
margin-top: 20px;
}

.help h2 {
Expand Down Expand Up @@ -1626,6 +1627,54 @@ ul.site li a {
margin: 30px auto;
}


.improve-article-wrapper a.button {
width: 100px;
float: left;
color: rgba(255,255,255, 0.8);
display: block;
line-height: 1.5em;

/*margin: 30px 250px;*/
padding: 20px 0;
background: rgba(0,0,0, 0.7);
border: 1px solid #CCC;
border-radius: 5px;
font-weight: bold;
text-align: center;
}

.improve-article-wrapper a.button:hover {
background: rgba(0,0,0, 0.8);
color: rgba(255,255,255, 1);
}

.improve-article-wrapper {
font-size: 20px;
padding: 20px 0;
/*border-top: 1px solid #CCC;*/
background: rgba(255,255, 255, 0.6);

width: 960px;
margin: 0px auto;
margin-bottom: 20px;
border: 1px solid #C3CCD0;
border-top: none;
box-shadow: 0 1px 0 rgba(255, 255, 255, 0),0 0 10px rgba(0, 0, 0, 0.1);
}

.improve-article {
overflow: auto;
width: 800px;
margin: 20px auto;
}

.improve-article p {
padding-top: 13px;
margin-left: 130px;
}


/* ------------------------------------------
Notifications
---------------------------------------------*/
Expand Down
9 changes: 9 additions & 0 deletions _layouts/help.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,13 @@

{{ content }}
<div class="meta"> Posted by <a href="http://twitter.com/{{page.author_twitter}}" target="_blank">{{page.author}}</a> on {{ page.date | date: "%B %d, %Y" }} </div>
</div>

<div class="improve-article-wrapper">
<div class="improve-article">
<a class="button" href="{{ page.prose_link }}">Edit in Prose</a>
<p>
This article has been written and published using <a href="http://prose.io" target="_blank">Prose</a>. Please help improving this documentation by contributing to the text.
</p>
</div>
</div>
112 changes: 0 additions & 112 deletions _posts/help/2012-06-20-blogpost.md

This file was deleted.

1 change: 1 addition & 0 deletions _posts/help/2012-06-20-getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ descr: A brief introduction on how to use Prose, what it can do for you and what
image: http://prose.io/images/help/getting-started.png
author_twitter: _mql
author: Michael Aufreiter
prose_link: http://prose.io/#prose/prose/edit/gh-pages/_posts/help/2012-06-20-getting-started.md
categories:
- help
published: true
Expand Down
1 change: 1 addition & 0 deletions _posts/help/2012-06-20-handbook.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ descr: A reference guide. In progress.
image: http://prose.io/images/help/handbook.png
author_twitter: _mql
author: Michael Aufreiter
prose_link: http://prose.io/#prose/prose/edit/gh-pages/_posts/help/2012-06-20-handbook.md
categories:
- help
published: true
Expand Down
1 change: 1 addition & 0 deletions _posts/help/2012-06-20-internals.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ descr: A little background on how we implemented Prose.
image: http://prose.io/images/help/internals.png
author_twitter: _mql
author: Michael Aufreiter
prose_link: http://prose.io/#prose/prose/edit/gh-pages/_posts/help/2012-06-20-internals.md
categories:
- help
published: true
Expand Down
1 change: 1 addition & 0 deletions _posts/help/2012-06-20-prose-for-writers.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ descr: How to use Prose as a writing workspace.
image: http://prose.io/images/help/prose-for-writers.png
author_twitter: _mql
author: Michael Aufreiter
prose_link: http://prose.io/#prose/prose/edit/gh-pages/_posts/help/2012-06-20-prose-for-writers.md
published: true
categories:
- help
Expand Down
42 changes: 24 additions & 18 deletions _posts/help/2012-08-01-eventually-consistent.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
---
layout: default
published: false
layout: help
title: Eventually consistent
descr: Or how continuously improving content in the open beats the best review process.
image: http://prose.io/images/help/cells.png
author_twitter: _mql
author: Michael Aufreiter
prose_link: http://prose.io/#prose/prose/edit/gh-pages/_posts/help/2012-08-01-eventually-consistent.md
categories:
- help
published: true
---

# Eventually consistent

Most things in life are not perfect. That's also true for your writings. Every writer, journalist or scientist can tell you about it. There will always be room for improvement.

Essentially, there are two ways you can approach this problem:
Expand All @@ -17,44 +23,44 @@ With the latest release of [Prose.io](http://prose.io) we'd like to propose a wo
Leveraging collaboration is not a new idea. People have been invited to contribute to published information for a long while. Letters to the editor are as old as newspapers and in the digital world people can respond to articles by leaving a comment.


# Humans need to contribute
## Humans need to contribute

You know that feeling, when you read through an online article and an obvious typo is literally jumping at your face. It's disturbing. But it's there. There's nothing you can do about it.
You know that feeling, when you read through an online article and an obvious mitsake is literally jumping at your face. It's disturbink. But it's there. There's nothing you could do about it.

![Read Article](http://farm8.staticflickr.com/7136/7686114380_53c5cc53f0.jpg)
![Read Article](/images/screenshots/eventually-consistent/spotting-error.png)


# Removing the hurdles
## Removing the hurdles

The most essential problem is that it's pretty hard to get involved. What if you could just put a link next to your article enabling users to contribute to the text directly? With Prose and Jekyll this is now possible.

![Edit in Prose](http://farm9.staticflickr.com/8429/7686113722_2e2044fdff.jpg)
![Edit in Prose](/images/screenshots/eventually-consistent/edit-in-prose.png)


# Suggest a change
## Suggest a change

Once the user clicked on this link he is able to edit the contents of the article he was just reading.

![Content shown in Prose](http://farm9.staticflickr.com/8426/7686114230_c5bc0b2927.jpg)
![Content shown in Prose](/images/screenshots/eventually-consistent/prose-document.png)

Prose requires you to be authenticated with GitHub first, once that is done you will be able to edit that content and send a patch, which looks like this:

![Send patch](http://farm8.staticflickr.com/7277/7686114584_47440d2783.jpg)
![Send patch](/images/screenshots/eventually-consistent/send-patch.png)


# Applying a change
## Applying a change

Once a suggestion, a patch has been submitted, the original author gets notified via GitHub. In order to apply that change he has to review the Pull Request that has been created automatically.

![Apply changes](http://farm9.staticflickr.com/8421/7686113582_ae24d9fcd4.jpg)
![Apply changes](/images/screenshots/eventually-consistent/apply-patch.png)

# The Result
## The Result

Seconds later the applied fix will be visible on the actual website.

![Voilá](http://farm8.staticflickr.com/7107/7686113394_48d9fb649a.jpg)
![Voilá](/images/screenshots/eventually-consistent/updated-website.png)


# Finally
## Finally

This article isn't perfect either, help make it better by submitting a [patch](http://prose.io/#developmentseed/developmentseed.github.com/edit/master/_posts/blog-2012/2012-07-31-eventually-consistent.md).
This article isn't perfect either, help make it better by submitting a [patch](http://prose.io/#prose/prose/edit/gh-pages/_posts/help/2012-08-01-eventually-consistent.md).
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 4941644

Please sign in to comment.