Docs built from 3092259

guides/development/documentation.html

@@ -260,7 +260,7 @@
 <span class="line"><span>    class bahook,aahook,bfhook,afhook,bghook,aghook,bchook,achook,buhook,auhook,bphook,aphook,brhook,arhook hookClass</span></span>
 <span class="line"><span>    classDef operationClass fill:#9c6,stroke:#333,stroke-width:2px</span></span>
 <span class="line"><span>    class FIND,GET,CREATE,UPDATE,PATCH,REMOVE operationClass</span></span></code></pre></div></details><ol start="3"><li>output the SVG/PNG file in the root <strong>assets</strong> folder using <code>mmdc -i ./my-hooks-diagram.mmd -t neutral -b transparent -o my-hooks-diagram.svg</code></li><li>reference it in the documentation using a link like this <code>![My legend](https://raw.githubusercontent.com/kalisio/kdk/master/images/my-diagram.png)</code></li></ol><p>The template looks like this: <img src="/skeleton/assets/hooks-diagram-template.SHLdfxGX.png" alt="Hooks Diagram Template"></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="/skeleton/guides/development/publish.html" data-v-b4b63abf><!--[--><span class="desc" data-v-b4b63abf>Previous page</span><span class="title" data-v-b4b63abf>Publish your app</span><!--]--></a></div><div class="pager" data-v-b4b63abf><a class="VPLink link pager-link next" href="/skeleton/guides/development/kli.html" data-v-b4b63abf><!--[--><span class="desc" data-v-b4b63abf>Next page</span><span class="title" data-v-b4b63abf>Use our CLI</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><footer class="VPFooter has-sidebar" data-v-d8b57b2d 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_contributing.md\":\"DaBwupiH\",\"guides_development_develop.md\":\"A1DxEu63\",\"index.md\":\"ombm2Lpb\",\"guides_development_publish.md\":\"48YR4uQM\",\"about_contact.md\":\"TsBbwsM-\",\"guides_introduction.md\":\"pfjlqDtm\",\"guides_structure.md\":\"XiqKSLYa\",\"guides_installing.md\":\"fn0bbo5V\",\"guides_development_configure.md\":\"GmjOtnG3\",\"guides_development_troubleshooting.md\":\"CD4G6ckZ\",\"guides_development_setup.md\":\"yL-koYcX\",\"guides_howtos_service.md\":\"ZAJjJn9E\",\"guides_development_test.md\":\"GNylaDHf\",\"guides_development_tips.md\":\"9ZSFARmD\",\"about_introduction.md\":\"-Tjvuzlz\",\"guides_howtos_permissions.md\":\"wRL3j1KJ\",\"guides_development_kli.md\":\"VHqmYtvZ\",\"about_license.md\":\"6k8Ibrp-\",\"guides_development_deploy.md\":\"ITyFszW-\",\"guides_development_documentation.md\":\"2R7r-qfi\",\"guides_howtos_distribution.md\":\"T3EuH9rF\",\"guides_howtos_guards.md\":\"EB94kpXg\",\"guides_howtos_keycloak.md\":\"xDhBiD63\",\"guides_howtos_pwa.md\":\"FgHAw8dC\",\"guides_howtos_tours.md\":\"fYLD2lsv\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"Skeleton\",\"description\":\"Skeleton - KDK application template\",\"base\":\"/skeleton/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"logo\":\"https://s3.eu-central-1.amazonaws.com/kalisioscope/skeleton/skeleton-icon-color-2048x2048.png\",\"nav\":[{\"text\":\"About\",\"link\":\"/about/introduction\"},{\"text\":\"Guides\",\"link\":\"/guides/introduction\"}],\"sidebar\":{\"/about/\":[{\"text\":\"About\",\"link\":\"/about/introduction\"},{\"text\":\"Contributing\",\"link\":\"/about/contributing\"},{\"text\":\"License\",\"link\":\"/about/license\"},{\"text\":\"Contact\",\"link\":\"/about/contact\"}],\"/guides/\":[{\"text\":\"Introduction\",\"link\":\"/guides/introduction\"},{\"text\":\"Folder Structure\",\"link\":\"/guides/structure\"},{\"text\":\"Installation\",\"link\":\"/guides/installing\"},{\"text\":\"Development\",\"collapsed\":true,\"items\":[{\"text\":\"Setup your environment\",\"link\":\"/guides/development/setup\"},{\"text\":\"Develop your app\",\"link\":\"/guides/development/develop\"},{\"text\":\"Testing your app\",\"link\":\"/guides/development/test\"},{\"text\":\"Configure your app\",\"link\":\"/guides/development/configure\"},{\"text\":\"Deploy your app\",\"link\":\"/guides/development/deploy\"},{\"text\":\"Publish your app\",\"link\":\"/guides/development/publish\"},{\"text\":\"Document your app\",\"link\":\"/guides/development/documentation\"},{\"text\":\"Use our CLI\",\"link\":\"/guides/development/kli\"},{\"text\":\"Tips\",\"link\":\"/guides/development/tips\"},{\"text\":\"Troubleshooting\",\"link\":\"/guides/development/troubleshooting\"}]},{\"text\":\"Howtos\",\"collapsed\":true,\"items\":[{\"text\":\"Create a service\",\"link\":\"/guides/howtos/service\"},{\"text\":\"Distribute a service\",\"link\":\"/guides/howtos/distribution\"},{\"text\":\"Manage permissions\",\"link\":\"/guides/howtos/permissions\"},{\"text\":\"Add guards\",\"link\":\"/guides/howtos/guards\"},{\"text\":\"Manage collection\",\"link\":\"/guides/howtos/collection\"},{\"text\":\"Add tours\",\"link\":\"/guides/howtos/tours\"},{\"text\":\"Build a PWA\",\"link\":\"/guides/howtos/pwa\"},{\"text\":\"Connect to Keycloak\",\"link\":\"/guides/howtos/keycloak\"},{\"text\":\"Connect to a planet\",\"link\":\"/guides/howtos/planet\"}]}]},\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/kalisio/skeleton\"}],\"footer\":{\"copyright\":\"MIT Licensed | Copyright © 2017-20xx Kalisio\"}},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":false}");</script>
+    <script>window.__VP_HASH_MAP__=JSON.parse("{\"guides_introduction.md\":\"pfjlqDtm\",\"about_contact.md\":\"TsBbwsM-\",\"guides_howtos_guards.md\":\"EB94kpXg\",\"guides_development_tips.md\":\"9ZSFARmD\",\"guides_howtos_permissions.md\":\"wRL3j1KJ\",\"guides_installing.md\":\"fn0bbo5V\",\"guides_development_deploy.md\":\"ITyFszW-\",\"index.md\":\"ombm2Lpb\",\"guides_howtos_keycloak.md\":\"00P8b5nS\",\"about_license.md\":\"6k8Ibrp-\",\"guides_development_setup.md\":\"yL-koYcX\",\"guides_structure.md\":\"XiqKSLYa\",\"about_introduction.md\":\"-Tjvuzlz\",\"guides_development_publish.md\":\"48YR4uQM\",\"guides_howtos_tours.md\":\"fYLD2lsv\",\"guides_development_documentation.md\":\"2R7r-qfi\",\"guides_howtos_pwa.md\":\"FgHAw8dC\",\"guides_development_configure.md\":\"GmjOtnG3\",\"guides_development_kli.md\":\"VHqmYtvZ\",\"guides_development_develop.md\":\"A1DxEu63\",\"about_contributing.md\":\"DaBwupiH\",\"guides_development_test.md\":\"GNylaDHf\",\"guides_development_troubleshooting.md\":\"CD4G6ckZ\",\"guides_howtos_distribution.md\":\"T3EuH9rF\",\"guides_howtos_service.md\":\"ZAJjJn9E\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"Skeleton\",\"description\":\"Skeleton - KDK application template\",\"base\":\"/skeleton/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"logo\":\"https://s3.eu-central-1.amazonaws.com/kalisioscope/skeleton/skeleton-icon-color-2048x2048.png\",\"nav\":[{\"text\":\"About\",\"link\":\"/about/introduction\"},{\"text\":\"Guides\",\"link\":\"/guides/introduction\"}],\"sidebar\":{\"/about/\":[{\"text\":\"About\",\"link\":\"/about/introduction\"},{\"text\":\"Contributing\",\"link\":\"/about/contributing\"},{\"text\":\"License\",\"link\":\"/about/license\"},{\"text\":\"Contact\",\"link\":\"/about/contact\"}],\"/guides/\":[{\"text\":\"Introduction\",\"link\":\"/guides/introduction\"},{\"text\":\"Folder Structure\",\"link\":\"/guides/structure\"},{\"text\":\"Installation\",\"link\":\"/guides/installing\"},{\"text\":\"Development\",\"collapsed\":true,\"items\":[{\"text\":\"Setup your environment\",\"link\":\"/guides/development/setup\"},{\"text\":\"Develop your app\",\"link\":\"/guides/development/develop\"},{\"text\":\"Testing your app\",\"link\":\"/guides/development/test\"},{\"text\":\"Configure your app\",\"link\":\"/guides/development/configure\"},{\"text\":\"Deploy your app\",\"link\":\"/guides/development/deploy\"},{\"text\":\"Publish your app\",\"link\":\"/guides/development/publish\"},{\"text\":\"Document your app\",\"link\":\"/guides/development/documentation\"},{\"text\":\"Use our CLI\",\"link\":\"/guides/development/kli\"},{\"text\":\"Tips\",\"link\":\"/guides/development/tips\"},{\"text\":\"Troubleshooting\",\"link\":\"/guides/development/troubleshooting\"}]},{\"text\":\"Howtos\",\"collapsed\":true,\"items\":[{\"text\":\"Create a service\",\"link\":\"/guides/howtos/service\"},{\"text\":\"Distribute a service\",\"link\":\"/guides/howtos/distribution\"},{\"text\":\"Manage permissions\",\"link\":\"/guides/howtos/permissions\"},{\"text\":\"Add guards\",\"link\":\"/guides/howtos/guards\"},{\"text\":\"Manage collection\",\"link\":\"/guides/howtos/collection\"},{\"text\":\"Add tours\",\"link\":\"/guides/howtos/tours\"},{\"text\":\"Build a PWA\",\"link\":\"/guides/howtos/pwa\"},{\"text\":\"Connect to Keycloak\",\"link\":\"/guides/howtos/keycloak\"},{\"text\":\"Connect to a planet\",\"link\":\"/guides/howtos/planet\"}]}]},\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/kalisio/skeleton\"}],\"footer\":{\"copyright\":\"MIT Licensed | Copyright © 2017-20xx Kalisio\"}},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":false}");</script>
 
   </body>
 </html>

guides/development/kli.html

@@ -66,7 +66,7 @@
 <span class="line"><span>nvm use 16.0.0</span></span>
 <span class="line"><span>cd nodejs16</span></span>
 <span class="line"><span>kli workspace-nodejs16.js --link</span></span></code></pre></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="/skeleton/guides/development/documentation.html" data-v-b4b63abf><!--[--><span class="desc" data-v-b4b63abf>Previous page</span><span class="title" data-v-b4b63abf>Document your app</span><!--]--></a></div><div class="pager" data-v-b4b63abf><a class="VPLink link pager-link next" href="/skeleton/guides/development/tips.html" data-v-b4b63abf><!--[--><span class="desc" data-v-b4b63abf>Next page</span><span class="title" data-v-b4b63abf>Tips</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><footer class="VPFooter has-sidebar" data-v-d8b57b2d 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_contributing.md\":\"DaBwupiH\",\"guides_development_develop.md\":\"A1DxEu63\",\"index.md\":\"ombm2Lpb\",\"guides_development_publish.md\":\"48YR4uQM\",\"about_contact.md\":\"TsBbwsM-\",\"guides_introduction.md\":\"pfjlqDtm\",\"guides_structure.md\":\"XiqKSLYa\",\"guides_installing.md\":\"fn0bbo5V\",\"guides_development_configure.md\":\"GmjOtnG3\",\"guides_development_troubleshooting.md\":\"CD4G6ckZ\",\"guides_development_setup.md\":\"yL-koYcX\",\"guides_howtos_service.md\":\"ZAJjJn9E\",\"guides_development_test.md\":\"GNylaDHf\",\"guides_development_tips.md\":\"9ZSFARmD\",\"about_introduction.md\":\"-Tjvuzlz\",\"guides_howtos_permissions.md\":\"wRL3j1KJ\",\"guides_development_kli.md\":\"VHqmYtvZ\",\"about_license.md\":\"6k8Ibrp-\",\"guides_development_deploy.md\":\"ITyFszW-\",\"guides_development_documentation.md\":\"2R7r-qfi\",\"guides_howtos_distribution.md\":\"T3EuH9rF\",\"guides_howtos_guards.md\":\"EB94kpXg\",\"guides_howtos_keycloak.md\":\"xDhBiD63\",\"guides_howtos_pwa.md\":\"FgHAw8dC\",\"guides_howtos_tours.md\":\"fYLD2lsv\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"Skeleton\",\"description\":\"Skeleton - KDK application template\",\"base\":\"/skeleton/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"logo\":\"https://s3.eu-central-1.amazonaws.com/kalisioscope/skeleton/skeleton-icon-color-2048x2048.png\",\"nav\":[{\"text\":\"About\",\"link\":\"/about/introduction\"},{\"text\":\"Guides\",\"link\":\"/guides/introduction\"}],\"sidebar\":{\"/about/\":[{\"text\":\"About\",\"link\":\"/about/introduction\"},{\"text\":\"Contributing\",\"link\":\"/about/contributing\"},{\"text\":\"License\",\"link\":\"/about/license\"},{\"text\":\"Contact\",\"link\":\"/about/contact\"}],\"/guides/\":[{\"text\":\"Introduction\",\"link\":\"/guides/introduction\"},{\"text\":\"Folder Structure\",\"link\":\"/guides/structure\"},{\"text\":\"Installation\",\"link\":\"/guides/installing\"},{\"text\":\"Development\",\"collapsed\":true,\"items\":[{\"text\":\"Setup your environment\",\"link\":\"/guides/development/setup\"},{\"text\":\"Develop your app\",\"link\":\"/guides/development/develop\"},{\"text\":\"Testing your app\",\"link\":\"/guides/development/test\"},{\"text\":\"Configure your app\",\"link\":\"/guides/development/configure\"},{\"text\":\"Deploy your app\",\"link\":\"/guides/development/deploy\"},{\"text\":\"Publish your app\",\"link\":\"/guides/development/publish\"},{\"text\":\"Document your app\",\"link\":\"/guides/development/documentation\"},{\"text\":\"Use our CLI\",\"link\":\"/guides/development/kli\"},{\"text\":\"Tips\",\"link\":\"/guides/development/tips\"},{\"text\":\"Troubleshooting\",\"link\":\"/guides/development/troubleshooting\"}]},{\"text\":\"Howtos\",\"collapsed\":true,\"items\":[{\"text\":\"Create a service\",\"link\":\"/guides/howtos/service\"},{\"text\":\"Distribute a service\",\"link\":\"/guides/howtos/distribution\"},{\"text\":\"Manage permissions\",\"link\":\"/guides/howtos/permissions\"},{\"text\":\"Add guards\",\"link\":\"/guides/howtos/guards\"},{\"text\":\"Manage collection\",\"link\":\"/guides/howtos/collection\"},{\"text\":\"Add tours\",\"link\":\"/guides/howtos/tours\"},{\"text\":\"Build a PWA\",\"link\":\"/guides/howtos/pwa\"},{\"text\":\"Connect to Keycloak\",\"link\":\"/guides/howtos/keycloak\"},{\"text\":\"Connect to a planet\",\"link\":\"/guides/howtos/planet\"}]}]},\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/kalisio/skeleton\"}],\"footer\":{\"copyright\":\"MIT Licensed | Copyright © 2017-20xx Kalisio\"}},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":false}");</script>
+    <script>window.__VP_HASH_MAP__=JSON.parse("{\"guides_introduction.md\":\"pfjlqDtm\",\"about_contact.md\":\"TsBbwsM-\",\"guides_howtos_guards.md\":\"EB94kpXg\",\"guides_development_tips.md\":\"9ZSFARmD\",\"guides_howtos_permissions.md\":\"wRL3j1KJ\",\"guides_installing.md\":\"fn0bbo5V\",\"guides_development_deploy.md\":\"ITyFszW-\",\"index.md\":\"ombm2Lpb\",\"guides_howtos_keycloak.md\":\"00P8b5nS\",\"about_license.md\":\"6k8Ibrp-\",\"guides_development_setup.md\":\"yL-koYcX\",\"guides_structure.md\":\"XiqKSLYa\",\"about_introduction.md\":\"-Tjvuzlz\",\"guides_development_publish.md\":\"48YR4uQM\",\"guides_howtos_tours.md\":\"fYLD2lsv\",\"guides_development_documentation.md\":\"2R7r-qfi\",\"guides_howtos_pwa.md\":\"FgHAw8dC\",\"guides_development_configure.md\":\"GmjOtnG3\",\"guides_development_kli.md\":\"VHqmYtvZ\",\"guides_development_develop.md\":\"A1DxEu63\",\"about_contributing.md\":\"DaBwupiH\",\"guides_development_test.md\":\"GNylaDHf\",\"guides_development_troubleshooting.md\":\"CD4G6ckZ\",\"guides_howtos_distribution.md\":\"T3EuH9rF\",\"guides_howtos_service.md\":\"ZAJjJn9E\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"Skeleton\",\"description\":\"Skeleton - KDK application template\",\"base\":\"/skeleton/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"logo\":\"https://s3.eu-central-1.amazonaws.com/kalisioscope/skeleton/skeleton-icon-color-2048x2048.png\",\"nav\":[{\"text\":\"About\",\"link\":\"/about/introduction\"},{\"text\":\"Guides\",\"link\":\"/guides/introduction\"}],\"sidebar\":{\"/about/\":[{\"text\":\"About\",\"link\":\"/about/introduction\"},{\"text\":\"Contributing\",\"link\":\"/about/contributing\"},{\"text\":\"License\",\"link\":\"/about/license\"},{\"text\":\"Contact\",\"link\":\"/about/contact\"}],\"/guides/\":[{\"text\":\"Introduction\",\"link\":\"/guides/introduction\"},{\"text\":\"Folder Structure\",\"link\":\"/guides/structure\"},{\"text\":\"Installation\",\"link\":\"/guides/installing\"},{\"text\":\"Development\",\"collapsed\":true,\"items\":[{\"text\":\"Setup your environment\",\"link\":\"/guides/development/setup\"},{\"text\":\"Develop your app\",\"link\":\"/guides/development/develop\"},{\"text\":\"Testing your app\",\"link\":\"/guides/development/test\"},{\"text\":\"Configure your app\",\"link\":\"/guides/development/configure\"},{\"text\":\"Deploy your app\",\"link\":\"/guides/development/deploy\"},{\"text\":\"Publish your app\",\"link\":\"/guides/development/publish\"},{\"text\":\"Document your app\",\"link\":\"/guides/development/documentation\"},{\"text\":\"Use our CLI\",\"link\":\"/guides/development/kli\"},{\"text\":\"Tips\",\"link\":\"/guides/development/tips\"},{\"text\":\"Troubleshooting\",\"link\":\"/guides/development/troubleshooting\"}]},{\"text\":\"Howtos\",\"collapsed\":true,\"items\":[{\"text\":\"Create a service\",\"link\":\"/guides/howtos/service\"},{\"text\":\"Distribute a service\",\"link\":\"/guides/howtos/distribution\"},{\"text\":\"Manage permissions\",\"link\":\"/guides/howtos/permissions\"},{\"text\":\"Add guards\",\"link\":\"/guides/howtos/guards\"},{\"text\":\"Manage collection\",\"link\":\"/guides/howtos/collection\"},{\"text\":\"Add tours\",\"link\":\"/guides/howtos/tours\"},{\"text\":\"Build a PWA\",\"link\":\"/guides/howtos/pwa\"},{\"text\":\"Connect to Keycloak\",\"link\":\"/guides/howtos/keycloak\"},{\"text\":\"Connect to a planet\",\"link\":\"/guides/howtos/planet\"}]}]},\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/kalisio/skeleton\"}],\"footer\":{\"copyright\":\"MIT Licensed | Copyright © 2017-20xx Kalisio\"}},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":false}");</script>
 
   </body>
 </html>