Docs built from 771102f

examples/index.html

@@ -67,7 +67,7 @@
 <span class="line"><span style="color:#24292E;">        </span><span style="color:#005CC5;">&quot;link&quot;</span><span style="color:#24292E;">: </span><span style="color:#032F62;">&quot;https://s3.eu-central-1.amazonaws.com/krawler/bc185cb0-7983-11e8-883f-a333a7402f4a.png&quot;</span></span>
 <span class="line"><span style="color:#24292E;">    }</span></span>
 <span class="line"><span style="color:#24292E;">]</span></span></code></pre></div><h3 id="seeder" tabindex="-1">Seeder <a class="header-anchor" href="#seeder" aria-label="Permalink to &quot;Seeder&quot;">​</a></h3><p>The seeder take advantage of <a href="https://kalisio.github.io/kargo/" target="_blank" rel="noreferrer">Kargo</a> to seed a dataset. It relies on the seeding capabilities of <a href="https://mapproxy.org/docs/nightly/seed.html" target="_blank" rel="noreferrer">MapProxy</a>. The global approach is to subdivide the job into multiple tasks and run <code>mapprroxy-seed</code> utility for each task. To subdivide the job, we use a spatial grid and each cell is used as a coverage entry to limit the extend of the corresponding task. All the tasks, i.e. <code>mapproxy-seed</code> share the same MapProxy configuration file and use a generated seed file.</p><p>We use the same image of MapProxy as the one used in Kargo, but for now we do not use the benefits of a Swarm infrastructure to deploy the task. Meanwhile, if you plan to seed a layer with a source exposed by TileserverGL, you can easily scale the number of instances of TileserverGL to fit the required charge.</p></div></div></main><footer class="VPDocFooter" data-v-a3c25e27 data-v-a2d931e4><!--[--><!--]--><!----><!----></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><footer class="VPFooter" data-v-9d8abc1e data-v-e4279f1c><div class="container" data-v-e4279f1c><!----><p class="copyright" data-v-e4279f1c>MIT Licensed | Copyright © 2017-20xx Kalisio</p></div></footer><!--[--><!--]--></div></div>
