Skip to content

Commit

Permalink
Docs built from 3ca2553
Browse files Browse the repository at this point in the history
  • Loading branch information
claustres committed Nov 28, 2024
1 parent 506778e commit d16d177
Show file tree
Hide file tree
Showing 20 changed files with 189 additions and 21 deletions.
2 changes: 1 addition & 1 deletion 404.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion about/contact.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion about/contributing.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion about/introduction.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion about/license.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion about/roadmap.html

Large diffs are not rendered by default.

167 changes: 167 additions & 0 deletions assets/guides_advanced-usage.md.ar737nIi.js

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions assets/guides_advanced-usage.md.ar737nIi.lean.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions guides/advanced-usage.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion guides/customizing-kano.html
Original file line number Diff line number Diff line change
Expand Up @@ -515,7 +515,7 @@
<span class="line"><span> -d @stations-data.json https://your.kano.domain/api/sensors-stations</span></span>
<span class="line"><span>curl -X POST -H &quot;Authorization: Bearer %TOKEN%&quot; -H &quot;Content-Type: application/json&quot; ^</span></span>
<span class="line"><span> -d @observations-data.json https://your.kano.domain/api/sensors-observations</span></span></code></pre></div><div class="tip custom-block"><p class="custom-block-title">TIP</p><p>For testing purpose you can get a valid token from the local storage in the developer tool after logged into Kano.</p></div><p>Using the bottom timeline, navigate to a date/time with existing sensor data, you now should be able to see your sensor on the map, selecting it should open the value timeseries:</p><p><img src="/kano/assets/kano-sensors-layers.1fWLR23M.png" alt="sensors layers"></p><p>A data layer can contain multiple time-varying elements called <em>variables</em>. The features may contain additional properties, e.g. a status (OK/NOK), a name, etc. that can be used to customize the rendering, e.g. icon, color, tooltip, etc.</p><p>The main <a href="https://kalisio.github.io/kdk/api/map/services.html#catalog-service" target="_blank" rel="noreferrer">configuration options</a> are the following:</p><ul><li>the property that will be use to uniquely identify a station (i.e. ID)</li><li>the refresh rate of the data in the layer (used to automatically update the view every N seconds in Kano)</li><li>the <em>life time</em> of a measure, i.e. if no measure found within the range <code>current time - life time</code> the station is not considered to have performed any measure for current time</li><li>the list of the variables contained in the data with associated properties to ease timeseries display (unit, range, color, ...)</li></ul><div class="tip custom-block"><p class="custom-block-title">TIP</p><p>A layer can have no fixed stations but only measurements from sensors in order to display moving data</p></div><h2 id="customizing-the-catalog-legend" tabindex="-1">Customizing the catalog legend <a class="header-anchor" href="#customizing-the-catalog-legend" aria-label="Permalink to &quot;Customizing the catalog legend&quot;"></a></h2><p><strong>To be completed</strong></p></div></div></main><footer class="VPDocFooter" data-v-e6f2a212 data-v-b4b63abf><!--[--><!--]--><!----><nav class="prev-next" data-v-b4b63abf><div class="pager" data-v-b4b63abf><a class="VPLink link pager-link prev" href="/kano/guides/installing-kano.html" data-v-b4b63abf><!--[--><span class="desc" data-v-b4b63abf>Previous page</span><span class="title" data-v-b4b63abf>Installing Kano</span><!--]--></a></div><div class="pager" data-v-b4b63abf><a class="VPLink link pager-link next" href="/kano/guides/advanced-usage.html" data-v-b4b63abf><!--[--><span class="desc" data-v-b4b63abf>Next page</span><span class="title" data-v-b4b63abf>Advanced usage</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><footer class="VPFooter has-sidebar" data-v-9d8abc1e data-v-566314d4><div class="container" data-v-566314d4><!----><p class="copyright" data-v-566314d4>MIT Licensed | Copyright © 2017-20xx Kalisio</p></div></footer><!--[--><!--]--></div></div></div>
<script>window.__VP_HASH_MAP__=JSON.parse("{\"about_roadmap.md\":\"Tsa-l91W\",\"about_contributing.md\":\"Q-A41HE2\",\"about_license.md\":\"qdb0yiyt\",\"guides_getting-started.md\":\"6pc9104C\",\"guides_installing-services.md\":\"dsJfA9g8\",\"guides_understanding-kano.md\":\"kgvoQdRq\",\"about_contact.md\":\"MLWlmPcp\",\"index.md\":\"Xmx78NTg\",\"about_introduction.md\":\"ZchEHfVq\",\"guides_customizing-kano.md\":\"ZXzEQUud\",\"guides_installing-kano.md\":\"ju5qSgOm\",\"reference_api.md\":\"wWmT5Fzy\",\"guides_kano-api.md\":\"17wWu8Z6\",\"history.md\":\"N9EJmtb-\",\"reference_configuration.md\":\"H2fn7Ne6\",\"guides_advanced-usage.md\":\"3ZCPB6kF\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"Kano\",\"description\":\"A powerful real-time Geovisualizer\",\"base\":\"/kano/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"logo\":\"https://s3.eu-central-1.amazonaws.com/kalisioscope/kano/kano-icon-256x256.png\",\"domain\":\"dev.kalisio.xyz\",\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/kalisio/kano\"}],\"nav\":[{\"text\":\"About\",\"link\":\"/about/introduction\"},{\"text\":\"Guides\",\"link\":\"/guides/understanding-kano\"},{\"text\":\"Reference\",\"link\":\"/reference/configuration\"},{\"text\":\"History\",\"link\":\"/history\"}],\"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 Kano\",\"link\":\"/guides/understanding-kano\"},{\"text\":\"Getting Started\",\"link\":\"/guides/getting-started\"},{\"text\":\"Installing Kano\",\"link\":\"/guides/installing-kano\"},{\"text\":\"Customizing Kano\",\"link\":\"/guides/customizing-kano\"},{\"text\":\"Advanced usage\",\"link\":\"/guides/advanced-usage\"},{\"text\":\"Using the Kano API\",\"link\":\"/guides/kano-api\"},{\"text\":\"Installing Services\",\"link\":\"/guides/installing-services\"}],\"/reference/\":[{\"text\":\"Configuration\",\"link\":\"/reference/configuration\"},{\"text\":\"API\",\"link\":\"/reference/api\"}]},\"footer\":{\"copyright\":\"MIT Licensed | Copyright © 2017-20xx Kalisio\"},\"trustLogos\":[{\"imageLink\":\"https://s3.eu-central-1.amazonaws.com/kalisioscope/assets/logos/airbus.png\",\"link\":\"https://www.airbus.com/\"},{\"imageLink\":\"https://s3.eu-central-1.amazonaws.com/kalisioscope/assets/logos/irsn.png\",\"link\":\"https://www.irsn.fr/\"}],\"maps\":{\"jwt\":\"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJkZXYua2FsaXNpby54eXoiLCJpc3MiOiJrYWxpc2lvIn0.CGvJwPPkuiFvNzo3zUBb-_vwD0CKbUfm7w7TkCY-Ts4\"}},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":false}");</script>
<script>window.__VP_HASH_MAP__=JSON.parse("{\"about_license.md\":\"qdb0yiyt\",\"guides_understanding-kano.md\":\"kgvoQdRq\",\"reference_api.md\":\"wWmT5Fzy\",\"guides_customizing-kano.md\":\"ZXzEQUud\",\"history.md\":\"N9EJmtb-\",\"guides_kano-api.md\":\"17wWu8Z6\",\"about_contributing.md\":\"Q-A41HE2\",\"about_introduction.md\":\"ZchEHfVq\",\"about_roadmap.md\":\"Tsa-l91W\",\"guides_getting-started.md\":\"6pc9104C\",\"reference_configuration.md\":\"H2fn7Ne6\",\"about_contact.md\":\"MLWlmPcp\",\"guides_installing-services.md\":\"dsJfA9g8\",\"guides_installing-kano.md\":\"ju5qSgOm\",\"index.md\":\"Xmx78NTg\",\"guides_advanced-usage.md\":\"ar737nIi\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"Kano\",\"description\":\"A powerful real-time Geovisualizer\",\"base\":\"/kano/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"logo\":\"https://s3.eu-central-1.amazonaws.com/kalisioscope/kano/kano-icon-256x256.png\",\"domain\":\"dev.kalisio.xyz\",\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/kalisio/kano\"}],\"nav\":[{\"text\":\"About\",\"link\":\"/about/introduction\"},{\"text\":\"Guides\",\"link\":\"/guides/understanding-kano\"},{\"text\":\"Reference\",\"link\":\"/reference/configuration\"},{\"text\":\"History\",\"link\":\"/history\"}],\"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 Kano\",\"link\":\"/guides/understanding-kano\"},{\"text\":\"Getting Started\",\"link\":\"/guides/getting-started\"},{\"text\":\"Installing Kano\",\"link\":\"/guides/installing-kano\"},{\"text\":\"Customizing Kano\",\"link\":\"/guides/customizing-kano\"},{\"text\":\"Advanced usage\",\"link\":\"/guides/advanced-usage\"},{\"text\":\"Using the Kano API\",\"link\":\"/guides/kano-api\"},{\"text\":\"Installing Services\",\"link\":\"/guides/installing-services\"}],\"/reference/\":[{\"text\":\"Configuration\",\"link\":\"/reference/configuration\"},{\"text\":\"API\",\"link\":\"/reference/api\"}]},\"footer\":{\"copyright\":\"MIT Licensed | Copyright © 2017-20xx Kalisio\"},\"trustLogos\":[{\"imageLink\":\"https://s3.eu-central-1.amazonaws.com/kalisioscope/assets/logos/airbus.png\",\"link\":\"https://www.airbus.com/\"},{\"imageLink\":\"https://s3.eu-central-1.amazonaws.com/kalisioscope/assets/logos/irsn.png\",\"link\":\"https://www.irsn.fr/\"}],\"maps\":{\"jwt\":\"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJkZXYua2FsaXNpby54eXoiLCJpc3MiOiJrYWxpc2lvIn0.CGvJwPPkuiFvNzo3zUBb-_vwD0CKbUfm7w7TkCY-Ts4\"}},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":false}");</script>

