Ben Balter

James DiGioia

<p><em>A WordPress plugin to sync content with a GitHub repository (or Jekyll site)</em></p>
<p><a href="https://scrutinizer-ci.com/g/mAAdhaTTah/wordpress-github-sync/build-status/master" rel="nofollow ugc"></a> <a href="https://scrutinizer-ci.com/g/mAAdhaTTah/wordpress-github-sync/?branch=master" rel="nofollow ugc"></a> <a href="https://scrutinizer-ci.com/g/mAAdhaTTah/wordpress-github-sync/?branch=master" rel="nofollow ugc"></a></p>
<p>Ever wish you could collaboratively author content for your WordPress site (or expose change history publicly and accept pull requests from your readers)?</p>
<p>Looking to tinker with Jekyll, but wish you could use WordPress’s best-of-breed web editing interface instead of Atom? (gasp!)</p>
<p>Well, now you can! Introducing <a href="https://github.com/mAAdhaTTah/wordpress-github-sync" rel="nofollow ugc">WordPress  GitHub Sync</a>!</p>
<h4>WordPress  GitHub Sync does three things:</h4>
<ol>
<li>Allows content publishers to version their content in GitHub, exposing “who made what change when” to readers</li>
<li>Allows readers to submit proposed improvements to WordPress-served content via GitHub’s Pull Request model</li>
<li>Allows non-technical writers to draft and edit a Jekyll site in WordPress’s best-of-breed editing interface</li>
</ol>
<h4>WordPress  GitHub sync might be able to do some other cool things:</h4>
<ul>
<li>Allow teams to collaboratively write and edit posts using GitHub (e.g., pull requests, issues, comments)</li>
<li>Allow you to sync the content of two different WordPress installations via GitHub</li>
<li>Allow you to stage and preview content before “deploying” to your production server</li>
</ul>
<h4>How it works</h4>
<p>The sync action is based on two hooks:</p>
<ol>
<li>A per-post sync fired in response to WordPress’s <code>save_post</code> hook which pushes content to GitHub</li>
<li>A sync of all changed files triggered by GitHub’s <code>push</code> webhook (outbound API call)</li>
</ol>


WordPress  GitHub Sync

A WordPress plugin to sync content with a GitHub repository (or Jekyll site)

Daniel Bachhuber

Aaron Jorbin