-    <script>window.__VP_HASH_MAP__=JSON.parse("{\"about_introduction.md\":\"b4a8b11a\",\"guides_index.md\":\"8bac4ba9\",\"about_license.md\":\"51fe04ca\",\"guides_extending-krawler.md\":\"ccca42a7\",\"examples_index.md\":\"2db99c6c\",\"about_roadmap.md\":\"2f902165\",\"guides_using-krawler.md\":\"e66b4f7b\",\"guides_installing-krawler.md\":\"60d1a08e\",\"about_contact.md\":\"8fe8c179\",\"reference_index.md\":\"76bdc228\",\"about_contributing.md\":\"30a97c28\",\"index.md\":\"ee3add83\",\"guides_understanding-krawler.md\":\"56d783c6\",\"reference_hooks.md\":\"2874e9f8\",\"reference_services.md\":\"4fa3200f\",\"reference_known-issues.md\":\"29bbda91\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"Krawler\",\"description\":\"A minimalist Geospatial ETL\",\"base\":\"/krawler/\",\"head\":[],\"appearance\":true,\"themeConfig\":{\"logo\":\"https://s3.eu-central-1.amazonaws.com/kalisioscope/krawler/krawler-icon-64x64.png\",\"socialLinks\":[{\"icon\":\"linkedin\",\"link\":\"https://fr.linkedin.com/company/kalisio\"},{\"icon\":\"twitter\",\"link\":\"https://twitter.com/Kalisio3\"},{\"icon\":\"github\",\"link\":\"https://github.com/kalisio\"}],\"nav\":[{\"text\":\"About\",\"link\":\"/about/introduction\"},{\"text\":\"Guides\",\"link\":\"/guides/understanding-krawler\"},{\"text\":\"Reference\",\"link\":\"/reference/services\"},{\"text\":\"Examples\",\"link\":\"/examples/\"},{\"text\":\"GitHub\",\"link\":\"https://github.com/kalisio/krawler\"}],\"sidebar\":{\"/about/\":[{\"text\":\"Introduction\",\"link\":\"/about/introduction\"},{\"text\":\"Roadmap\",\"link\":\"/about/roadmap\"},{\"text\":\"Contributing\",\"link\":\"/about/contributing\"},{\"text\":\"License\",\"link\":\"/about/license\"},{\"text\":\"Contact\",\"link\":\"/about/contact\"}],\"/guides/\":[{\"text\":\"Understanding Krawler\",\"link\":\"/guides/understanding-krawler\"},{\"text\":\"Installing Krawler\",\"link\":\"/guides/installing-krawler\"},{\"text\":\"Using Krawler\",\"link\":\"/guides/using-krawler\"},{\"text\":\"Extending Krawler\",\"link\":\"/guides/extending-krawler\"}],\"/reference/\":[{\"text\":\"Services\",\"link\":\"/reference/services\"},{\"text\":\"Hooks\",\"link\":\"/reference/hooks\"},{\"text\":\"Known-issues\",\"link\":\"/reference/known-issues\"}],\"/examples/\":[]},\"footer\":{\"copyright\":\"MIT Licensed | Copyright © 2017-20xx Kalisio\"}},\"locales\":{},\"scrollOffset\":90,\"cleanUrls\":false}");</script>
+    <script>window.__VP_HASH_MAP__=JSON.parse("{\"about_roadmap.md\":\"2f902165\",\"guides_using-krawler.md\":\"e66b4f7b\",\"index.md\":\"ee3add83\",\"examples_index.md\":\"2db99c6c\",\"reference_known-issues.md\":\"29bbda91\",\"guides_installing-krawler.md\":\"60d1a08e\",\"about_contact.md\":\"8fe8c179\",\"about_contributing.md\":\"30a97c28\",\"guides_understanding-krawler.md\":\"56d783c6\",\"reference_index.md\":\"76bdc228\",\"guides_extending-krawler.md\":\"ccca42a7\",\"reference_services.md\":\"4fa3200f\",\"about_license.md\":\"51fe04ca\",\"about_introduction.md\":\"b4a8b11a\",\"guides_index.md\":\"8bac4ba9\",\"reference_hooks.md\":\"2874e9f8\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"Krawler\",\"description\":\"A minimalist Geospatial ETL\",\"base\":\"/krawler/\",\"head\":[],\"appearance\":true,\"themeConfig\":{\"logo\":\"https://s3.eu-central-1.amazonaws.com/kalisioscope/krawler/krawler-icon-64x64.png\",\"socialLinks\":[{\"icon\":\"linkedin\",\"link\":\"https://fr.linkedin.com/company/kalisio\"},{\"icon\":\"twitter\",\"link\":\"https://twitter.com/Kalisio3\"},{\"icon\":\"github\",\"link\":\"https://github.com/kalisio\"}],\"nav\":[{\"text\":\"About\",\"link\":\"/about/introduction\"},{\"text\":\"Guides\",\"link\":\"/guides/understanding-krawler\"},{\"text\":\"Reference\",\"link\":\"/reference/services\"},{\"text\":\"Examples\",\"link\":\"/examples/\"},{\"text\":\"GitHub\",\"link\":\"https://github.com/kalisio/krawler\"}],\"sidebar\":{\"/about/\":[{\"text\":\"Introduction\",\"link\":\"/about/introduction\"},{\"text\":\"Roadmap\",\"link\":\"/about/roadmap\"},{\"text\":\"Contributing\",\"link\":\"/about/contributing\"},{\"text\":\"License\",\"link\":\"/about/license\"},{\"text\":\"Contact\",\"link\":\"/about/contact\"}],\"/guides/\":[{\"text\":\"Understanding Krawler\",\"link\":\"/guides/understanding-krawler\"},{\"text\":\"Installing Krawler\",\"link\":\"/guides/installing-krawler\"},{\"text\":\"Using Krawler\",\"link\":\"/guides/using-krawler\"},{\"text\":\"Extending Krawler\",\"link\":\"/guides/extending-krawler\"}],\"/reference/\":[{\"text\":\"Services\",\"link\":\"/reference/services\"},{\"text\":\"Hooks\",\"link\":\"/reference/hooks\"},{\"text\":\"Known-issues\",\"link\":\"/reference/known-issues\"}],\"/examples/\":[]},\"footer\":{\"copyright\":\"MIT Licensed | Copyright © 2017-20xx Kalisio\"}},\"locales\":{},\"scrollOffset\":90,\"cleanUrls\":false}");</script>
 
   </body>
 </html>

