Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Victor Castell committed Sep 2, 2023
1 parent a6c31f4 commit ccad0e3
Show file tree
Hide file tree
Showing 207 changed files with 824 additions and 730 deletions.
8 changes: 4 additions & 4 deletions 404.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@
<meta name="generator" content="Docusaurus v2.2.0">
<title data-rh="true">Page Not Found | Dkron</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://dkron.io/404.html"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docusaurus_tag" content="default"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docsearch:docusaurus_tag" content="default"><meta data-rh="true" property="og:title" content="Page Not Found | Dkron"><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://dkron.io/404.html"><link data-rh="true" rel="alternate" href="https://dkron.io/404.html" hreflang="en"><link data-rh="true" rel="alternate" href="https://dkron.io/404.html" hreflang="x-default"><link rel="alternate" type="application/rss+xml" href="/blog/rss.xml" title="Dkron RSS Feed">
<link rel="alternate" type="application/atom+xml" href="/blog/atom.xml" title="Dkron Atom Feed"><link rel="stylesheet" href="/assets/css/styles.977ea266.css">
<link rel="preload" href="/assets/js/runtime~main.615922cb.js" as="script">
<link rel="preload" href="/assets/js/main.2969c6cf.js" as="script">
<link rel="preload" href="/assets/js/runtime~main.192a5d71.js" as="script">
<link rel="preload" href="/assets/js/main.53b76a29.js" as="script">
</head>
<body class="navigation-with-keyboard">
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</script><div id="__docusaurus">
<div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#docusaurus_skipToContent_fallback">Skip to main content</a></div><nav class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/dkron-logo-black.png" alt="Dkron Logo" class="themedImage_ToTc themedImage--light_HNdA"><img src="/img/dkron-logo-black.png" alt="Dkron Logo" class="themedImage_ToTc themedImage--dark_i4oU"></div><b class="navbar__title text--truncate"></b></a><a class="navbar__item navbar__link" href="/docs/basics/getting-started">Docs</a><a class="navbar__item navbar__link" href="/api/">API</a><a class="navbar__item navbar__link" href="/blog">Blog</a><a class="navbar__item navbar__link" href="/license">License</a><div class="navbar__item dropdown dropdown--hoverable"><a class="navbar__link" aria-haspopup="true" aria-expanded="false" role="button" href="/docs/basics/getting-started">v3</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/docs/basics/getting-started">v3</a></li><li><a class="dropdown__link" href="/docs/v2/basics/configuration">v2</a></li><li><a class="dropdown__link" href="/docs/v1/basics/configuration">v1</a></li></ul></div><a class="navbar__item navbar__link navbar-link-go-pro" href="/pro/">PRO</a></div><div class="navbar__items navbar__items--right"><a href="https://github.com/distribworks/dkron" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a><div class="searchBox_ZlJk"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0"><main class="container margin-vert--xl"><div class="row"><div class="col col--6 col--offset-3"><h1 class="hero__title">Page Not Found</h1><p>We could not find what you were looking for.</p><p>Please contact the owner of the site that linked you to the original URL and let them know their link is broken.</p></div></div></main></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs/intro">Intro</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://stackoverflow.com/questions/tagged/dkron" target="_blank" rel="noopener noreferrer" class="footer__link-item">Stack Overflow<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://gitter.im/distribworks/dkron" target="_blank" rel="noopener noreferrer" class="footer__link-item">Gitter<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://twitter.com/distribworks" target="_blank" rel="noopener noreferrer" class="footer__link-item">Twitter<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/blog">Blog</a></li><li class="footer__item"><a href="https://github.com/distribworks/dkron" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2023 Distributed Works. Built with Docusaurus.</div></div></div></footer></div>
<script src="/assets/js/runtime~main.615922cb.js"></script>
<script src="/assets/js/main.2969c6cf.js"></script>
<script src="/assets/js/runtime~main.192a5d71.js"></script>
<script src="/assets/js/main.53b76a29.js"></script>
</body>
</html>
8 changes: 4 additions & 4 deletions api/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@
Default API responses are unformatted JSON add the `pretty=true` param to format the response.
"><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://dkron.io/api/"><link data-rh="true" rel="alternate" href="https://dkron.io/api/" hreflang="en"><link data-rh="true" rel="alternate" href="https://dkron.io/api/" hreflang="x-default"><link rel="alternate" type="application/rss+xml" href="/blog/rss.xml" title="Dkron RSS Feed">
<link rel="alternate" type="application/atom+xml" href="/blog/atom.xml" title="Dkron Atom Feed"><link rel="stylesheet" href="/assets/css/styles.977ea266.css">
<link rel="preload" href="/assets/js/runtime~main.615922cb.js" as="script">
<link rel="preload" href="/assets/js/main.2969c6cf.js" as="script">
<link rel="preload" href="/assets/js/runtime~main.192a5d71.js" as="script">
<link rel="preload" href="/assets/js/main.53b76a29.js" as="script">
</head>
<body class="navigation-with-keyboard">
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</script><div id="__docusaurus">
Expand Down Expand Up @@ -104,7 +104,7 @@
</div></div></div></td></tr><tr class="last undefined"><td class="sc-hAZoDl sc-fEOsli hXTTeA bnZPxp" kind="field" title="execution"><span class="sc-idiyUo klvgdF"></span><span>execution</span><div class="sc-TRNrF sc-jIAOiI lbjmnO llzbIf"> required </div></td><td class="sc-bjUoiL ekMelP"><div><div><span class="sc-fbPSWO sc-GVOUr wnxRd cBiDFW"></span><span class="sc-fbPSWO sc-fXynhf wnxRd kzIupC">string</span></div> <div><div class="sc-iAvgwm sc-cOFTSb jKfBJn kPemJp"><p>The executions to be fetched.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-hsOonA gtgAOT">Responses</h3><div><button class="sc-eEOqmf fyQjOx"><svg class="sc-evZas jcznrM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dUWWNf bSsjSQ">200<!-- --> </strong><span class="sc-BeQoi ceUBCu"><p>Successful response</p>
</span></button></div></div></div><div class="sc-jSMfEi sc-gKXOVf kGJqig jSfEKO"><div class="sc-yeoIj dxvnJB"><button class="sc-jGprRt weNym"><span type="get" class="sc-bPyhqo fWQmRB http-verb get">get</span><span class="sc-dWINGa hhSNkj">/jobs/{job_name}/executions/{execution}</span><svg class="sc-evZas dtQqE" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-fWIMVQ cWFHeg"><div class="sc-ESujJ bASrHn"><div class="sc-iAvgwm sc-cOFTSb jKfBJn kPemJp"></div><div tabindex="0" role="button"><div class="sc-jWEIYm jJZGvO"><span>http://localhost:8080/v1</span>/jobs/{job_name}/executions/{execution}</div></div></div></div></div><div><h3 class="sc-kDDrLX bphuUp"> <!-- -->Response samples<!-- --> </h3><div class="sc-bZnhIo gqAzZB" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-88" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-89" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-89" aria-labelledby="react-tabs-88"><div><div class="sc-hiMGwR cRDjKP"><span class="sc-olbas hsvJaz">Content type</span><div class="sc-eKszNL cxmgNI">application/json</div></div><div class="sc-gFGZVQ bSKoZj"><div class="sc-iNWwEs dlJjsm"><div class="sc-efBctP dztoWg"><button><div class="sc-kgUAyh iKuaTk">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iAvgwm jKfBJn sc-jfmDQi hlQDxC"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable"><span class="property token string">"job_name"</span>: <span class="token string">&quot;job_1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable"><span class="property token string">"started_at"</span>: <span class="token string">&quot;2019-08-24T14:15:22Z&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable"><span class="property token string">"finished_at"</span>: <span class="token string">&quot;2019-08-24T14:15:22Z&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable"><span class="property token string">"success"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable"><span class="property token string">"output"</span>: <span class="token string">&quot;Hello from Dkron&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable"><span class="property token string">"node_name"</span>: <span class="token string">&quot;dkron1&quot;</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div></div><div class="sc-iJkHyd gpoklw"></div></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs/intro">Intro</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://stackoverflow.com/questions/tagged/dkron" target="_blank" rel="noopener noreferrer" class="footer__link-item">Stack Overflow<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://gitter.im/distribworks/dkron" target="_blank" rel="noopener noreferrer" class="footer__link-item">Gitter<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://twitter.com/distribworks" target="_blank" rel="noopener noreferrer" class="footer__link-item">Twitter<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/blog">Blog</a></li><li class="footer__item"><a href="https://github.com/distribworks/dkron" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2023 Distributed Works. Built with Docusaurus.</div></div></div></footer></div>
<script src="/assets/js/runtime~main.615922cb.js"></script>
<script src="/assets/js/main.2969c6cf.js"></script>
<script src="/assets/js/runtime~main.192a5d71.js"></script>
<script src="/assets/js/main.53b76a29.js"></script>
</body>
</html>
Loading

0 comments on commit ccad0e3

Please sign in to comment.