</body>
</html>
2 changes: 1 addition & 1 deletion guides/getting-started.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion guides/installing-kano.html
Original file line number Diff line number Diff line change
Expand Up @@ -428,7 +428,7 @@
<span class="line"><span> }</span></span>
<span class="line"><span>]</span></span></code></pre></div></details><p>As detailed in the <a href="https://kalisio.github.io/kdk/guides/development/deploy.html#deployment-flavors" target="_blank" rel="noreferrer">KDK documentation</a> Kano comes into three different flavors. By default the helm chart targets the latest preproduction version (<code>test</code> tag) but you can change it to target either a development (<code>dev</code> tag) or a production (<code>prod</code> tag) release using the command line switch <code>--set image.tag=prod</code>.</p><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>By default no built-in layers are available in Kano unless you specify their names using the <code>LAYERS_FILTER</code> environment variable. By defining <code>LAYERS_FILTER=*</code> you will get all built-in layers but take care that a lot of them requires additional services to work correctly (read following sections below). You can however directly add new layers using the Kano GUI (through the add layer button or by drag&#39;n&#39;drop on the map).</p></div><div class="tip custom-block"><p class="custom-block-title">TIP</p><p>If you&#39;d like to use the 3D mode or the Mapillary layer you should provide the required tokens to access their respective APIs on the backend side by setting the following environment variables: <code>CESIUM_TOKEN</code>, <code>MAPILLARY_TOKEN</code>.</p></div><p>To uninstall the Kano environment:</p><div class="language-shell vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">shell</span><pre class="shiki shiki-themes github-light github-dark vp-code"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">kubectl</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> delete all --all -n tutorial</span></span>
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">kubectl</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> delete namespace tutorial</span></span></code></pre></div><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>Please note that it will not delete the associate PVC. If you want to remove it, use <code>kubectl delete pvc &lt;the_PVC_of_mongoDB_in_tutorial&gt;</code>.</p></div></div></div></main><footer class="VPDocFooter" data-v-e6f2a212 data-v-b4b63abf><!--[--><!--]--><!----><nav class="prev-next" data-v-b4b63abf><div class="pager" data-v-b4b63abf><a class="VPLink link pager-link prev" href="/kano/guides/getting-started.html" data-v-b4b63abf><!--[--><span class="desc" data-v-b4b63abf>Previous page</span><span class="title" data-v-b4b63abf>Getting Started</span><!--]--></a></div><div class="pager" data-v-b4b63abf><a class="VPLink link pager-link next" href="/kano/guides/customizing-kano.html" data-v-b4b63abf><!--[--><span class="desc" data-v-b4b63abf>Next page</span><span class="title" data-v-b4b63abf>Customizing Kano</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><footer class="VPFooter has-sidebar" data-v-9d8abc1e data-v-566314d4><div class="container" data-v-566314d4><!----><p class="copyright" data-v-566314d4>MIT Licensed | Copyright © 2017-20xx Kalisio</p></div></footer><!--[--><!--]--></div></div></div>
<script>window.__VP_HASH_MAP__=JSON.parse("{\"about_roadmap.md\":\"Tsa-l91W\",\"about_contributing.md\":\"Q-A41HE2\",\"about_license.md\":\"qdb0yiyt\",\"guides_getting-started.md\":\"6pc9104C\",\"guides_installing-services.md\":\"dsJfA9g8\",\"guides_understanding-kano.md\":\"kgvoQdRq\",\"about_contact.md\":\"MLWlmPcp\",\"index.md\":\"Xmx78NTg\",\"about_introduction.md\":\"ZchEHfVq\",\"guides_customizing-kano.md\":\"ZXzEQUud\",\"guides_installing-kano.md\":\"ju5qSgOm\",\"reference_api.md\":\"wWmT5Fzy\",\"guides_kano-api.md\":\"17wWu8Z6\",\"history.md\":\"N9EJmtb-\",\"reference_configuration.md\":\"H2fn7Ne6\",\"guides_advanced-usage.md\":\"3ZCPB6kF\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"Kano\",\"description\":\"A powerful real-time Geovisualizer\",\"base\":\"/kano/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"logo\":\"https://s3.eu-central-1.amazonaws.com/kalisioscope/kano/kano-icon-256x256.png\",\"domain\":\"dev.kalisio.xyz\",\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/kalisio/kano\"}],\"nav\":[{\"text\":\"About\",\"link\":\"/about/introduction\"},{\"text\":\"Guides\",\"link\":\"/guides/understanding-kano\"},{\"text\":\"Reference\",\"link\":\"/reference/configuration\"},{\"text\":\"History\",\"link\":\"/history\"}],\"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 Kano\",\"link\":\"/guides/understanding-kano\"},{\"text\":\"Getting Started\",\"link\":\"/guides/getting-started\"},{\"text\":\"Installing Kano\",\"link\":\"/guides/installing-kano\"},{\"text\":\"Customizing Kano\",\"link\":\"/guides/customizing-kano\"},{\"text\":\"Advanced usage\",\"link\":\"/guides/advanced-usage\"},{\"text\":\"Using the Kano API\",\"link\":\"/guides/kano-api\"},{\"text\":\"Installing Services\",\"link\":\"/guides/installing-services\"}],\"/reference/\":[{\"text\":\"Configuration\",\"link\":\"/reference/configuration\"},{\"text\":\"API\",\"link\":\"/reference/api\"}]},\"footer\":{\"copyright\":\"MIT Licensed | Copyright © 2017-20xx Kalisio\"},\"trustLogos\":[{\"imageLink\":\"https://s3.eu-central-1.amazonaws.com/kalisioscope/assets/logos/airbus.png\",\"link\":\"https://www.airbus.com/\"},{\"imageLink\":\"https://s3.eu-central-1.amazonaws.com/kalisioscope/assets/logos/irsn.png\",\"link\":\"https://www.irsn.fr/\"}],\"maps\":{\"jwt\":\"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJkZXYua2FsaXNpby54eXoiLCJpc3MiOiJrYWxpc2lvIn0.CGvJwPPkuiFvNzo3zUBb-_vwD0CKbUfm7w7TkCY-Ts4\"}},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":false}");</script>
<script>window.__VP_HASH_MAP__=JSON.parse("{\"about_license.md\":\"qdb0yiyt\",\"guides_understanding-kano.md\":\"kgvoQdRq\",\"reference_api.md\":\"wWmT5Fzy\",\"guides_customizing-kano.md\":\"ZXzEQUud\",\"history.md\":\"N9EJmtb-\",\"guides_kano-api.md\":\"17wWu8Z6\",\"about_contributing.md\":\"Q-A41HE2\",\"about_introduction.md\":\"ZchEHfVq\",\"about_roadmap.md\":\"Tsa-l91W\",\"guides_getting-started.md\":\"6pc9104C\",\"reference_configuration.md\":\"H2fn7Ne6\",\"about_contact.md\":\"MLWlmPcp\",\"guides_installing-services.md\":\"dsJfA9g8\",\"guides_installing-kano.md\":\"ju5qSgOm\",\"index.md\":\"Xmx78NTg\",\"guides_advanced-usage.md\":\"ar737nIi\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"Kano\",\"description\":\"A powerful real-time Geovisualizer\",\"base\":\"/kano/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"logo\":\"https://s3.eu-central-1.amazonaws.com/kalisioscope/kano/kano-icon-256x256.png\",\"domain\":\"dev.kalisio.xyz\",\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/kalisio/kano\"}],\"nav\":[{\"text\":\"About\",\"link\":\"/about/introduction\"},{\"text\":\"Guides\",\"link\":\"/guides/understanding-kano\"},{\"text\":\"Reference\",\"link\":\"/reference/configuration\"},{\"text\":\"History\",\"link\":\"/history\"}],\"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 Kano\",\"link\":\"/guides/understanding-kano\"},{\"text\":\"Getting Started\",\"link\":\"/guides/getting-started\"},{\"text\":\"Installing Kano\",\"link\":\"/guides/installing-kano\"},{\"text\":\"Customizing Kano\",\"link\":\"/guides/customizing-kano\"},{\"text\":\"Advanced usage\",\"link\":\"/guides/advanced-usage\"},{\"text\":\"Using the Kano API\",\"link\":\"/guides/kano-api\"},{\"text\":\"Installing Services\",\"link\":\"/guides/installing-services\"}],\"/reference/\":[{\"text\":\"Configuration\",\"link\":\"/reference/configuration\"},{\"text\":\"API\",\"link\":\"/reference/api\"}]},\"footer\":{\"copyright\":\"MIT Licensed | Copyright © 2017-20xx Kalisio\"},\"trustLogos\":[{\"imageLink\":\"https://s3.eu-central-1.amazonaws.com/kalisioscope/assets/logos/airbus.png\",\"link\":\"https://www.airbus.com/\"},{\"imageLink\":\"https://s3.eu-central-1.amazonaws.com/kalisioscope/assets/logos/irsn.png\",\"link\":\"https://www.irsn.fr/\"}],\"maps\":{\"jwt\":\"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJkZXYua2FsaXNpby54eXoiLCJpc3MiOiJrYWxpc2lvIn0.CGvJwPPkuiFvNzo3zUBb-_vwD0CKbUfm7w7TkCY-Ts4\"}},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":false}");</script>

</body>
</html>
Loading

0 comments on commit d16d177

Please sign in to comment.