<p>WordPress Post Forking allows users to “fork” or create an alternate version of content to foster a more collaborative approach to WordPress content curation. This can be used, for example, to allow external users (such as visitors to your site) or internal users (such as other authors) with the ability to submit proposed revisions. It can even be used on smaller or single-author sites to enable post authors to edit published posts without their changes appearing immediately. If you’re familiar with Git, or other decentralized version control systems, you’re already familiar with WordPress post forking.</p>
<h4>How might you use it?</h4>
<ul>
<li>Allowing users without edit or publish post capabilities to edit and submit changes to content (similar to <a href="https://help.github.com/articles/using-pull-requests" rel="nofollow ugc">GitHub’s pull request system</a>)</li>
<li>Collaborative editing (by resolving two users’ conflicted saves – <a href="http://www.wired.com/wiredenterprise/2012/02/github-revisited/" rel="nofollow ugc">Wired’s example</a>)</li>
<li>Saving draft changes of already-published content</li>
<li>Scheduling pending changes to already-published content</li>
</ul>
<h4>How does it work?</h4>
<p>When a user without the <code>edit_post</code> capability attempts to edit a given post, WordPress will automatically create a “fork” or alternate version of the post which they can freely edit. The edit screen will look just like the standard post editing interface that they are used to. When they’re done, they simply click “submit for review.” At this point, the fork goes into the standard WordPress moderation queue (just like any time an author without the <code>publish_post</code> capability submits a post), where an editor can review, and potentially approve the changes for publishing. If the changes can be automatically merged, the original post will be updated, otherwise, the editor will be presented with the ability to resolve the conflicting changes. All this is done using WordPress’s built-in custom post type, revision, and diff functionality, so it should look familiar to most WordPress users.</p>
<h4>Concepts</h4>
<p>WordPress Post Forking introduces many of Git’s well-established conventions to the WordPress world, and as a result, uses a unique vocabulary to describe what it does:</p>
<ul>
<li><strong>Post</strong> – Any WordPress post that uses the <code>post_content</code> field, including posts, pages, and custom post types</li>
<li><strong>Fork</strong> – Clone of a post intended for editing without disturbing the parent post</li>
<li><strong>Branch</strong> – Parallel versions of the same parent post, owned by the post author</li>
<li><strong>Merge</strong> – To push a fork’s changes back into its parent post</li>
<li><strong>Conflict</strong> – When a post is forked if a given line is changed on the fork, and that same line is subsequently edited on the parent post prior to the merge, the post cannot be automatically merged, and the conflict is presented to the merger to resolve</li>
</ul>
<h4>Why this plugin?</h4>
<ul>
<li><a href="http://ben.balter.com/2012/02/28/github-for-journalism-what-wordpress-post-forking-could-do-to-editorial-workflows/" rel="nofollow ugc">GitHub for Journalism — What WordPress Post Forking could do to Editorial Workflows<br />
</a></li>
</ul>
<h4>Project Status</h4>
<p>This version constitutes an initial release designed to showcase the plugin’s core functionality and is intended to be improved upon with additional features and refinements as the project evolves. Please consider <a href="https://github.com/benbalter/post-forking/wiki/How-to-Contribute" rel="nofollow ugc">contributing your time</a> to help improve the project.</p>
<h4>More Information</h4>
<p>For more information, or to contribute to this documentation, please visit the <a href="https://github.com/benbalter/post-forking/wiki" rel="nofollow ugc">Post Forking project wiki</a>.</p>
<p>[Photo courtesy <a href="http://www.flickr.com/photos/babomike/5626846346/" rel="nofollow ugc">babomike</a>]</p>
<h3>How To Contribute</h3>
<p>Post Forking is an open source project and is supported by the efforts of an entire community. We’d love for you to get involved. Whatever your level of skill or however much time you can give, your contribution is greatly appreciated.</p>
<ul>
<li><strong>Everyone</strong> – Help expand <a href="https://github.com/benbalter/post-forking/wiki/" rel="nofollow ugc">the project’s documentation wiki</a> and answer questions in the support forums to make it easier for other users to get started, or join the discussion on the <a href="http://postforking.wordpress.com" rel="nofollow ugc">P2 (Blog)</a> to help shape the project’s future.</li>
<li><strong>Users</strong> – Download the <a href="https://github.com/benbalter/post-forking/tree/develop" rel="nofollow ugc">latest development version</a> of the plugin, and <a href="https://github.com/benbalter/post-forking/issues" rel="nofollow ugc">submit bug/feature requests</a>.</li>
<li><strong>Non-English Speakers</strong> – <a href="http://translations.benbalter.com/" rel="nofollow ugc">Contribute a translation</a> using the GlotPress web interface – no technical knowledge required (<a href="http://translations.benbalter.com/projects/how-to-translate" rel="nofollow ugc">how to</a>).</li>
<li><strong>Technical Folks</strong> – <a href="https://github.com/benbalter/post-forking/tree/develop" rel="nofollow ugc">Fork the development version</a> and submit a pull request, especially for any <a href="https://github.com/benbalter/post-forking/issues" rel="nofollow ugc">known issues</a>. <a href="https://help.github.com/articles/set-up-git" rel="nofollow ugc">This tutorial</a> may be helpful if you’re new to git.</li>
</ul>
<h3>Roadmap</h3>
<h4>Future Features (Maybe):</h4>
<ul>
<li>Front end editing (just click edit, make your change, hit submit)</li>
<li>Ability to fork more than just the <code>post_content</code> (e.g., taxonomies, post meta)</li>
<li><a href="https://github.com/benbalter/post-forking/issues/15" rel="nofollow ugc">Appending parent revision history to fork</a></li>
<li>Spoofing <code>post_type</code> so metaboxes, etc. appear</li>
<li><a href="https://github.com/benbalter/post-forking/issues/17" rel="nofollow ugc">Author pages for fork contributors</a></li>
<li><a href="https://github.com/benbalter/post-forking/issues?labels=enhancement&page=1&state=open" rel="nofollow ugc">Open Enhancements</a></li>
</ul>
<h3>Under The Hood</h3>
<p>** <strong>Warning: geek content!</strong> **</p>
<p>Forking a post creates a copy of the most recent version of the post as a “fork” custom post type. Certain fields (e.g., <code>post_content</code>, <code>post_title</code>) are copied over to the new fork. The plugin also stores the revision ID for the revision prior to when the fork was created (see <a href="https://github.com/benbalter/post-forking/blob/master/includes/revisions.php#L2" rel="nofollow ugc"><code>includes/revisions.php</code></a> for more information as to why we store the previous revision).</p>
<p>The fork post type has its own capabilities, allowing a user without the ability to edit or publish on the parent post to edit a fork. Once changes have been made, assuming the user does not have the <code>publish_fork</code> capability, the user would submit the fork for review (similar to submitting a Pull Request in GitHub parlance) using the normal WordPress moderation system.</p>
<p>Publishing a fork (either by the fork author, if they have the capability, or my an editor) triggers the merge itself. The post content of the fork undergoes a three way merge with the base revision and current version of the parent post.</p>
<p>A fork can have three post statuses:</p>
<ol>
<li>Draft – The fork is being edited</li>
<li>Pending – The fork has been submitted for publication</li>
<li>Published – The fork has been merged</li>
</ol>
<p>Note: No user should have the <code>edit_published_fork</code> capability. Once published, the fork post_type simply exists to provide a record of the change and allow the author page, to theoretically list contributions by author.</p>
<h3>Where To Get Support Or Report An Issue</h3>
<p><em>There are various resources available, depending on the type of help you’re looking for:</em></p>
<ul>
<li>For getting started and general documentation, please browse, and feel free to contribute to <a href="https://github.com/benbalter/post-forking/wiki" rel="nofollow ugc">the project wiki</a>.</li>
<li>For support questions (“How do I”, “I can’t seem to”, etc.) please search and if not already answered, open a thread in the <a href="https://wordpress.org/support/plugin/post-forking" rel="ugc">Support Forums</a>.</li>
<li>For technical issues (e.g., to submit a bug or feature request) please search and if not already filed, <a href="https://github.com/benbalter/post-forking/issues" rel="nofollow ugc">open an issue on GitHub</a>.</li>
<li>For implementation, and all general questions (“Is it possible to..”, “Has anyone…”), please search, and if not already answered, post a topic to the <a href="https://groups.google.com/forum/#!forum/post-forking" rel="nofollow ugc">general discussion list serve</a></li>
<li>For general discussion about the project and planning, please see the <a href="http://postforking.wordpress.com" rel="nofollow ugc">P2</a></li>
</ul>


Post Forking

I wish I knew about this one some years ago when I was helping a few publishers with polishing their editorial workflows... This seems to be running just fine even now, 7 years after its last update o_0

Amazing!

WordPress Post Forking allows users to fork or create an alternate version of content to foster a more collaborative approach to WordPress content cur …

WordPress GitHub Sync vs Post Forking