dynflow 0.7.6 → 0.7.7

data/doc/pages/source/bootstrap/js/bootstrap.min.js

@@ -0,0 +1,12 @@
+/*!
+ * Bootstrap v3.3.2 (http://getbootstrap.com)
+ * Copyright 2011-2015 Twitter, Inc.
+ * Licensed under MIT (https://github.com/twbs/bootstrap/blob/master/LICENSE)
+ */
+
+/*!
+ * Generated using the Bootstrap Customizer (http://getbootstrap.com/customize/?id=9d12231ad700ab8f1be0)
+ * Config saved to config.json and https://gist.github.com/9d12231ad700ab8f1be0
+ */
+if("undefined"==typeof jQuery)throw new Error("Bootstrap's JavaScript requires jQuery");+function(t){"use strict";var e=t.fn.jquery.split(" ")[0].split(".");if(e[0]<2&&e[1]<9||1==e[0]&&9==e[1]&&e[2]<1)throw new Error("Bootstrap's JavaScript requires jQuery version 1.9.1 or higher")}(jQuery),+function(t){"use strict";function e(e){return this.each(function(){var i=t(this),s=i.data("bs.alert");s||i.data("bs.alert",s=new o(this)),"string"==typeof e&&s[e].call(i)})}var i='[data-dismiss="alert"]',o=function(e){t(e).on("click",i,this.close)};o.VERSION="3.3.2",o.TRANSITION_DURATION=150,o.prototype.close=function(e){function i(){a.detach().trigger("closed.bs.alert").remove()}var s=t(this),n=s.attr("data-target");n||(n=s.attr("href"),n=n&&n.replace(/.*(?=#[^\s]*$)/,""));var a=t(n);e&&e.preventDefault(),a.length||(a=s.closest(".alert")),a.trigger(e=t.Event("close.bs.alert")),e.isDefaultPrevented()||(a.removeClass("in"),t.support.transition&&a.hasClass("fade")?a.one("bsTransitionEnd",i).emulateTransitionEnd(o.TRANSITION_DURATION):i())};var s=t.fn.alert;t.fn.alert=e,t.fn.alert.Constructor=o,t.fn.alert.noConflict=function(){return t.fn.alert=s,this},t(document).on("click.bs.alert.data-api",i,o.prototype.close)}(jQuery),+function(t){"use strict";function e(e){return this.each(function(){var o=t(this),s=o.data("bs.button"),n="object"==typeof e&&e;s||o.data("bs.button",s=new i(this,n)),"toggle"==e?s.toggle():e&&s.setState(e)})}var i=function(e,o){this.$element=t(e),this.options=t.extend({},i.DEFAULTS,o),this.isLoading=!1};i.VERSION="3.3.2",i.DEFAULTS={loadingText:"loading..."},i.prototype.setState=function(e){var i="disabled",o=this.$element,s=o.is("input")?"val":"html",n=o.data();e+="Text",null==n.resetText&&o.data("resetText",o[s]()),setTimeout(t.proxy(function(){o[s](null==n[e]?this.options[e]:n[e]),"loadingText"==e?(this.isLoading=!0,o.addClass(i).attr(i,i)):this.isLoading&&(this.isLoading=!1,o.removeClass(i).removeAttr(i))},this),0)},i.prototype.toggle=function(){var t=!0,e=this.$element.closest('[data-toggle="buttons"]');if(e.length){var i=this.$element.find("input");"radio"==i.prop("type")&&(i.prop("checked")&&this.$element.hasClass("active")?t=!1:e.find(".active").removeClass("active")),t&&i.prop("checked",!this.$element.hasClass("active")).trigger("change")}else this.$element.attr("aria-pressed",!this.$element.hasClass("active"));t&&this.$element.toggleClass("active")};var o=t.fn.button;t.fn.button=e,t.fn.button.Constructor=i,t.fn.button.noConflict=function(){return t.fn.button=o,this},t(document).on("click.bs.button.data-api",'[data-toggle^="button"]',function(i){var o=t(i.target);o.hasClass("btn")||(o=o.closest(".btn")),e.call(o,"toggle"),i.preventDefault()}).on("focus.bs.button.data-api blur.bs.button.data-api",'[data-toggle^="button"]',function(e){t(e.target).closest(".btn").toggleClass("focus",/^focus(in)?$/.test(e.type))})}(jQuery),+function(t){"use strict";function e(e){return this.each(function(){var o=t(this),s=o.data("bs.carousel"),n=t.extend({},i.DEFAULTS,o.data(),"object"==typeof e&&e),a="string"==typeof e?e:n.slide;s||o.data("bs.carousel",s=new i(this,n)),"number"==typeof e?s.to(e):a?s[a]():n.interval&&s.pause().cycle()})}var i=function(e,i){this.$element=t(e),this.$indicators=this.$element.find(".carousel-indicators"),this.options=i,this.paused=this.sliding=this.interval=this.$active=this.$items=null,this.options.keyboard&&this.$element.on("keydown.bs.carousel",t.proxy(this.keydown,this)),"hover"==this.options.pause&&!("ontouchstart"in document.documentElement)&&this.$element.on("mouseenter.bs.carousel",t.proxy(this.pause,this)).on("mouseleave.bs.carousel",t.proxy(this.cycle,this))};i.VERSION="3.3.2",i.TRANSITION_DURATION=600,i.DEFAULTS={interval:5e3,pause:"hover",wrap:!0,keyboard:!0},i.prototype.keydown=function(t){if(!/input|textarea/i.test(t.target.tagName)){switch(t.which){case 37:this.prev();break;case 39:this.next();break;default:return}t.preventDefault()}},i.prototype.cycle=function(e){return e||(this.paused=!1),this.interval&&clearInterval(this.interval),this.options.interval&&!this.paused&&(this.interval=setInterval(t.proxy(this.next,this),this.options.interval)),this},i.prototype.getItemIndex=function(t){return this.$items=t.parent().children(".item"),this.$items.index(t||this.$active)},i.prototype.getItemForDirection=function(t,e){var i=this.getItemIndex(e),o="prev"==t&&0===i||"next"==t&&i==this.$items.length-1;if(o&&!this.options.wrap)return e;var s="prev"==t?-1:1,n=(i+s)%this.$items.length;return this.$items.eq(n)},i.prototype.to=function(t){var e=this,i=this.getItemIndex(this.$active=this.$element.find(".item.active"));return t>this.$items.length-1||0>t?void 0:this.sliding?this.$element.one("slid.bs.carousel",function(){e.to(t)}):i==t?this.pause().cycle():this.slide(t>i?"next":"prev",this.$items.eq(t))},i.prototype.pause=function(e){return e||(this.paused=!0),this.$element.find(".next, .prev").length&&t.support.transition&&(this.$element.trigger(t.support.transition.end),this.cycle(!0)),this.interval=clearInterval(this.interval),this},i.prototype.next=function(){return this.sliding?void 0:this.slide("next")},i.prototype.prev=function(){return this.sliding?void 0:this.slide("prev")},i.prototype.slide=function(e,o){var s=this.$element.find(".item.active"),n=o||this.getItemForDirection(e,s),a=this.interval,r="next"==e?"left":"right",l=this;if(n.hasClass("active"))return this.sliding=!1;var h=n[0],d=t.Event("slide.bs.carousel",{relatedTarget:h,direction:r});if(this.$element.trigger(d),!d.isDefaultPrevented()){if(this.sliding=!0,a&&this.pause(),this.$indicators.length){this.$indicators.find(".active").removeClass("active");var p=t(this.$indicators.children()[this.getItemIndex(n)]);p&&p.addClass("active")}var c=t.Event("slid.bs.carousel",{relatedTarget:h,direction:r});return t.support.transition&&this.$element.hasClass("slide")?(n.addClass(e),n[0].offsetWidth,s.addClass(r),n.addClass(r),s.one("bsTransitionEnd",function(){n.removeClass([e,r].join(" ")).addClass("active"),s.removeClass(["active",r].join(" ")),l.sliding=!1,setTimeout(function(){l.$element.trigger(c)},0)}).emulateTransitionEnd(i.TRANSITION_DURATION)):(s.removeClass("active"),n.addClass("active"),this.sliding=!1,this.$element.trigger(c)),a&&this.cycle(),this}};var o=t.fn.carousel;t.fn.carousel=e,t.fn.carousel.Constructor=i,t.fn.carousel.noConflict=function(){return t.fn.carousel=o,this};var s=function(i){var o,s=t(this),n=t(s.attr("data-target")||(o=s.attr("href"))&&o.replace(/.*(?=#[^\s]+$)/,""));if(n.hasClass("carousel")){var a=t.extend({},n.data(),s.data()),r=s.attr("data-slide-to");r&&(a.interval=!1),e.call(n,a),r&&n.data("bs.carousel").to(r),i.preventDefault()}};t(document).on("click.bs.carousel.data-api","[data-slide]",s).on("click.bs.carousel.data-api","[data-slide-to]",s),t(window).on("load",function(){t('[data-ride="carousel"]').each(function(){var i=t(this);e.call(i,i.data())})})}(jQuery),+function(t){"use strict";function e(e){e&&3===e.which||(t(s).remove(),t(n).each(function(){var o=t(this),s=i(o),n={relatedTarget:this};s.hasClass("open")&&(s.trigger(e=t.Event("hide.bs.dropdown",n)),e.isDefaultPrevented()||(o.attr("aria-expanded","false"),s.removeClass("open").trigger("hidden.bs.dropdown",n)))}))}function i(e){var i=e.attr("data-target");i||(i=e.attr("href"),i=i&&/#[A-Za-z]/.test(i)&&i.replace(/.*(?=#[^\s]*$)/,""));var o=i&&t(i);return o&&o.length?o:e.parent()}function o(e){return this.each(function(){var i=t(this),o=i.data("bs.dropdown");o||i.data("bs.dropdown",o=new a(this)),"string"==typeof e&&o[e].call(i)})}var s=".dropdown-backdrop",n='[data-toggle="dropdown"]',a=function(e){t(e).on("click.bs.dropdown",this.toggle)};a.VERSION="3.3.2",a.prototype.toggle=function(o){var s=t(this);if(!s.is(".disabled, :disabled")){var n=i(s),a=n.hasClass("open");if(e(),!a){"ontouchstart"in document.documentElement&&!n.closest(".navbar-nav").length&&t('<div class="dropdown-backdrop"/>').insertAfter(t(this)).on("click",e);var r={relatedTarget:this};if(n.trigger(o=t.Event("show.bs.dropdown",r)),o.isDefaultPrevented())return;s.trigger("focus").attr("aria-expanded","true"),n.toggleClass("open").trigger("shown.bs.dropdown",r)}return!1}},a.prototype.keydown=function(e){if(/(38|40|27|32)/.test(e.which)&&!/input|textarea/i.test(e.target.tagName)){var o=t(this);if(e.preventDefault(),e.stopPropagation(),!o.is(".disabled, :disabled")){var s=i(o),a=s.hasClass("open");if(!a&&27!=e.which||a&&27==e.which)return 27==e.which&&s.find(n).trigger("focus"),o.trigger("click");var r=" li:not(.divider):visible a",l=s.find('[role="menu"]'+r+', [role="listbox"]'+r);if(l.length){var h=l.index(e.target);38==e.which&&h>0&&h--,40==e.which&&h<l.length-1&&h++,~h||(h=0),l.eq(h).trigger("focus")}}}};var r=t.fn.dropdown;t.fn.dropdown=o,t.fn.dropdown.Constructor=a,t.fn.dropdown.noConflict=function(){return t.fn.dropdown=r,this},t(document).on("click.bs.dropdown.data-api",e).on("click.bs.dropdown.data-api",".dropdown form",function(t){t.stopPropagation()}).on("click.bs.dropdown.data-api",n,a.prototype.toggle).on("keydown.bs.dropdown.data-api",n,a.prototype.keydown).on("keydown.bs.dropdown.data-api",'[role="menu"]',a.prototype.keydown).on("keydown.bs.dropdown.data-api",'[role="listbox"]',a.prototype.keydown)}(jQuery),+function(t){"use strict";function e(e,o){return this.each(function(){var s=t(this),n=s.data("bs.modal"),a=t.extend({},i.DEFAULTS,s.data(),"object"==typeof e&&e);n||s.data("bs.modal",n=new i(this,a)),"string"==typeof e?n[e](o):a.show&&n.show(o)})}var i=function(e,i){this.options=i,this.$body=t(document.body),this.$element=t(e),this.$backdrop=this.isShown=null,this.scrollbarWidth=0,this.options.remote&&this.$element.find(".modal-content").load(this.options.remote,t.proxy(function(){this.$element.trigger("loaded.bs.modal")},this))};i.VERSION="3.3.2",i.TRANSITION_DURATION=300,i.BACKDROP_TRANSITION_DURATION=150,i.DEFAULTS={backdrop:!0,keyboard:!0,show:!0},i.prototype.toggle=function(t){return this.isShown?this.hide():this.show(t)},i.prototype.show=function(e){var o=this,s=t.Event("show.bs.modal",{relatedTarget:e});this.$element.trigger(s),this.isShown||s.isDefaultPrevented()||(this.isShown=!0,this.checkScrollbar(),this.setScrollbar(),this.$body.addClass("modal-open"),this.escape(),this.resize(),this.$element.on("click.dismiss.bs.modal",'[data-dismiss="modal"]',t.proxy(this.hide,this)),this.backdrop(function(){var s=t.support.transition&&o.$element.hasClass("fade");o.$element.parent().length||o.$element.appendTo(o.$body),o.$element.show().scrollTop(0),o.options.backdrop&&o.adjustBackdrop(),o.adjustDialog(),s&&o.$element[0].offsetWidth,o.$element.addClass("in").attr("aria-hidden",!1),o.enforceFocus();var n=t.Event("shown.bs.modal",{relatedTarget:e});s?o.$element.find(".modal-dialog").one("bsTransitionEnd",function(){o.$element.trigger("focus").trigger(n)}).emulateTransitionEnd(i.TRANSITION_DURATION):o.$element.trigger("focus").trigger(n)}))},i.prototype.hide=function(e){e&&e.preventDefault(),e=t.Event("hide.bs.modal"),this.$element.trigger(e),this.isShown&&!e.isDefaultPrevented()&&(this.isShown=!1,this.escape(),this.resize(),t(document).off("focusin.bs.modal"),this.$element.removeClass("in").attr("aria-hidden",!0).off("click.dismiss.bs.modal"),t.support.transition&&this.$element.hasClass("fade")?this.$element.one("bsTransitionEnd",t.proxy(this.hideModal,this)).emulateTransitionEnd(i.TRANSITION_DURATION):this.hideModal())},i.prototype.enforceFocus=function(){t(document).off("focusin.bs.modal").on("focusin.bs.modal",t.proxy(function(t){this.$element[0]===t.target||this.$element.has(t.target).length||this.$element.trigger("focus")},this))},i.prototype.escape=function(){this.isShown&&this.options.keyboard?this.$element.on("keydown.dismiss.bs.modal",t.proxy(function(t){27==t.which&&this.hide()},this)):this.isShown||this.$element.off("keydown.dismiss.bs.modal")},i.prototype.resize=function(){this.isShown?t(window).on("resize.bs.modal",t.proxy(this.handleUpdate,this)):t(window).off("resize.bs.modal")},i.prototype.hideModal=function(){var t=this;this.$element.hide(),this.backdrop(function(){t.$body.removeClass("modal-open"),t.resetAdjustments(),t.resetScrollbar(),t.$element.trigger("hidden.bs.modal")})},i.prototype.removeBackdrop=function(){this.$backdrop&&this.$backdrop.remove(),this.$backdrop=null},i.prototype.backdrop=function(e){var o=this,s=this.$element.hasClass("fade")?"fade":"";if(this.isShown&&this.options.backdrop){var n=t.support.transition&&s;if(this.$backdrop=t('<div class="modal-backdrop '+s+'" />').prependTo(this.$element).on("click.dismiss.bs.modal",t.proxy(function(t){t.target===t.currentTarget&&("static"==this.options.backdrop?this.$element[0].focus.call(this.$element[0]):this.hide.call(this))},this)),n&&this.$backdrop[0].offsetWidth,this.$backdrop.addClass("in"),!e)return;n?this.$backdrop.one("bsTransitionEnd",e).emulateTransitionEnd(i.BACKDROP_TRANSITION_DURATION):e()}else if(!this.isShown&&this.$backdrop){this.$backdrop.removeClass("in");var a=function(){o.removeBackdrop(),e&&e()};t.support.transition&&this.$element.hasClass("fade")?this.$backdrop.one("bsTransitionEnd",a).emulateTransitionEnd(i.BACKDROP_TRANSITION_DURATION):a()}else e&&e()},i.prototype.handleUpdate=function(){this.options.backdrop&&this.adjustBackdrop(),this.adjustDialog()},i.prototype.adjustBackdrop=function(){this.$backdrop.css("height",0).css("height",this.$element[0].scrollHeight)},i.prototype.adjustDialog=function(){var t=this.$element[0].scrollHeight>document.documentElement.clientHeight;this.$element.css({paddingLeft:!this.bodyIsOverflowing&&t?this.scrollbarWidth:"",paddingRight:this.bodyIsOverflowing&&!t?this.scrollbarWidth:""})},i.prototype.resetAdjustments=function(){this.$element.css({paddingLeft:"",paddingRight:""})},i.prototype.checkScrollbar=function(){this.bodyIsOverflowing=document.body.scrollHeight>document.documentElement.clientHeight,this.scrollbarWidth=this.measureScrollbar()},i.prototype.setScrollbar=function(){var t=parseInt(this.$body.css("padding-right")||0,10);this.bodyIsOverflowing&&this.$body.css("padding-right",t+this.scrollbarWidth)},i.prototype.resetScrollbar=function(){this.$body.css("padding-right","")},i.prototype.measureScrollbar=function(){var t=document.createElement("div");t.className="modal-scrollbar-measure",this.$body.append(t);var e=t.offsetWidth-t.clientWidth;return this.$body[0].removeChild(t),e};var o=t.fn.modal;t.fn.modal=e,t.fn.modal.Constructor=i,t.fn.modal.noConflict=function(){return t.fn.modal=o,this},t(document).on("click.bs.modal.data-api",'[data-toggle="modal"]',function(i){var o=t(this),s=o.attr("href"),n=t(o.attr("data-target")||s&&s.replace(/.*(?=#[^\s]+$)/,"")),a=n.data("bs.modal")?"toggle":t.extend({remote:!/#/.test(s)&&s},n.data(),o.data());o.is("a")&&i.preventDefault(),n.one("show.bs.modal",function(t){t.isDefaultPrevented()||n.one("hidden.bs.modal",function(){o.is(":visible")&&o.trigger("focus")})}),e.call(n,a,this)})}(jQuery),+function(t){"use strict";function e(e){return this.each(function(){var o=t(this),s=o.data("bs.tooltip"),n="object"==typeof e&&e;(s||"destroy"!=e)&&(s||o.data("bs.tooltip",s=new i(this,n)),"string"==typeof e&&s[e]())})}var i=function(t,e){this.type=this.options=this.enabled=this.timeout=this.hoverState=this.$element=null,this.init("tooltip",t,e)};i.VERSION="3.3.2",i.TRANSITION_DURATION=150,i.DEFAULTS={animation:!0,placement:"top",selector:!1,template:'<div class="tooltip" role="tooltip"><div class="tooltip-arrow"></div><div class="tooltip-inner"></div></div>',trigger:"hover focus",title:"",delay:0,html:!1,container:!1,viewport:{selector:"body",padding:0}},i.prototype.init=function(e,i,o){this.enabled=!0,this.type=e,this.$element=t(i),this.options=this.getOptions(o),this.$viewport=this.options.viewport&&t(this.options.viewport.selector||this.options.viewport);for(var s=this.options.trigger.split(" "),n=s.length;n--;){var a=s[n];if("click"==a)this.$element.on("click."+this.type,this.options.selector,t.proxy(this.toggle,this));else if("manual"!=a){var r="hover"==a?"mouseenter":"focusin",l="hover"==a?"mouseleave":"focusout";this.$element.on(r+"."+this.type,this.options.selector,t.proxy(this.enter,this)),this.$element.on(l+"."+this.type,this.options.selector,t.proxy(this.leave,this))}}this.options.selector?this._options=t.extend({},this.options,{trigger:"manual",selector:""}):this.fixTitle()},i.prototype.getDefaults=function(){return i.DEFAULTS},i.prototype.getOptions=function(e){return e=t.extend({},this.getDefaults(),this.$element.data(),e),e.delay&&"number"==typeof e.delay&&(e.delay={show:e.delay,hide:e.delay}),e},i.prototype.getDelegateOptions=function(){var e={},i=this.getDefaults();return this._options&&t.each(this._options,function(t,o){i[t]!=o&&(e[t]=o)}),e},i.prototype.enter=function(e){var i=e instanceof this.constructor?e:t(e.currentTarget).data("bs."+this.type);return i&&i.$tip&&i.$tip.is(":visible")?void(i.hoverState="in"):(i||(i=new this.constructor(e.currentTarget,this.getDelegateOptions()),t(e.currentTarget).data("bs."+this.type,i)),clearTimeout(i.timeout),i.hoverState="in",i.options.delay&&i.options.delay.show?void(i.timeout=setTimeout(function(){"in"==i.hoverState&&i.show()},i.options.delay.show)):i.show())},i.prototype.leave=function(e){var i=e instanceof this.constructor?e:t(e.currentTarget).data("bs."+this.type);return i||(i=new this.constructor(e.currentTarget,this.getDelegateOptions()),t(e.currentTarget).data("bs."+this.type,i)),clearTimeout(i.timeout),i.hoverState="out",i.options.delay&&i.options.delay.hide?void(i.timeout=setTimeout(function(){"out"==i.hoverState&&i.hide()},i.options.delay.hide)):i.hide()},i.prototype.show=function(){var e=t.Event("show.bs."+this.type);if(this.hasContent()&&this.enabled){this.$element.trigger(e);var o=t.contains(this.$element[0].ownerDocument.documentElement,this.$element[0]);if(e.isDefaultPrevented()||!o)return;var s=this,n=this.tip(),a=this.getUID(this.type);this.setContent(),n.attr("id",a),this.$element.attr("aria-describedby",a),this.options.animation&&n.addClass("fade");var r="function"==typeof this.options.placement?this.options.placement.call(this,n[0],this.$element[0]):this.options.placement,l=/\s?auto?\s?/i,h=l.test(r);h&&(r=r.replace(l,"")||"top"),n.detach().css({top:0,left:0,display:"block"}).addClass(r).data("bs."+this.type,this),this.options.container?n.appendTo(this.options.container):n.insertAfter(this.$element);var d=this.getPosition(),p=n[0].offsetWidth,c=n[0].offsetHeight;if(h){var f=r,u=this.options.container?t(this.options.container):this.$element.parent(),g=this.getPosition(u);r="bottom"==r&&d.bottom+c>g.bottom?"top":"top"==r&&d.top-c<g.top?"bottom":"right"==r&&d.right+p>g.width?"left":"left"==r&&d.left-p<g.left?"right":r,n.removeClass(f).addClass(r)}var v=this.getCalculatedOffset(r,d,p,c);this.applyPlacement(v,r);var m=function(){var t=s.hoverState;s.$element.trigger("shown.bs."+s.type),s.hoverState=null,"out"==t&&s.leave(s)};t.support.transition&&this.$tip.hasClass("fade")?n.one("bsTransitionEnd",m).emulateTransitionEnd(i.TRANSITION_DURATION):m()}},i.prototype.applyPlacement=function(e,i){var o=this.tip(),s=o[0].offsetWidth,n=o[0].offsetHeight,a=parseInt(o.css("margin-top"),10),r=parseInt(o.css("margin-left"),10);isNaN(a)&&(a=0),isNaN(r)&&(r=0),e.top=e.top+a,e.left=e.left+r,t.offset.setOffset(o[0],t.extend({using:function(t){o.css({top:Math.round(t.top),left:Math.round(t.left)})}},e),0),o.addClass("in");var l=o[0].offsetWidth,h=o[0].offsetHeight;"top"==i&&h!=n&&(e.top=e.top+n-h);var d=this.getViewportAdjustedDelta(i,e,l,h);d.left?e.left+=d.left:e.top+=d.top;var p=/top|bottom/.test(i),c=p?2*d.left-s+l:2*d.top-n+h,f=p?"offsetWidth":"offsetHeight";o.offset(e),this.replaceArrow(c,o[0][f],p)},i.prototype.replaceArrow=function(t,e,i){this.arrow().css(i?"left":"top",50*(1-t/e)+"%").css(i?"top":"left","")},i.prototype.setContent=function(){var t=this.tip(),e=this.getTitle();t.find(".tooltip-inner")[this.options.html?"html":"text"](e),t.removeClass("fade in top bottom left right")},i.prototype.hide=function(e){function o(){"in"!=s.hoverState&&n.detach(),s.$element.removeAttr("aria-describedby").trigger("hidden.bs."+s.type),e&&e()}var s=this,n=this.tip(),a=t.Event("hide.bs."+this.type);return this.$element.trigger(a),a.isDefaultPrevented()?void 0:(n.removeClass("in"),t.support.transition&&this.$tip.hasClass("fade")?n.one("bsTransitionEnd",o).emulateTransitionEnd(i.TRANSITION_DURATION):o(),this.hoverState=null,this)},i.prototype.fixTitle=function(){var t=this.$element;(t.attr("title")||"string"!=typeof t.attr("data-original-title"))&&t.attr("data-original-title",t.attr("title")||"").attr("title","")},i.prototype.hasContent=function(){return this.getTitle()},i.prototype.getPosition=function(e){e=e||this.$element;var i=e[0],o="BODY"==i.tagName,s=i.getBoundingClientRect();null==s.width&&(s=t.extend({},s,{width:s.right-s.left,height:s.bottom-s.top}));var n=o?{top:0,left:0}:e.offset(),a={scroll:o?document.documentElement.scrollTop||document.body.scrollTop:e.scrollTop()},r=o?{width:t(window).width(),height:t(window).height()}:null;return t.extend({},s,a,r,n)},i.prototype.getCalculatedOffset=function(t,e,i,o){return"bottom"==t?{top:e.top+e.height,left:e.left+e.width/2-i/2}:"top"==t?{top:e.top-o,left:e.left+e.width/2-i/2}:"left"==t?{top:e.top+e.height/2-o/2,left:e.left-i}:{top:e.top+e.height/2-o/2,left:e.left+e.width}},i.prototype.getViewportAdjustedDelta=function(t,e,i,o){var s={top:0,left:0};if(!this.$viewport)return s;var n=this.options.viewport&&this.options.viewport.padding||0,a=this.getPosition(this.$viewport);if(/right|left/.test(t)){var r=e.top-n-a.scroll,l=e.top+n-a.scroll+o;r<a.top?s.top=a.top-r:l>a.top+a.height&&(s.top=a.top+a.height-l)}else{var h=e.left-n,d=e.left+n+i;h<a.left?s.left=a.left-h:d>a.width&&(s.left=a.left+a.width-d)}return s},i.prototype.getTitle=function(){var t,e=this.$element,i=this.options;return t=e.attr("data-original-title")||("function"==typeof i.title?i.title.call(e[0]):i.title)},i.prototype.getUID=function(t){do t+=~~(1e6*Math.random());while(document.getElementById(t));return t},i.prototype.tip=function(){return this.$tip=this.$tip||t(this.options.template)},i.prototype.arrow=function(){return this.$arrow=this.$arrow||this.tip().find(".tooltip-arrow")},i.prototype.enable=function(){this.enabled=!0},i.prototype.disable=function(){this.enabled=!1},i.prototype.toggleEnabled=function(){this.enabled=!this.enabled},i.prototype.toggle=function(e){var i=this;e&&(i=t(e.currentTarget).data("bs."+this.type),i||(i=new this.constructor(e.currentTarget,this.getDelegateOptions()),t(e.currentTarget).data("bs."+this.type,i))),i.tip().hasClass("in")?i.leave(i):i.enter(i)},i.prototype.destroy=function(){var t=this;clearTimeout(this.timeout),this.hide(function(){t.$element.off("."+t.type).removeData("bs."+t.type)})};var o=t.fn.tooltip;t.fn.tooltip=e,t.fn.tooltip.Constructor=i,t.fn.tooltip.noConflict=function(){return t.fn.tooltip=o,this}}(jQuery),+function(t){"use strict";function e(e){return this.each(function(){var o=t(this),s=o.data("bs.popover"),n="object"==typeof e&&e;(s||"destroy"!=e)&&(s||o.data("bs.popover",s=new i(this,n)),"string"==typeof e&&s[e]())})}var i=function(t,e){this.init("popover",t,e)};if(!t.fn.tooltip)throw new Error("Popover requires tooltip.js");i.VERSION="3.3.2",i.DEFAULTS=t.extend({},t.fn.tooltip.Constructor.DEFAULTS,{placement:"right",trigger:"click",content:"",template:'<div class="popover" role="tooltip"><div class="arrow"></div><h3 class="popover-title"></h3><div class="popover-content"></div></div>'}),i.prototype=t.extend({},t.fn.tooltip.Constructor.prototype),i.prototype.constructor=i,i.prototype.getDefaults=function(){return i.DEFAULTS},i.prototype.setContent=function(){var t=this.tip(),e=this.getTitle(),i=this.getContent();t.find(".popover-title")[this.options.html?"html":"text"](e),t.find(".popover-content").children().detach().end()[this.options.html?"string"==typeof i?"html":"append":"text"](i),t.removeClass("fade top bottom left right in"),t.find(".popover-title").html()||t.find(".popover-title").hide()},i.prototype.hasContent=function(){return this.getTitle()||this.getContent()},i.prototype.getContent=function(){var t=this.$element,e=this.options;return t.attr("data-content")||("function"==typeof e.content?e.content.call(t[0]):e.content)},i.prototype.arrow=function(){return this.$arrow=this.$arrow||this.tip().find(".arrow")},i.prototype.tip=function(){return this.$tip||(this.$tip=t(this.options.template)),this.$tip};var o=t.fn.popover;t.fn.popover=e,t.fn.popover.Constructor=i,t.fn.popover.noConflict=function(){return t.fn.popover=o,this}}(jQuery),+function(t){"use strict";function e(e){return this.each(function(){var o=t(this),s=o.data("bs.tab");s||o.data("bs.tab",s=new i(this)),"string"==typeof e&&s[e]()})}var i=function(e){this.element=t(e)};i.VERSION="3.3.2",i.TRANSITION_DURATION=150,i.prototype.show=function(){var e=this.element,i=e.closest("ul:not(.dropdown-menu)"),o=e.data("target");if(o||(o=e.attr("href"),o=o&&o.replace(/.*(?=#[^\s]*$)/,"")),!e.parent("li").hasClass("active")){var s=i.find(".active:last a"),n=t.Event("hide.bs.tab",{relatedTarget:e[0]}),a=t.Event("show.bs.tab",{relatedTarget:s[0]});if(s.trigger(n),e.trigger(a),!a.isDefaultPrevented()&&!n.isDefaultPrevented()){var r=t(o);this.activate(e.closest("li"),i),this.activate(r,r.parent(),function(){s.trigger({type:"hidden.bs.tab",relatedTarget:e[0]}),e.trigger({type:"shown.bs.tab",relatedTarget:s[0]})})}}},i.prototype.activate=function(e,o,s){function n(){a.removeClass("active").find("> .dropdown-menu > .active").removeClass("active").end().find('[data-toggle="tab"]').attr("aria-expanded",!1),e.addClass("active").find('[data-toggle="tab"]').attr("aria-expanded",!0),r?(e[0].offsetWidth,e.addClass("in")):e.removeClass("fade"),e.parent(".dropdown-menu")&&e.closest("li.dropdown").addClass("active").end().find('[data-toggle="tab"]').attr("aria-expanded",!0),s&&s()}var a=o.find("> .active"),r=s&&t.support.transition&&(a.length&&a.hasClass("fade")||!!o.find("> .fade").length);a.length&&r?a.one("bsTransitionEnd",n).emulateTransitionEnd(i.TRANSITION_DURATION):n(),a.removeClass("in")};var o=t.fn.tab;t.fn.tab=e,t.fn.tab.Constructor=i,t.fn.tab.noConflict=function(){return t.fn.tab=o,this};var s=function(i){i.preventDefault(),e.call(t(this),"show")};t(document).on("click.bs.tab.data-api",'[data-toggle="tab"]',s).on("click.bs.tab.data-api",'[data-toggle="pill"]',s)}(jQuery),+function(t){"use strict";function e(e){return this.each(function(){var o=t(this),s=o.data("bs.affix"),n="object"==typeof e&&e;s||o.data("bs.affix",s=new i(this,n)),"string"==typeof e&&s[e]()})}var i=function(e,o){this.options=t.extend({},i.DEFAULTS,o),this.$target=t(this.options.target).on("scroll.bs.affix.data-api",t.proxy(this.checkPosition,this)).on("click.bs.affix.data-api",t.proxy(this.checkPositionWithEventLoop,this)),this.$element=t(e),this.affixed=this.unpin=this.pinnedOffset=null,this.checkPosition()};i.VERSION="3.3.2",i.RESET="affix affix-top affix-bottom",i.DEFAULTS={offset:0,target:window},i.prototype.getState=function(t,e,i,o){var s=this.$target.scrollTop(),n=this.$element.offset(),a=this.$target.height();if(null!=i&&"top"==this.affixed)return i>s?"top":!1;if("bottom"==this.affixed)return null!=i?s+this.unpin<=n.top?!1:"bottom":t-o>=s+a?!1:"bottom";var r=null==this.affixed,l=r?s:n.top,h=r?a:e;return null!=i&&i>=s?"top":null!=o&&l+h>=t-o?"bottom":!1},i.prototype.getPinnedOffset=function(){if(this.pinnedOffset)return this.pinnedOffset;this.$element.removeClass(i.RESET).addClass("affix");var t=this.$target.scrollTop(),e=this.$element.offset();return this.pinnedOffset=e.top-t},i.prototype.checkPositionWithEventLoop=function(){setTimeout(t.proxy(this.checkPosition,this),1)},i.prototype.checkPosition=function(){if(this.$element.is(":visible")){var e=this.$element.height(),o=this.options.offset,s=o.top,n=o.bottom,a=t("body").height();"object"!=typeof o&&(n=s=o),"function"==typeof s&&(s=o.top(this.$element)),"function"==typeof n&&(n=o.bottom(this.$element));var r=this.getState(a,e,s,n);if(this.affixed!=r){null!=this.unpin&&this.$element.css("top","");var l="affix"+(r?"-"+r:""),h=t.Event(l+".bs.affix");if(this.$element.trigger(h),h.isDefaultPrevented())return;this.affixed=r,this.unpin="bottom"==r?this.getPinnedOffset():null,this.$element.removeClass(i.RESET).addClass(l).trigger(l.replace("affix","affixed")+".bs.affix")}"bottom"==r&&this.$element.offset({top:a-e-n})}};var o=t.fn.affix;t.fn.affix=e,t.fn.affix.Constructor=i,t.fn.affix.noConflict=function(){return t.fn.affix=o,this},t(window).on("load",function(){t('[data-spy="affix"]').each(function(){var i=t(this),o=i.data();o.offset=o.offset||{},null!=o.offsetBottom&&(o.offset.bottom=o.offsetBottom),null!=o.offsetTop&&(o.offset.top=o.offsetTop),e.call(i,o)})})}(jQuery),+function(t){"use strict";function e(e){var i,o=e.attr("data-target")||(i=e.attr("href"))&&i.replace(/.*(?=#[^\s]+$)/,"");return t(o)}function i(e){return this.each(function(){var i=t(this),s=i.data("bs.collapse"),n=t.extend({},o.DEFAULTS,i.data(),"object"==typeof e&&e);!s&&n.toggle&&"show"==e&&(n.toggle=!1),s||i.data("bs.collapse",s=new o(this,n)),"string"==typeof e&&s[e]()})}var o=function(e,i){this.$element=t(e),this.options=t.extend({},o.DEFAULTS,i),this.$trigger=t(this.options.trigger).filter('[href="#'+e.id+'"], [data-target="#'+e.id+'"]'),this.transitioning=null,this.options.parent?this.$parent=this.getParent():this.addAriaAndCollapsedClass(this.$element,this.$trigger),this.options.toggle&&this.toggle()};o.VERSION="3.3.2",o.TRANSITION_DURATION=350,o.DEFAULTS={toggle:!0,trigger:'[data-toggle="collapse"]'},o.prototype.dimension=function(){var t=this.$element.hasClass("width");return t?"width":"height"},o.prototype.show=function(){if(!this.transitioning&&!this.$element.hasClass("in")){var e,s=this.$parent&&this.$parent.children(".panel").children(".in, .collapsing");if(!(s&&s.length&&(e=s.data("bs.collapse"),e&&e.transitioning))){var n=t.Event("show.bs.collapse");if(this.$element.trigger(n),!n.isDefaultPrevented()){s&&s.length&&(i.call(s,"hide"),e||s.data("bs.collapse",null));var a=this.dimension();this.$element.removeClass("collapse").addClass("collapsing")[a](0).attr("aria-expanded",!0),this.$trigger.removeClass("collapsed").attr("aria-expanded",!0),this.transitioning=1;var r=function(){this.$element.removeClass("collapsing").addClass("collapse in")[a](""),this.transitioning=0,this.$element.trigger("shown.bs.collapse")};if(!t.support.transition)return r.call(this);var l=t.camelCase(["scroll",a].join("-"));this.$element.one("bsTransitionEnd",t.proxy(r,this)).emulateTransitionEnd(o.TRANSITION_DURATION)[a](this.$element[0][l])}}}},o.prototype.hide=function(){if(!this.transitioning&&this.$element.hasClass("in")){var e=t.Event("hide.bs.collapse");if(this.$element.trigger(e),!e.isDefaultPrevented()){var i=this.dimension();this.$element[i](this.$element[i]())[0].offsetHeight,this.$element.addClass("collapsing").removeClass("collapse in").attr("aria-expanded",!1),this.$trigger.addClass("collapsed").attr("aria-expanded",!1),this.transitioning=1;var s=function(){this.transitioning=0,this.$element.removeClass("collapsing").addClass("collapse").trigger("hidden.bs.collapse")};return t.support.transition?void this.$element[i](0).one("bsTransitionEnd",t.proxy(s,this)).emulateTransitionEnd(o.TRANSITION_DURATION):s.call(this)}}},o.prototype.toggle=function(){this[this.$element.hasClass("in")?"hide":"show"]()},o.prototype.getParent=function(){return t(this.options.parent).find('[data-toggle="collapse"][data-parent="'+this.options.parent+'"]').each(t.proxy(function(i,o){var s=t(o);this.addAriaAndCollapsedClass(e(s),s)},this)).end()},o.prototype.addAriaAndCollapsedClass=function(t,e){var i=t.hasClass("in");t.attr("aria-expanded",i),e.toggleClass("collapsed",!i).attr("aria-expanded",i)};var s=t.fn.collapse;t.fn.collapse=i,t.fn.collapse.Constructor=o,t.fn.collapse.noConflict=function(){return t.fn.collapse=s,this},t(document).on("click.bs.collapse.data-api",'[data-toggle="collapse"]',function(o){var s=t(this);s.attr("data-target")||o.preventDefault();
+var n=e(s),a=n.data("bs.collapse"),r=a?"toggle":t.extend({},s.data(),{trigger:this});i.call(n,r)})}(jQuery),+function(t){"use strict";function e(i,o){var s=t.proxy(this.process,this);this.$body=t("body"),this.$scrollElement=t(t(i).is("body")?window:i),this.options=t.extend({},e.DEFAULTS,o),this.selector=(this.options.target||"")+" .nav li > a",this.offsets=[],this.targets=[],this.activeTarget=null,this.scrollHeight=0,this.$scrollElement.on("scroll.bs.scrollspy",s),this.refresh(),this.process()}function i(i){return this.each(function(){var o=t(this),s=o.data("bs.scrollspy"),n="object"==typeof i&&i;s||o.data("bs.scrollspy",s=new e(this,n)),"string"==typeof i&&s[i]()})}e.VERSION="3.3.2",e.DEFAULTS={offset:10},e.prototype.getScrollHeight=function(){return this.$scrollElement[0].scrollHeight||Math.max(this.$body[0].scrollHeight,document.documentElement.scrollHeight)},e.prototype.refresh=function(){var e="offset",i=0;t.isWindow(this.$scrollElement[0])||(e="position",i=this.$scrollElement.scrollTop()),this.offsets=[],this.targets=[],this.scrollHeight=this.getScrollHeight();var o=this;this.$body.find(this.selector).map(function(){var o=t(this),s=o.data("target")||o.attr("href"),n=/^#./.test(s)&&t(s);return n&&n.length&&n.is(":visible")&&[[n[e]().top+i,s]]||null}).sort(function(t,e){return t[0]-e[0]}).each(function(){o.offsets.push(this[0]),o.targets.push(this[1])})},e.prototype.process=function(){var t,e=this.$scrollElement.scrollTop()+this.options.offset,i=this.getScrollHeight(),o=this.options.offset+i-this.$scrollElement.height(),s=this.offsets,n=this.targets,a=this.activeTarget;if(this.scrollHeight!=i&&this.refresh(),e>=o)return a!=(t=n[n.length-1])&&this.activate(t);if(a&&e<s[0])return this.activeTarget=null,this.clear();for(t=s.length;t--;)a!=n[t]&&e>=s[t]&&(!s[t+1]||e<=s[t+1])&&this.activate(n[t])},e.prototype.activate=function(e){this.activeTarget=e,this.clear();var i=this.selector+'[data-target="'+e+'"],'+this.selector+'[href="'+e+'"]',o=t(i).parents("li").addClass("active");o.parent(".dropdown-menu").length&&(o=o.closest("li.dropdown").addClass("active")),o.trigger("activate.bs.scrollspy")},e.prototype.clear=function(){t(this.selector).parentsUntil(this.options.target,".active").removeClass("active")};var o=t.fn.scrollspy;t.fn.scrollspy=i,t.fn.scrollspy.Constructor=e,t.fn.scrollspy.noConflict=function(){return t.fn.scrollspy=o,this},t(window).on("load.bs.scrollspy.data-api",function(){t('[data-spy="scroll"]').each(function(){var e=t(this);i.call(e,e.data())})})}(jQuery),+function(t){"use strict";function e(){var t=document.createElement("bootstrap"),e={WebkitTransition:"webkitTransitionEnd",MozTransition:"transitionend",OTransition:"oTransitionEnd otransitionend",transition:"transitionend"};for(var i in e)if(void 0!==t.style[i])return{end:e[i]};return!1}t.fn.emulateTransitionEnd=function(e){var i=!1,o=this;t(this).one("bsTransitionEnd",function(){i=!0});var s=function(){i||t(o).trigger(t.support.transition.end)};return setTimeout(s,e),this},t(function(){t.support.transition=e(),t.support.transition&&(t.event.special.bsTransitionEnd={bindType:t.support.transition.end,delegateType:t.support.transition.end,handle:function(e){return t(e.target).is(this)?e.handleObj.handler.apply(this,arguments):void 0}})})}(jQuery);

data/doc/pages/source/css/app.scss

@@ -0,0 +1,10 @@
+---
+# Front matter comment to ensure Jekyll properly reads file.
+---
+
+@import "../_sass/bootstrap/variables";
+@import "../_sass/bootstrap-variables";
+@import "../_sass/bootstrap";
+@import "../_sass/style";
+@import "../_sass/specific";
+

data/doc/pages/source/css/syntax.css

@@ -0,0 +1,60 @@
+.highlight  { background: #ffffff; }
+.highlight .c { color: #999988; font-style: italic } /* Comment */
+.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
+.highlight .k { font-weight: bold } /* Keyword */
+.highlight .o { font-weight: bold } /* Operator */
+.highlight .cm { color: #999988; font-style: italic } /* Comment.Multiline */
+.highlight .cp { color: #999999; font-weight: bold } /* Comment.Preproc */
+.highlight .c1 { color: #999988; font-style: italic } /* Comment.Single */
+.highlight .cs { color: #999999; font-weight: bold; font-style: italic } /* Comment.Special */
+.highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
+.highlight .gd .x { color: #000000; background-color: #ffaaaa } /* Generic.Deleted.Specific */
+.highlight .ge { font-style: italic } /* Generic.Emph */
+.highlight .gr { color: #aa0000 } /* Generic.Error */
+.highlight .gh { color: #999999 } /* Generic.Heading */
+.highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
+.highlight .gi .x { color: #000000; background-color: #aaffaa } /* Generic.Inserted.Specific */
+.highlight .go { color: #888888 } /* Generic.Output */
+.highlight .gp { color: #555555 } /* Generic.Prompt */
+.highlight .gs { font-weight: bold } /* Generic.Strong */
+.highlight .gu { color: #aaaaaa } /* Generic.Subheading */
+.highlight .gt { color: #aa0000 } /* Generic.Traceback */
+.highlight .kc { font-weight: bold } /* Keyword.Constant */
+.highlight .kd { font-weight: bold } /* Keyword.Declaration */
+.highlight .kp { font-weight: bold } /* Keyword.Pseudo */
+.highlight .kr { font-weight: bold } /* Keyword.Reserved */
+.highlight .kt { color: #445588; font-weight: bold } /* Keyword.Type */
+.highlight .m { color: #009999 } /* Literal.Number */
+.highlight .s { color: #d14 } /* Literal.String */
+.highlight .na { color: #008080 } /* Name.Attribute */
+.highlight .nb { color: #0086B3 } /* Name.Builtin */
+.highlight .nc { color: #445588; font-weight: bold } /* Name.Class */
+.highlight .no { color: #008080 } /* Name.Constant */
+.highlight .ni { color: #800080 } /* Name.Entity */
+.highlight .ne { color: #990000; font-weight: bold } /* Name.Exception */
+.highlight .nf { color: #990000; font-weight: bold } /* Name.Function */
+.highlight .nn { color: #555555 } /* Name.Namespace */
+.highlight .nt { color: #000080 } /* Name.Tag */
+.highlight .nv { color: #008080 } /* Name.Variable */
+.highlight .ow { font-weight: bold } /* Operator.Word */
+.highlight .w { color: #bbbbbb } /* Text.Whitespace */
+.highlight .mf { color: #009999 } /* Literal.Number.Float */
+.highlight .mh { color: #009999 } /* Literal.Number.Hex */
+.highlight .mi { color: #009999 } /* Literal.Number.Integer */
+.highlight .mo { color: #009999 } /* Literal.Number.Oct */
+.highlight .sb { color: #d14 } /* Literal.String.Backtick */
+.highlight .sc { color: #d14 } /* Literal.String.Char */
+.highlight .sd { color: #d14 } /* Literal.String.Doc */
+.highlight .s2 { color: #d14 } /* Literal.String.Double */
+.highlight .se { color: #d14 } /* Literal.String.Escape */
+.highlight .sh { color: #d14 } /* Literal.String.Heredoc */
+.highlight .si { color: #d14 } /* Literal.String.Interpol */
+.highlight .sx { color: #d14 } /* Literal.String.Other */
+.highlight .sr { color: #009926 } /* Literal.String.Regex */
+.highlight .s1 { color: #d14 } /* Literal.String.Single */
+.highlight .ss { color: #990073 } /* Literal.String.Symbol */
+.highlight .bp { color: #999999 } /* Name.Builtin.Pseudo */
+.highlight .vc { color: #008080 } /* Name.Variable.Class */
+.highlight .vg { color: #008080 } /* Name.Variable.Global */
+.highlight .vi { color: #008080 } /* Name.Variable.Instance */
+.highlight .il { color: #009999 } /* Literal.Number.Integer.Long */

data/doc/pages/source/documentation/index.md

@@ -0,0 +1,977 @@
+---
+layout: page
+title: Documentation
+countheads: true
+toc: true
+comments: true
+---
+
+{% danger_block %}
+
+Work in progress! It contains a lot of tpyos, please let us know. There are comments at the bottom
+or you can submit a PR against [pages branch](https://github.com/dynflow/dynflow/tree/pages).
+
+Please help with the documentation if you know Dynflow.
+
+Thanks!
+
+{% enddanger_block %}
+
+## High level overview TODO
+
+*TODO to be refined*
+
+Dynflow (**DYN**amic work**FLOW**) is a workflow engine
+written in Ruby that allows to:
+
+-   Keep track of the progress of running processes
+-   Run the code asynchronously
+-   Resume the process when something goes wrong, skip some steps when needed
+-   Detect independent parts and run them concurrently
+-   Compose simple actions into more complex scenarios
+-   Extend the workflows from third-party libraries
+-   Keep consistency between local transactional database and
+    external services
+-   Suspend the long-running steps, not blocking the thread pool
+-   Cancel steps when possible
+-   Extend the actions behavior with middlewares
+-   Pick different adapters to provide: storage backend, transactions, or executor implementation
+
+Dynflow has been developed to be able to support orchestration of services in the
+[Katello](http://katello.org) and [Foreman](http://theforeman.org/) projects.
+
+*TODO*
+
+-   what problems does Dynflow solve?
+-   maybe a little history
+
+## Glossary
+
+-   **Action** - building block of execution plans, a Ruby class inherited
+    from `Dynflow::Action`, defines code to be run in each phase.
+-   **Phase** - Each action has three phases: `plan`, `run`, `finalize`.
+-   **Input** - A `Hash` of data coming to the action.
+-   **Output** - A `Hash` of data that the action produces. It's
+    persisted and can be used as input of other actions.
+-   **Execution plan** - definition of the workflow: product of the plan phase,
+-   **Triggering an action** - entering the plan phase, starting with the plan
+    method of the action. The execution follows immediately.
+-   **Flow** - definition of the `run`/`finalize` phase, holding the information
+    about steps that can run concurrently/in sequence. Part of execution plan.
+-   **Executor** - service that executes the run and finalize flows based on
+    the execution plan. It can run in the same process as the plan phase or in
+    different process (using the remote executor).
+-   **World** - the universe where the Dynflow runs the code: it holds all
+    needed configuration. Usually there's only one world per Dynflow process,
+    besides configuration it also holds `Persistence`, `Logger`, `Executor` and
+    all the other objects necessary for action executing. This concept
+    allows us to avoid globally shared state. Also, the worlds can
+    talk to each other, which is helpful for production and
+    high-availability setups,
+    having multiple worlds on different hosts handle the execution of the execution plans.
+
+##  Examples
+
+See the
+[examples directory](https://github.com/Dynflow/dynflow/tree/master/examples)
+for the code in action. Running those files (except the
+`example_helper.rb` file) leads to the Dynflow runtime being initialized
+(including the web console where one can explore the features and
+experiment).
+
+*TODO*
+
+-   for async operations
+-   for orchestrating system/ssh calls
+-   for keeping consistency between local database and external systems
+-   sub-tasks
+
+## How to use
+
+### World creation TODO
+
+-   *include executor description*
+
+### Development vs production TODO
+
+-   *In development execution runs in the same process, in production there is an
+    executor process.*
+
+### Action anatomy
+
+{% digraph %}
+rankdir=LR
+Trigger -> Plan -> Run -> Finalize
+{% enddigraph %}
+
+When action is triggered, Dynflow executes plan method on this action, which
+is responsible for building the execution plan. It builds the execution plan by calling
+`plan_action` and `plan_self` methods, effectively listing actions that should be run as
+a part of this execution plan. In other words, it compiles a list of actions on which
+method `run` will be called. Also it's responsible for giving these actions
+an order. A simple example of such plan action might look like this
+
+```ruby
+# this would plan deletion of files passed as an input array
+def plan(files)
+  files.each do |filename|
+    plan_action MyActions::File::Destroy, filename
+  end
+end
+```
+
+Note that it does not have to be only other actions that are planned to run.
+In fact it's very common that the action plan itself, which means it will
+put it's own `run` method call in the execution plan. In order to do that
+you can use `plan_self`. This could be used in MyActions::File::Destroy
+used in previous example
+
+```ruby
+class MyActions::File::Destroy < Dynflow::Action
+  def plan(filename)
+    plan_self path: filename
+  end
+
+  def run
+    File.rm(input.fetch(:path))
+  end
+end
+```
+
+In example above, it seems that `plan_self` is just shortcut to
+`plan_action MyActions::File::Destroy, filename` but it's not entirely true.
+Note that `plan_action` always trigger `plan` of a given action while `plan_self`
+plans only the `run` of Action, so by using `plan_action` we'd end up in
+endless loop.
+
+Also note, that run method does not take any input. In fact, it can use
+`input` method that refers to arguments, that were used in `plan_self`.
+
+Similar to the input mentioned above, the run produces output.
+After that some finalizing steps can be taken. Actions can use outputs of other actions
+as parts of their inputs establishing dependency. Action's state is serialized between each phase
+and survives machine/executor restarts.
+
+As lightly touched in the previous paragraph there are 3 phases: `plan`, `run`, `finalize`.
+Plan phase starts by triggering an action.
+
+#### Input and Output
+
+Both input and output are `Hash`es accessible by `Action#input` and `Action#output` methods. They
+need to be serializable to JSON so it should contain only combination of primitive Ruby types
+like: `Hash`, `Array`, `String`, `Integer`, etc.
+
+
+{% warning_block %}
+
+One should avoid using directly
+
+```ruby
+self.output = { key: data }
+```
+
+It might delete other data stored in the output (potentially by middleware and other
+parts of the action). Therefore it's preferred to use
+
+```ruby
+output.update(key: data, another_key: another_data)
+# or for one key
+output[:key] = data
+```
+
+{% endwarning_block %}
+
+{% info_block %}
+
+You may sometime find these input/output format definitions:
+
+```ruby
+class AnAction < Dynflow::Action
+  input_format do
+    param :id, Integer
+    param :name, String
+  end
+
+  output_format do
+    param :uuid, String
+  end
+end
+```
+
+This might me quite handy especially in combination with
+[subscriptions](#subscriptions) functionality.
+
+The format follows [apipie-params](https://github.com/iNecas/apipie-params) for more details.
+Validations of input/output could be performed against this description but it's not turned on
+by default. (It needs to be revisited and updated to be fully functional.)
+
+{% endinfo_block %}
+
+#### Triggering
+
+Triggering the action means starting the plan phase, followed by immediate execution.
+Any action is triggered by calling:
+
+``` ruby
+world_instance.trigger(AnAction, *args)
+```
+
+{% info_block %}
+
+In Foreman and Katello actions are usually triggered by `ForemanTask.sync_task` and
+`ForemanTasks.async_task` so following part is not that important if you are using
+`ForemanTasks`.
+
+{% endinfo_block %}
+
+`World#trigger` method returns object of `TriggerResult` type. Which is
+[Algebrick](http://blog.pitr.ch/projects/algebrick/) variant type where definition follows:
+
+```ruby
+TriggerResult = Algebrick.type do
+  # Returned by #trigger when planning fails.
+  PlaningFailed   = type { fields! execution_plan_id: String, error: Exception }
+  # Returned by #trigger when planning is successful but execution fails to start.
+  ExecutionFailed = type { fields! execution_plan_id: String, error: Exception }
+  # Returned by #trigger when planning is successful, #future will resolve after
+  # ExecutionPlan is executed.
+  Triggered       = type { fields! execution_plan_id: String, future: Future }
+
+  variants PlaningFailed, ExecutionFailed, Triggered
+end
+```
+
+If you do not know `Algebrick` you can think about these as `Struct`s with types.
+You can see how it's used to distinguish all the possible results
+[in ForemanTasks module](https://github.com/theforeman/foreman-tasks/blob/master/lib/foreman_tasks.rb#L20-L32).
+
+```ruby
+def self.trigger_task(async, action, *args, &block)
+  Match! async, true, false
+
+  match trigger(action, *args, &block),
+        # Raise if there is any error caused either by failed planning or
+        # by faild start of execution.
+        (on ::Dynflow::World::PlaningFailed.(error: ~any) |
+                ::Dynflow::World::ExecutionFailed.(error: ~any) do |error|
+          raise error
+        end),
+        # Succesfully triggered.
+        (on ::Dynflow::World::Triggered.(
+              execution_plan_id: ~any, future: ~any) do |id, finished|
+          # block on the finished Future if this is called synchronously
+          finished.wait if async == false
+          return ForemanTasks::Task::DynflowTask.find_by_external_id!(id)
+        end)
+end
+```
+
+#### Plan phase
+
+Planning always uses the thread triggering the action. Plan phase
+configures action's input for run phase. It starts by executing
+`plan` method of the action instance passing in arguments from
+`World#trigger method`
+
+```ruby
+world_instance.trigger(AnAction, *args)
+# executes following
+an_action.plan(*args) # an_action is AnAction
+```
+
+`plan` method is inherited from Dynflow::Action and by default it plans itself if
+`run` method is present using first argument as input.
+
+```ruby
+class AnAction < Dynflow::Action
+  def run
+    output.update self.input
+  end
+end
+
+world_instance.trigger AnAction, data: 'nothing'
+```
+
+The above will just plan itself copying input to output in run phase.
+
+In most cases the `plan` method is overridden to plan self with transformed arguments and/or
+to plan other actions. In the Rails application, the arguments of the
+plan phase are often the ActiveRecord objects, that are then
+used to produce the inputs for the actions.
+
+Let's look at the argument transformation first:
+
+```ruby
+class AnAction < Dynflow::Action
+  def plan(any_array)
+    # pick just numbers
+    plan_self numbers: any_array.select { |v| v.is_a? Number }
+  end
+
+  def run
+    # compute sum - simulating a time consuming operation
+    output.update sum: input[:numbers].reduce(&:+)
+  end
+end
+```
+
+{% info_block %}
+
+It's considered a good practice to use the just enough data for the
+input for the action to perform the job. That means not too much
+(such as using ActiveRecord's attributes), as it might have
+performance impact as well as causes issues when changing the
+attributes later.
+
+ On the other hand, the input should contain enough data to perform
+the job without the need for reaching to external sources. Therefore,
+instead of passing just the ActiveRecord id and loading the whole
+record again in run phase, just to use some attributes, it's better to
+use these attributes directly as input of the action.
+
+Following theses rules should lead to the best results, both from
+readability and performance point of view.
+
+{% endinfo_block %}
+
+Now let's see an example with action planning:
+
+```ruby
+class SumNumbers < Dynflow::Action
+  def plan(numbers)
+    plan_self numbers: numbers
+  end
+
+  def run
+    output.update sum: input[:numbers].reduce(&:+)
+  end
+end
+
+class SumManyNumbers < Dynflow::Action
+  def plan(numbers)
+    # references to planned actions
+    planned_sub_sum_actions = numbers.each_slice(10).map do |numbers|
+      plan_action SumNumbers, numbers
+    end
+
+    # prepare array of output references where each points to sum in the
+    # output of particular action
+    sub_sums = planned_sub_sum_actions.map do |action|
+      action.output[:sum]
+    end
+
+    # plan one last action which will sum the sub_sums
+    # it depends on all planned_sub_sum_actions because it uses theirs outputs
+    plan_action SumNumbers, sub_sums
+  end
+end
+
+world_instance.trigger SumManyNumbers, (1..100).to_a
+```
+
+Above example will in parallel sum numbers by slices of 10 values: first action sums `1..10`,
+second action sums `11..20`, ..., tenth action sums `91..100`. After all sub sums are computed
+one final action sums the sub sums into final sum.
+
+{% warning_block %}
+
+This example is here to demonstrate the planning abilities. In reality this parallelization of
+compute intensive tasks does not have a positive effect on Dynflow running on MRI. The pool of
+workers may starve. It is not a big issue since Dynflow is mainly used to orchestrate external
+services.
+
+*TODO add link to detail explanation in How it works when available.*
+
+{% endwarning_block %}
+
+Action may access local DB in plan phase,
+see [Database and Transactions](#database-and-transactions).
+
+#### Run phase
+
+Actions has a run phase if there is `run` method implemented.
+(There may be actions just planning other actions.)
+
+The run method implements the main piece of work done by this action converting
+input into output. Input is immutable in this phase. It's the right place for all the steps
+which are likely to fail. Action `run` phase are allowed to have side effects like: file operations,
+calls to other systems, etc.
+Local DB should not be accessed in this phase,
+see [Database and Transactions](#database-and-transactions)
+
+#### Finale phase
+
+Main purpose of `finalize` phase is to be able access local DB after action finishes
+successfully, like: indexing based on new data, updating records as fully created, etc.
+Finalize phase does not modify input or output of the action.
+Action may access local DB in `finalize` phase and must be **idempotent**,
+see [Database and Transactions](#database-and-transactions).
+
+### Dependencies
+
+As already mentioned, actions can use output of different actions as their input (or just parts).
+When they do it creates dependency between actions, which is automatically detected
+by Dynflow and the execution plan is built accordingly.
+
+```ruby
+def plan
+  first_action  = plan_action AnAction
+  second_action = plan_action AnAction, first_action.output[:a_key_in_output]
+end
+```
+
+`second_action` uses part of the `first_action`'s output
+therefore it depends on the `first_action`.
+
+If actions are planned without this dependency as follows
+
+```ruby
+def plan
+  first_action  = plan_action AnAction
+  second_action = plan_action AnAction
+end
+```
+
+then they are independent and they are executed concurrently.
+
+There is also other mechanism how to describe dependencies between actions than just
+the one based on output usage. Dynflow user can specify the order between planned
+actions with DSL methods `sequence` and `concurrence`. Both methods are taking blocks
+and they specify how actions planned inside the block
+(or inner `sequence` and `concurrence` blocks) should be executed.
+
+By default `plan` considers it's space as inside `concurrence`. Which means
+
+```ruby
+def plan
+  first_action  = plan_action AnAction
+  second_action = plan_action AnAction
+end
+```
+equals
+
+```ruby
+def plan
+  concurrence do
+    first_action  = plan_action AnAction
+    second_action = plan_action AnAction
+  end
+end
+```
+
+You can establish same dependency between `first_action` and `second_action` without
+using output by using `sequence`
+
+```ruby
+def plan
+  sequence do
+    first_action  = plan_action AnAction
+    second_action = plan_action AnAction
+  end
+end
+```
+
+As mentioned the `sequence` and `concurrence` methods can be nested and mixed
+with output usage to create more complex dependencies. Let see commented example:
+
+```ruby
+def plan
+  # Plans 3 actions of type AnAction to be executed in sequence
+  # argument is the index in the sequence.
+  actions_executed_sequentially = sequence do
+    3.times.map { |i| plan_action AnAction, i }
+  end
+
+  # Depends on output of the last action in `actions_executed_sequentially`
+  # so it's added to the above sequence to be executed as 4th.
+  action1 = plan_action AnAction, actions_executed_sequentially.last.output
+
+  # It's planed in default plan's concurrency scope it's executed concurrently
+  # to about four actions.
+  action2 = plan_action AnAction
+end
+```
+
+The order than will be:
+
+-   concurrently:
+    -   sequentially:
+        1.  `*actions_executed_sequentially`
+        1.  `action1`
+    -   `action2`
+
+Let's see one more example:
+
+```ruby
+def plan
+  actions = sequence do
+    2.times.map do |i|
+      concurrency do
+        2.times.map { plan_action AnAction, i }
+      end
+    end
+  end
+end
+```
+Which results in order of execution:
+
+-   sequentially:
+    1.  concurrently:
+        -   `actions[0][0]` argument: 0
+        -   `actions[0][1]` argument: 0
+    1.  concurrently:
+        -   `actions[1][0]` argument: 1
+        -   `actions[1][1]` argument: 1
+
+{% info_block %}
+
+It's on our todo-list to change that to be able to define acyclic-graph of dependencies
+between the actions. `sequence` and `concurrence` methods will then be deprecated and kept
+just for backward compatibility.
+
+{% endinfo_block %}
+
+{% warning_block %}
+
+Internally dependencies are also modeled with objects representing Sequences and Concurrences,
+which makes it weaker than acyclic-graph so in some cases during the dependency resolution
+it might not lead into the most effective execution plan. Some actions will run in sequence even
+though they could be run concurrently. This limitation is likely to be
+removed in some of the further releases.
+
+{% endwarning_block %}
+
+### Database and Transactions
+
+Dynflow was designed to help with orchestration of other services.
+The usual execution looks as follows, we use an ActiveRecord User as example of a resource.
+
+1.  Trigger user creation, argument is an unsaved ActiveRecord user object
+1.  Planning: The user is stored in local DB (in the Dynflow hosting application) within the
+    `plan` phase. The record is marked as incomplete.
+1.  Running: Operations needed for the user in external services with (e.g.) REST call.
+    The phase finishes when the all the external calls succeeded successfully.
+1.  Finalizing: The record in local DB is marked as done: ready to be
+    used. Potentially, saving some data that were retrieved in the `run`
+    phase back to the local database.
+
+For that reason there are transactions around whole `plan` and `finale` phase
+(all action's plan methods are in one transaction).
+If anything goes wrong in the `plan` phase any change made during planning to local DB is
+reverted. Same holds for finalizing, if anything goes wrong, all changes are reverted. Therefore
+all finalization methods has to be **idempotent**.
+
+Internally Dynflow uses Sequel as its ORM, but users may choose what they need
+to access they data. There is an interface `TransactionAdapters::Abstract` where its
+implementations may provide transactions using different ORMs.
+The most common one probably being `TransactionAdapters::ActiveRecord`.
+
+So in the above example 2. and 4. step would be wrapped in `ActiveRecord` transaction
+if `TransactionAdapters::ActiveRecord` is used.
+
+Second outcome of the design is convention when actions should be accessing local Database:
+
+-   **allowed** - in `plan` and `finalize` phases
+-   **disallowed** - (or at least discouraged) in the `run` phase
+
+{% warning_block %}
+
+*TODO warning about AR pool configuration, needs to have sufficient size*
+
+{% endwarning_block %}
+
+### Composition
+
+Dynflow is designed to allow easy composition of small building blocks
+called `Action`s. Typically there are actions composing smaller pieces
+together and other actions doing actual steps of work as in following
+example:
+
+```ruby
+class CreateInfrastructure < Dynflow::Action
+  def plan
+    sequence do
+      concurrence do
+        plan_action(CreateMachine, 'host1', 'db')
+        plan_action(CreateMachine, 'host2', 'storage')
+      end
+      plan_action(CreateMachine,
+                  'host3',
+                  'web_server',
+                  :db_machine      => 'host1',
+                  :storage_machine => 'host2')
+    end
+  end
+end
+```
+Action `CreateInfrastructure` does not have a `run` method defined, it only
+defines `plan` action where other actions composed together.
+
+### Subscriptions
+
+Even though composing actions is quite easy and allows to decompose
+business logic to small pieces it does not directly support extensions
+by plugins. For that there are subscriptions.
+
+`Actions` can subscribe from a plugin, gem, any other library to already
+loaded `Actions`, doing so they extend the planning process with self.
+
+Lets look at an example starting by definition of a core action
+
+```ruby
+# This action can be extended without doing any
+# other steps to support it.
+class ACoreAppAction < Dynflow::Action
+  def plan(arguments)
+    plan_self(args: arguments)
+    plan_action(AnotherCoreAppAction, arguments.first)
+  end
+
+  def run
+    puts "Running core action: #{input[:args]}"
+    self.output.update success: true
+  end
+end
+```
+
+followed by an action definition defined in a plugin/gem/etc.
+
+```ruby
+class APluginAction < Dynflow::Action
+  # plan this action whenever ACoreAppAction action is planned
+  def self.subscribe
+    ACoreAppAction
+  end
+
+  def plan(arguments)
+    # arguments are same as in ACoreAppAction#plan
+    plan_self(args: arguments)
+  end
+
+  def run
+    puts "Running plugin action: #{input[:args]}"
+  end
+end
+```
+
+Subscribed actions are planned with same arguments as action they are
+subscribing to which is called `trigger`. Their plan method is called right
+after planning of the triggering action finishes.
+
+It's also possible to access target action and use its output which
+makes it dependent (running in sequence) on triggering action.
+
+```ruby
+def plan(arguments)
+  plan_self trigger_success: trigger.output[:success]
+end
+
+def run
+  self.output.update 'trigger succeeded' if self.input[:trigger_success]
+end
+```
+
+Subscription is designed for extension by plugins, it should **not** be used
+inside a single library/app-module. It would make the process definition
+hard to follow (all subscribed actions would need to be looked up).
+
+### Suspending
+
+Sometimes action represents tasks taken in different services,
+(e.g. repository synchronization in [Pulp](http://www.pulpproject.org/)).
+Dynflow tries not to waste computer resources so it offers tools to free
+threads to work on other actions while waiting on external tasks or events.
+
+Dynflow allows actions to suspend and be woken up on external events.
+Lets create a simulation of an external service before showing the example
+of suspending action.
+
+```ruby
+class AnExternalService
+  def start_synchronization(report_to)
+    Thread.new do
+      sleep 1
+      report_to << :done
+    end
+  end
+end
+```
+
+The `AnExternalService` can be invoked to `start_synchronization` and it will
+report back a second later to action passed in argument `report_to`. It sends
+event `:done` back by `<<` method.
+
+Lets look at an action example.
+
+```ruby
+class AnAction < Dynflow::Action
+  EXTERNAL_SERVICE = AnExternalService.new
+
+  def plan
+    plan_self
+  end
+
+  def run(event)
+    case event
+    when nil # first run
+      suspend do |suspended_action|
+        EXTERNAL_SERVICE.start_synchronization suspended_action
+      end
+    when :done # external task is done
+      output.update success: true
+      # let the run phase finish normally
+    else
+      raise 'unknown event'
+    end
+  end
+end
+```
+Which is then executed as follows:
+
+1.  `AnAction` is triggered
+1.  It's planned.
+1.  Its `run` phase begins.
+1.  `run` method is invoked with no event (`nil`).
+1.  Matches with case branch initiating the external synchronization.
+1.  Action initializes the synchronization and pass in reference
+    to suspended_action.
+1.  Action is suspended, execution of the run method finishes immediately
+    after `suspend` is called, its block parameter is evaluated right after
+    suspending.
+1.  Action is kept on memory to be woken up when events are received but it does not
+    block any threads.
+1.  Action receives `:done` event through suspend action reference.
+1.  `run` method is executed again with `:done` event.
+1.  Output is updated with `success: true` and actions finishes `run` phase.
+1.  There is no `finalize` phase, action is done.
+
+This event mechanism is quite flexible, it can be used for example to build a
+[polling action abstraction](https://github.com/Dynflow/dynflow/blob/master/lib/dynflow/action/polling.rb)
+which is a topic for next chapter.
+
+### Polling
+
+Not all services support callbacks to be registered which would allow to wake up suspended
+actions only once at the end when the external task is finished. In that case we often
+need to poll the service to see if the task is still running or finished.
+
+For that purpose there is `Polling` module in Dynflow. Any action can be turned into a polling one
+just by including the module.
+
+```ruby
+class AnAction < Dynflow::Action
+  include Dynflow::Action::Polling
+```
+
+There are 3 methods need to be always implemented:
+
+-   `done?` - determines when the task is complete based on external task's data.
+-   `invoke_external_task` - starts the external task.
+-   `poll_external_task` - polls the external task status data and returns a status
+    (JSON serializable data like: `Hash`, `Array`, `String`, etc.) which are stored in action's
+    output.
+
+```ruby
+  def done?
+    external_task[:progress] == 1
+  end
+
+  def invoke_external_task
+    triger_the_task_with_rest_call
+  end
+
+  def poll_external_task
+    data     = poll_data_with_rest_call
+    progress = calculate_progress data # => a float in 0..1
+    { progress: progress
+      data:     data }
+  end
+end
+```
+
+This action will do following in run phase:
+
+1.  `invoke_external_task` on first run of the action
+1.  suspends and then periodically:
+    1.  wakes up
+    1.  `poll_external_task`
+    1.  checks if `done?`:
+        - `true` -> it concludes the run phase
+        - `false` -> it schedules next polling
+
+There are 2 other methods handling external task data which can optionally overridden:
+
+-   `external_task` - reads the external task's stored data, by default it reads `self.output[:task]`
+-   `external_task=` - writes the the external task's stored data, by default it writes to
+    `self.output[:task] = value`
+
+There are also other features implemented like:
+
+-   Gradual prolongation of the polling interval.
+-   Retries on a poll failing.
+
+Please see the
+[`Polling` module](https://github.com/Dynflow/dynflow/blob/master/lib/dynflow/action/polling.rb)
+for more details.
+
+### States
+
+Each **Action phase** can be in one of the following states:
+
+-   **Pending** - Not yet executed.
+-   **Running** - An action phase id being executed right now.
+-   **Success** - Execution of an action phase finished successfully.
+-   **Error** - There was an error during execution.
+-   **Suspended** - Only `run` phase, when action sleeps waiting for events to be woken up.
+-   **Skipped** - Failed actions can be marked as skipped allowing rest of the
+    execution plan to finish successfully.
+-   **Skipping** - Action is marked for skipping but execution plan was not yet
+    resumed to mark it as Skipped.
+
+**Execution plan** has following states:
+
+-   **Pending** - Planning did not start yet.
+-   **Planning** - It's being planned.
+-   **Planned** - It've been planned, running phase did not start yet.
+-   **Running** - It's running, `run` and `finalize` phases of actions are executed.
+-   **Paused** - It was paused when running. Happens on error or executor restart.
+-   **Stopped** - Execution plan is completed.
+
+**Execution plan** also has following results:
+
+-   **Success** - Everything finished without error or skips.
+-   **Warning** - When there are skipped steps.
+-   **Error** - When one or more actions failed.
+-   **Pending** - Execution plan still runs.
+
+*TODO how do I access such states as a programmer?*
+*TODO which Action phase states are "finish" and which requires user interaction?*
+
+### Error handling
+
+If there is an error risen in **`plan` phase**, the error is persisted in the Action object 
+for later inspection and it bubbles up in `World#trigger` method which was used to trigger 
+the action leading to this error. 
+If you compare it to errors raised during `run` and `finalize` phase,
+there's the major difference: Those never bubble up in `trigger` because they are running
+in executor not in triggering Thread, they are just persisted in Action object.
+
+If there is an error in **`run` phase**, the execution pauses. You can inspect the error in
+[console](#console). The error may be intermittent or you may fix the problem manually. After
+that the execution plan can be resumed and it'll continue by rerunning the failed action and
+continuing with the rest of the actions. During fixing the problem you may also do the steps
+in the actions manually, in that case the failed action can be also marked as skipped. After
+resuming the skipped action is not executed and the execution plan continues with the rest.
+
+If there is an error in **`finalize` phase**, whole `finalize` phase for all the actions is
+rollbacked and can be rerun when the problem is fixed by resuming.
+
+If you encounter an error during run phase `error!` or usual `raise` can be used.
+
+#### Rescue strategy TODO
+
+### Console TODO
+
+-   *where to access*
+-   *screenshots*
+
+### Testing TODO
+
+-   *testing helper methods*
+-   *examples*
+-   *see [testing of testing](https://github.com/Dynflow/dynflow/blob/master/test/testing_test.rb)*
+
+### Long-running actions
+
+Dynflow was designed as an Orchestration tool, parallelization of heavy CPU computation tasks
+was not directly considered. Even with multiple executors single execution plan always runs
+on one executor, so without JRuby it wont scale well (MRI's GIL). However JRuby support
+should be added soon (TODO update when merged).
+
+Another problem with long-running actions are blocked worker. Executor has only a limited pool of
+workers, if more of them become busy it may result in worsen performance.
+
+Blocking actions for long time are also problematic.
+
+Solutions are:
+
+-   **Using action suspending** - suspending the action until a condition is met,
+    freeing the worker.
+-   **Offloading computation** - CPU heavy parts can be offloaded to different services
+    notifying the suspended actions when the computation is done.
+
+### Middleware
+
+Each action class has chain of middlewares which wrap phases of the action execution.
+It's very similar to rack middlewares.
+To create new middleware inherit from `Dynflow::Middleware` class. It has 5 methods which can be
+overridden: `plan`, `run`, `finalize`, `plan_phase`, `finalize_phase`. Where the default
+implementation for all the methods looks as following
+
+```ruby
+def plan(*args)
+  pass *args
+end
+```
+
+When overriding user can insert code before and/or after the `pass` method which executes next
+middleware in the chain or the action itself which is at the end of the chain. Most usually the
+`pass` is always called somewhere in the overridden method. There may be some cases when it can
+be omitted, then it'll prevent all following middlewares and action from running.
+
+Some implementation examples:
+[KeepCurrentUser](https://github.com/theforeman/foreman-tasks/blob/master/app/lib/actions/middleware/keep_current_user.rb),
+[Action::Progress::Calculate](https://github.com/Dynflow/dynflow/blob/master/lib/dynflow/action/progress.rb#L13-L42).
+
+Each Action has a chain of middlewares defined. Middleware can be added by calling `use`
+in the action class.
+
+```ruby
+class AnAction < Dynflow::Action
+  use AMiddleware, after: AnotherMiddleware
+end
+```
+
+Method `use` understands 3 option keys:
+
+-   `:before` - makes this middleware to be ordered before a given middleware
+-   `:after` - makes this middleware to be ordered after a given middleware
+-   `:replace` - this middleware will replace given middleware
+
+The `:before` and `:after` keys are used to build a graph from the middlewares which is then
+sorted down with
+[topological sort](http://ruby-doc.org//stdlib-2.0/libdoc/tsort/rdoc/TSort.html)
+to the chain of middleware execution.
+
+### SubTasks TODO
+
+-   *when to use?*
+-   *how to use?*
+
+## How it works TODO
+
+### Action states TODO
+
+-   *normal phases and Present phase*
+-   *how to walk the execution plan*
+
+### Inner-world communication and multi-executors TODO
+
+### Thread-pools TODO
+
+-   *how it works now*
+-   *how it'll work*
+-   *gotchas*
+    -   *worker pool sizing*
+
+### Suspending -> events TODO
+
+## Use cases TODO
+
+-   *Embedded without a DB, like inside CLI tool for a complex installation*
+-   *reserve resources in planning do not try to do `if`s in run phase*
+-   *Projects: katello, foreman, staypuft, fusor*
+
+## Comments
+
+**Comments are temporally turned on here for faster feedback.**