guides/extending-krawler.html

@@ -57,7 +57,7 @@
 <span class="line"><span style="color:#24292E;">  }</span></span>
 <span class="line"><span style="color:#24292E;">}</span></span>
 <span class="line"><span style="color:#24292E;">hooks.</span><span style="color:#6F42C1;">registerHook</span><span style="color:#24292E;">(</span><span style="color:#032F62;">&#39;custom&#39;</span><span style="color:#24292E;">, hook)</span></span></code></pre></div><p>After that you can use your custom hook like the built-in ones with the <a href="./using-krawler.html#command-line-interface">CLI</a>.</p><div class="tip custom-block"><p class="custom-block-title">TIP</p><p>For this to work you need to add krawler as a dependency in the <code>package.json</code> of your job module or link to it in development mode. Please refer to our <a href="./installing-krawler.html#as-module">installation section</a></p></div><h2 id="complete-example" tabindex="-1">Complete example <a class="header-anchor" href="#complete-example" aria-label="Permalink to &quot;Complete example&quot;">​</a></h2><p>A complete example of extension is available in the <a href="https://github.com/kalisio/krawler/blob/master/examples/extend/index.js" target="_blank" rel="noreferrer">samples</a>.</p></div></div></main><footer class="VPDocFooter" data-v-a3c25e27 data-v-a2d931e4><!--[--><!--]--><!----><nav class="prev-next" data-v-a2d931e4><div class="pager" data-v-a2d931e4><a class="pager-link prev" href="/krawler/guides/using-krawler.html" data-v-a2d931e4><span class="desc" data-v-a2d931e4>Previous page</span><span class="title" data-v-a2d931e4>Using Krawler</span></a></div><div class="pager" data-v-a2d931e4><!----></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><footer class="VPFooter has-sidebar" data-v-9d8abc1e data-v-e4279f1c><div class="container" data-v-e4279f1c><!----><p class="copyright" data-v-e4279f1c>MIT Licensed | Copyright © 2017-20xx Kalisio</p></div></footer><!--[--><!--]--></div></div>
-    <script>window.__VP_HASH_MAP__=JSON.parse("{\"about_introduction.md\":\"b4a8b11a\",\"guides_index.md\":\"8bac4ba9\",\"about_license.md\":\"51fe04ca\",\"guides_extending-krawler.md\":\"ccca42a7\",\"examples_index.md\":\"2db99c6c\",\"about_roadmap.md\":\"2f902165\",\"guides_using-krawler.md\":\"e66b4f7b\",\"guides_installing-krawler.md\":\"60d1a08e\",\"about_contact.md\":\"8fe8c179\",\"reference_index.md\":\"76bdc228\",\"about_contributing.md\":\"30a97c28\",\"index.md\":\"ee3add83\",\"guides_understanding-krawler.md\":\"56d783c6\",\"reference_hooks.md\":\"2874e9f8\",\"reference_services.md\":\"4fa3200f\",\"reference_known-issues.md\":\"29bbda91\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"Krawler\",\"description\":\"A minimalist Geospatial ETL\",\"base\":\"/krawler/\",\"head\":[],\"appearance\":true,\"themeConfig\":{\"logo\":\"https://s3.eu-central-1.amazonaws.com/kalisioscope/krawler/krawler-icon-64x64.png\",\"socialLinks\":[{\"icon\":\"linkedin\",\"link\":\"https://fr.linkedin.com/company/kalisio\"},{\"icon\":\"twitter\",\"link\":\"https://twitter.com/Kalisio3\"},{\"icon\":\"github\",\"link\":\"https://github.com/kalisio\"}],\"nav\":[{\"text\":\"About\",\"link\":\"/about/introduction\"},{\"text\":\"Guides\",\"link\":\"/guides/understanding-krawler\"},{\"text\":\"Reference\",\"link\":\"/reference/services\"},{\"text\":\"Examples\",\"link\":\"/examples/\"},{\"text\":\"GitHub\",\"link\":\"https://github.com/kalisio/krawler\"}],\"sidebar\":{\"/about/\":[{\"text\":\"Introduction\",\"link\":\"/about/introduction\"},{\"text\":\"Roadmap\",\"link\":\"/about/roadmap\"},{\"text\":\"Contributing\",\"link\":\"/about/contributing\"},{\"text\":\"License\",\"link\":\"/about/license\"},{\"text\":\"Contact\",\"link\":\"/about/contact\"}],\"/guides/\":[{\"text\":\"Understanding Krawler\",\"link\":\"/guides/understanding-krawler\"},{\"text\":\"Installing Krawler\",\"link\":\"/guides/installing-krawler\"},{\"text\":\"Using Krawler\",\"link\":\"/guides/using-krawler\"},{\"text\":\"Extending Krawler\",\"link\":\"/guides/extending-krawler\"}],\"/reference/\":[{\"text\":\"Services\",\"link\":\"/reference/services\"},{\"text\":\"Hooks\",\"link\":\"/reference/hooks\"},{\"text\":\"Known-issues\",\"link\":\"/reference/known-issues\"}],\"/examples/\":[]},\"footer\":{\"copyright\":\"MIT Licensed | Copyright © 2017-20xx Kalisio\"}},\"locales\":{},\"scrollOffset\":90,\"cleanUrls\":false}");</script>
+    <script>window.__VP_HASH_MAP__=JSON.parse("{\"about_roadmap.md\":\"2f902165\",\"guides_using-krawler.md\":\"e66b4f7b\",\"index.md\":\"ee3add83\",\"examples_index.md\":\"2db99c6c\",\"reference_known-issues.md\":\"29bbda91\",\"guides_installing-krawler.md\":\"60d1a08e\",\"about_contact.md\":\"8fe8c179\",\"about_contributing.md\":\"30a97c28\",\"guides_understanding-krawler.md\":\"56d783c6\",\"reference_index.md\":\"76bdc228\",\"guides_extending-krawler.md\":\"ccca42a7\",\"reference_services.md\":\"4fa3200f\",\"about_license.md\":\"51fe04ca\",\"about_introduction.md\":\"b4a8b11a\",\"guides_index.md\":\"8bac4ba9\",\"reference_hooks.md\":\"2874e9f8\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"Krawler\",\"description\":\"A minimalist Geospatial ETL\",\"base\":\"/krawler/\",\"head\":[],\"appearance\":true,\"themeConfig\":{\"logo\":\"https://s3.eu-central-1.amazonaws.com/kalisioscope/krawler/krawler-icon-64x64.png\",\"socialLinks\":[{\"icon\":\"linkedin\",\"link\":\"https://fr.linkedin.com/company/kalisio\"},{\"icon\":\"twitter\",\"link\":\"https://twitter.com/Kalisio3\"},{\"icon\":\"github\",\"link\":\"https://github.com/kalisio\"}],\"nav\":[{\"text\":\"About\",\"link\":\"/about/introduction\"},{\"text\":\"Guides\",\"link\":\"/guides/understanding-krawler\"},{\"text\":\"Reference\",\"link\":\"/reference/services\"},{\"text\":\"Examples\",\"link\":\"/examples/\"},{\"text\":\"GitHub\",\"link\":\"https://github.com/kalisio/krawler\"}],\"sidebar\":{\"/about/\":[{\"text\":\"Introduction\",\"link\":\"/about/introduction\"},{\"text\":\"Roadmap\",\"link\":\"/about/roadmap\"},{\"text\":\"Contributing\",\"link\":\"/about/contributing\"},{\"text\":\"License\",\"link\":\"/about/license\"},{\"text\":\"Contact\",\"link\":\"/about/contact\"}],\"/guides/\":[{\"text\":\"Understanding Krawler\",\"link\":\"/guides/understanding-krawler\"},{\"text\":\"Installing Krawler\",\"link\":\"/guides/installing-krawler\"},{\"text\":\"Using Krawler\",\"link\":\"/guides/using-krawler\"},{\"text\":\"Extending Krawler\",\"link\":\"/guides/extending-krawler\"}],\"/reference/\":[{\"text\":\"Services\",\"link\":\"/reference/services\"},{\"text\":\"Hooks\",\"link\":\"/reference/hooks\"},{\"text\":\"Known-issues\",\"link\":\"/reference/known-issues\"}],\"/examples/\":[]},\"footer\":{\"copyright\":\"MIT Licensed | Copyright © 2017-20xx Kalisio\"}},\"locales\":{},\"scrollOffset\":90,\"cleanUrls\":false}");</script>
 
   </body>
 </html>