Updates

nmshd · Aug 29, 2024 · 79fa59f · 79fa59f
1 parent 6a93f1f
commit 79fa59f
Show file tree

Hide file tree

Showing 305 changed files with 146,596 additions and 0 deletions.
diff --git a/versions/4/404.html b/versions/4/404.html
@@ -0,0 +1,301 @@
+<!doctype html>
+<!--
+  Minimal Mistakes Jekyll Theme 4.26.2 by Michael Rose
+  Copyright 2013-2024 Michael Rose - mademistakes.com | @mmistakes
+  Free for personal and commercial use under the MIT license
+  https://github.com/mmistakes/minimal-mistakes/blob/master/LICENSE
+-->
+
+<html lang="en" class="no-js">
+  <head>
+    <meta charset="utf-8">
+
+<!-- begin _includes/seo.html --><title>Page Not Found - enmeshed</title>
+<meta name="description" content="Page not found. Your pixels are in another canvas.">
+
+
+  <meta name="author" content="enmeshed Team">
+
+
+
+<meta property="og:type" content="website">
+<meta property="og:locale" content="en_US">
+<meta property="og:site_name" content="enmeshed">
+<meta property="og:title" content="Page Not Found">
+<meta property="og:url" content="/versions/4/404">
+
+
+  <meta property="og:description" content="Page not found. Your pixels are in another canvas.">
+
+
+
+
+
+
+
+
+
+
+
+
+<link rel="canonical" href="/versions/4/404">
+
+
+
+
+
+
+
+
+
+
+
+
+<!-- end _includes/seo.html -->
+
+
+
+  <link href="/versions/4/feed.xml" type="application/atom+xml" rel="alternate" title="enmeshed Feed">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+<script>
+  document.documentElement.className = document.documentElement.className.replace(/\bno-js\b/g, '') + ' js ';
+
+</script>
+
+<!-- For all browsers -->
+<link rel="stylesheet" href="/versions/4/assets/css/main.css">
+<link rel="preload" href="https://cdn.jsdelivr.net/npm/@fortawesome/fontawesome-free@latest/css/all.min.css" as="style" onload="this.onload=null;this.rel='stylesheet'">
+<noscript><link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@fortawesome/fontawesome-free@latest/css/all.min.css"></noscript>
+
+
+
+    <link href="/versions/4/assets/css/overwrite.css" rel="stylesheet" type="text/css" />
+
+<!-- The following lines are needed because otherwise Prism (the syntax highlighter RapiDoc uses) breaks Rouge (the syntax highlighter we use) -->
+<script>
+    window.Prism = window.Prism || {};
+    Prism.manual = true;
+</script>
+<script type="module" src="https://unpkg.com/rapidoc/dist/rapidoc-min.js"></script>
+
+
+<div id="banner">
+    This is the documentation for an unreleased version of enmeshed, which is currently in a non-stable beta status. Not what you are looking for?
+    <a href="/">Head over to the current version.</a>
+</div>
+
+
+  </head>
+
+  <body class="layout--single" dir="ltr">
+    <nav class="skip-links">
+  <ul>
+    <li><a href="#site-nav" class="screen-reader-shortcut">Skip to primary navigation</a></li>
+    <li><a href="#main" class="screen-reader-shortcut">Skip to content</a></li>
+    <li><a href="#footer" class="screen-reader-shortcut">Skip to footer</a></li>
+  </ul>
+</nav>
+
+
+
+<div class="masthead">
+  <div class="masthead__inner-wrap">
+    <div class="masthead__menu">
+      <nav id="site-nav" class="greedy-nav">
+
+        <a class="site-title" href="/versions/4/">
+          enmeshed
+
+        </a>
+        <ul class="visible-links"><li class="masthead__menu-item">
+              <a
+                href="/versions/4/use"
+
+
+              >Use</a>
+            </li><li class="masthead__menu-item">
+              <a
+                href="/versions/4/explore"
+
+
+              >Explore</a>
+            </li><li class="masthead__menu-item">
+              <a
+                href="/versions/4/integrate"
+
+
+              >Integrate</a>
+            </li><li class="masthead__menu-item">
+              <a
+                href="/versions/4/operate"
+
+
+              >Operate</a>
+            </li><li class="masthead__menu-item">
+              <a
+                href="/versions/4/contribute"
+
+
+              >Contribute</a>
+            </li><li class="masthead__menu-item">
+              <a
+                href="/versions/4/blog"
+
+
+              >Blog</a>
+            </li></ul>
+
+        <button class="search__toggle" type="button">
+          <span class="visually-hidden">Toggle search</span>
+          <i class="fas fa-search"></i>
+        </button>
+
+        <button class="greedy-nav__toggle hidden" type="button">
+          <span class="visually-hidden">Toggle menu</span>
+          <div class="navicon"></div>
+        </button>
+        <ul class="hidden-links hidden"></ul>
+      </nav>
+    </div>
+  </div>
+</div>
+
+
+    <div class="initial-content">
+
+
+
+
+
+
+<div id="main" role="main">
+
+
+
+  <article class="page" itemscope itemtype="https://schema.org/CreativeWork">
+    <meta itemprop="headline" content="Page Not Found">
+    <meta itemprop="description" content="Page not found. Your pixels are in another canvas.">
+
+
+
+    <div class="page__inner-wrap">
+
+        <header>
+          <h1 id="page-title" class="page__title" itemprop="headline">
+            <a href="/versions/4/404" itemprop="url">Page Not Found
+</a>
+          </h1>
+
+
+
+        </header>
+
+
+      <section class="page__content" itemprop="text">
+
+        <p>Sorry, but the page you were trying to view does not exist.</p>
+
+
+      </section>
+
+      <footer class="page__meta">
+
+
+
+
+
+
+      </footer>
+
+
+
+
+    </div>
+
+
+  </article>
+
+
+
+</div>
+
+
+    </div>
+
+
+      <div class="search-content">
+        <div class="search-content__inner-wrap"><form class="search-content__form" onkeydown="return event.key != 'Enter';" role="search">
+    <label class="sr-only" for="search">
+      Enter your search term...
+    </label>
+    <input type="search" id="search" class="search-input" tabindex="-1" placeholder="Enter your search term..." />
+  </form>
+  <div id="results" class="results"></div></div>
+
+      </div>
+
+
+    <div id="footer" class="page__footer">
+      <footer>
+        <!-- start custom footer snippets -->
+
+<!-- end custom footer snippets -->
+        <div class="page__footer-follow">
+    <ul class="social-icons">
+
+        <li>
+            <a href="/legal" rel="nofollow noopener noreferrer"><i class="fas fa-fw fa-info" aria-hidden="true"></i> Legal Disclosure</a>
+        </li>
+
+        <li>
+            <a href="/privacy" rel="nofollow noopener noreferrer"><i class="fas fa-fw fa-user-shield" aria-hidden="true"></i> Privacy Statement</a>
+        </li>
+
+        <li>
+            <a href="https://www.enmeshed.eu" rel="nofollow noopener noreferrer"><i class="fas fa-fw fa-link" aria-hidden="true"></i> Website</a>
+        </li>
+
+        <li>
+            <a href="https://github.com/nmshd" rel="nofollow noopener noreferrer"><i class="fab fa-fw fa-github" aria-hidden="true"></i> GitHub</a>
+        </li>
+
+        <li>
+            <a href="https://www.npmjs.com/search?q=%40nmshd" rel="nofollow noopener noreferrer"><i class="fab fa-fw fa-npm" aria-hidden="true"></i> NPM</a>
+        </li>
+
+        <li>
+            <a href="/versions/4/feed.xml"
+                ><i class="fas fa-fw fa-rss-square" aria-hidden="true"></i> Feed</a
+            >
+        </li>
+
+    </ul>
+</div>
+
+<div class="page__footer-copyright">
+    &copy; 2024
+    <a href="https://www.js-soft.com">j&amp;s-soft GmbH</a>. Powered by
+    <a href="https://jekyllrb.com" rel="nofollow">Jekyll</a> &amp; <a href="https://mademistakes.com/work/minimal-mistakes-jekyll-theme/" rel="nofollow">Minimal Mistakes</a>.
+</div>
+
+      </footer>
+    </div>
+
+
+  <script src="/versions/4/assets/js/main.min.js"></script>
+
+
+
+
+<script src="/versions/4/assets/js/lunr/lunr.min.js"></script>
+<script src="/versions/4/assets/js/lunr/lunr-store.js"></script>
+<script src="/versions/4/assets/js/lunr/lunr-en.js"></script>
+
+
+
+
+
+
+  </body>
+</html>
diff --git a/versions/4/CNAME b/versions/4/CNAME
@@ -0,0 +1 @@
+enmeshed.eu
diff --git a/versions/4/README.md b/versions/4/README.md
@@ -0,0 +1,73 @@
+# documentation
+
+This is the source code of the enmeshed documentation hosted at [enmeshed.eu](https://enmeshed.eu).
+
+## Purpose of this documentation
+
+This documentation is meant as an overarching documentation for the whole enmeshed open source project. It describes overarching concepts whereas the individual repositories provide technical documentation for the respective source code or functionality.
+
+## Documentation guidelines
+
+- So far, English only
+- Keep it simple
+- Think about the audience
+- Links to other pages of the documentation are rendered using jekyll's liquid:
+  `{% link {path_to_file} %}#{fragment_identifier}`
+
+## Contribute to the documentation
+
+The documentation itself uses GitHub pages and thus `jekyll` as the technical framework.  
+The preferred way of setting up a local "instance" of the environment is via a so-called "Development Container" in VS Code:
+
+VSCode
+JavaScript
+
+Install:
+
+- [Visual Studio Code](https://code.visualstudio.com/)
+- [Dev Containers Extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
+- [Docker](https://code.visualstudio.com/docs/remote/containers)
+
+Then in VS Code, clone the repository with the command _[Dev Containers: Clone Repository in Container Volume...](https://code.visualstudio.com/docs/remote/containers-advanced#_use-clone-repository-in-container-volume)_
+
+This will
+
+- Clone the Repository in a Container Volume
+- Build the Docker Image
+- Start the Docker Container and map the required ports
+- Mount the created Container Volume
+- Install the required npm packages
+- Install the required ruby gems
+
+Finally, open the `Terminal` in VS Code (it is attached to the running Development Container), and start the "instance":
+
+```shell
+bundle exec jekyll serve --livereload
+```
+
+Alternatively, you can use the predefined VS Code Tasks
+
+- `Serve` &rarr; see above
+- `Build` &rarr; build the jekyll site
+
+## update dependencies
+
+You can update dependencies using the command `bundle update`.
+
+## regenerate diagrams
+
+execute
+
+```shell
+java -jar puml.jar _docs_integrate/diagrams/*.pu -o "$PWD/assets/diagrams/integrate"
+
+```
+
+## regenerate header
+
+1. add excel file to root directory
+2. execute script
+
+```shell
+npx ts-node scripts/update.ts
+```