Merge pull request #37 from datasharingframework/v1.4.0

added documentation for DSF 1.4.0

docs/src/.vuepress/theme.ts

@@ -39,7 +39,7 @@ export default hopeTheme({
       prefix: "/stable/",
       children: [
         {
-          text: "Guideline v1.3.2 (stable)",
+          text: "Guideline v1.4.0 (stable)",
           icon: "info",
           children: ["index", "maintain/install", "maintain/upgrade-from-0", "maintain/allowList-mgm", "maintain/install-plugins", "develop/create"],
         }
@@ -62,7 +62,7 @@ export default hopeTheme({
     text: "Versions",
     icon: "note",
     // children:["/v1/"],
-    children: [{ text: "v1.3.2 (stable)", link: "/stable/" }, { text: "v1.3.1", link: "/v1.3.1/" }, { text: "v1.3.0", link: "/v1.3.0/" }, { text: "v1.2.0", link: "/v1.2.0/" }, { text: "v1.1.0", link: "/v1.1.0/" }, { text: "v1.0.0", link: "/v1.0.0/" }, { text: "v0.9.3 (oldstable)", link: "/oldstable/"}],
+    children: [{ text: "v1.4.0 (stable)", link: "/stable/" }, { text: "v1.3.2", link: "/v1.3.2/" }, { text: "v1.3.1", link: "/v1.3.1/" }, { text: "v1.3.0", link: "/v1.3.0/" }, { text: "v1.2.0", link: "/v1.2.0/" }, { text: "v1.1.0", link: "/v1.1.0/" }, { text: "v1.0.0", link: "/v1.0.0/" }, { text: "v0.9.3 (oldstable)", link: "/oldstable/"}],
   },
   {
     text: "",
@@ -171,7 +171,7 @@ export default hopeTheme({
       children: ["create", "upgrade-from-0" ],
     },
   ],
-  "/v1.3.2/": [
+  "/v1.4.0/": [
     {
       text: "Home",
       icon: "home",
@@ -236,6 +236,75 @@ export default hopeTheme({
       children: ["create", "upgrade-from-0" ],
     },
   ],
+  "/v1.3.2/": [
+    {
+      text: "Home",
+      icon: "home",
+      link: "/",
+    },
+    {
+      text: "Current version",
+      icon: "update",
+      link: "/stable",
+    },
+    {
+      text: "Maintain a DSF instance",
+      icon: "tool",
+      prefix: "maintain/",
+      link: "maintain/",
+      children: ["install", "upgrade-from-1", "upgrade-from-0", "allowList-mgm", {
+        text: "FHIR Reverse Proxy",
+        icon: "module",
+        prefix: "fhir-reverse-proxy/",
+        link: "fhir-reverse-proxy/",
+        children: [{
+			icon: "config", 
+			text: "Configuration",
+			link: "configuration"
+		}]
+      }, {
+        text: "FHIR Server",
+        icon: "module",
+        prefix: "fhir/",
+        link: "fhir/",
+        children: [{
+			icon: "config", 
+			text: "Configuration",
+			link: "configuration"
+		}, {
+			icon: "config",
+			text: "Access Control",
+			link: "access-control"
+		}, {
+			icon: "config",
+			text: "OpenID Connect",
+			link: "oidc"
+			}]
+      }, {
+        text: "BPE Server",
+        icon: "module",
+        prefix: "bpe/",
+        link: "bpe/",
+        children: [{
+			icon: "config", 
+			text: "Configuration",
+			link: "configuration"
+		}]
+      },
+      {
+        text: "Install Plugins",
+        icon: "plugin",
+        link: "install-plugins"
+    }],
+    },
+    {
+      text: "Develop process plugins",
+      icon: "plugin",
+      prefix: "develop/",
+      link: "develop/",
+      children: ["create", "upgrade-from-0" ],
+    },
+  ],
   "/v1.3.1/": [
     {
       text: "Home",
@@ -246,7 +315,8 @@ export default hopeTheme({
       text: "Current version",
       icon: "update",
       link: "/stable",
-    },    {
+    },
+    {
       text: "Maintain a DSF instance",
       icon: "tool",
       prefix: "maintain/",

docs/src/stable

@@ -1 +1 @@
-v1.3.2
+v1.4.0

docs/src/v1.4.0/develop/README.md

@@ -0,0 +1,7 @@
+---
+title: Develop Process Plugins
+icon: plugin
+---
+## Overview
+- [Create a new process plugin](create)
+- [Upgrade processes from 0.9.x](upgrade-from-0)

docs/src/v1.4.0/develop/create.md

@@ -0,0 +1,10 @@
+---
+title: Create a new process plugin
+icon: code
+---
+::: tip Work in progress
+We are currently in the process of updating the written documentation on how to create a DSF process plugin. In the meantime we recommend to study the oldstable version of the [process plugin tutorial](/oldstable/tutorial/). Additionally, we recommend to take a look at the upgraded DSF processes here:
+- The [hello world plugin](https://github.com/datasharingframework/dsf-process-hello-world)
+- The [ping pong plugin](https://github.com/datasharingframework/dsf-process-ping-pong)
+- The [update allowlist plugin](https://github.com/datasharingframework/dsf-process-allow-list)
+:::

docs/src/v1.4.0/develop/upgrade-from-0.md

@@ -0,0 +1,10 @@
+---
+title: Upgrade processes from 0.9.x
+icon: update
+---
+::: tip Work in progress
+We are currently in the process of updating the written documentation on how to upgrade a DSF process plugin to DSF 1.0.0. In the meantime we recommend to take a look at the provided sample plugin and the upgraded DSF plugins:
+- The [hello world plugin](https://github.com/datasharingframework/dsf-process-hello-world)
+- The [ping pong plugin](https://github.com/datasharingframework/dsf-process-ping-pong)
+- The [update allowlist plugin](https://github.com/datasharingframework/dsf-process-allow-list)
+:::

docs/src/v1.4.0/dsf-for-dev.md

@@ -0,0 +1,4 @@
+---
+title: DSF for Developers
+icon: info
+---

docs/src/v1.4.0/index.md

@@ -0,0 +1,31 @@
+---
+title: DSF 1.4.0
+icon: guide
+---
+
+Data Sharing Framework 1.x is the new major release of the Data Sharing Framework. Click [here](/intro/) to find more information about the DSF in general.
+::: tip Important note
+This is a major DSF release not compatible with 0.9.x and older version developed at https://github.com/highmed/highmed-dsf.
+:::
+
+# System Administrators
+
+- [Upgrade from DSF 0.9.x.](maintain/upgrade-from-0)
+- [Upgrade from DSF 1.3.2](maintain/upgrade-from-1)
+- [Install DSF 1.4.0](maintain/install)
+
+
+# Developers
+- [Create a new process plugin](develop/create)
+- [Upgrade from DSF 0.9.x.](develop/upgrade-from-0)
+
+## New features
+- Improved versioning to support up- and downwards-compatibility
+- Enhanced web ui to start processes in the web browser
+- Allow local user authentication and authorization with OpenID Connect
+- New process plugin API
+- Removed mostly unused features to simplify instance configuration
+- Unified proxy setup
+- Many more features, see [1.x release-notes](https://github.com/datasharingframework/dsf/releases)
+
+

docs/src/v1.4.0/maintain/README.md

@@ -0,0 +1,16 @@
+---
+title: Maintain a DSF instance
+icon: tool
+---
+## Overview
+- [Install DSF 1.4.0](install)
+- [Upgrade from DSF 0.9.x](upgrade-from-0)
+- [Allow List Management](allowList-mgm)
+- FHIR Reverse Proxy
+  - [Configuration Parameters](fhir-reverse-proxy/configuration)
+- FHIR Server
+  - [Configuration Parameters](fhir/configuration)
+  - [Access Control](fhir/access-control)
+  - [OpenID Connect](fhir/oidc)
+- BPE Server
+  - [Configuration Parameters](bpe/configuration)

docs/src/v1.4.0/maintain/allowList-mgm.md

@@ -0,0 +1,34 @@
+---
+title: Allow List Management
+icon: share
+---
+You can read all about the concept of Allow Lists [in our introduction](/intro/info/allowList.md).
+
+## Overview
+To simplify the DSF Allow List Management we have built a portal for administration. The portal is managed by the GECKO Institute at Heilbronn University. You as an DSF administrator can create or update your Allow List information. The information you provide on this portal will be transferred to us and will be used to built Allow List bundles that get distributed to the communication partners of the distributed processes. 
+
+The DSF Allow List management tool uses client certificates for authentication. You can either use a personal client certificate or the client certificate from your DSF BPE, which needs to be added to your web-browsers certificate store.
+
+
+## Prerequisites
+1. Deployed DSF instance (test or production infrastructure)
+    1.1  If none exists yet, read [the installation guide](install)
+2. Certificate 
+    2.1  If none exists yet, read [the certificate requirements](install#client-server-certificates)
+3. Organization identifier, shortest FQDN of your organizations website, e.g. `my-hospital.de`
+4. FHIR endpoint URL, e.g. `https://dsf.my-hospital.de/fhir`
+5. Contact details from a responsible person of your organization
+6. Access to the E-Mail address from your organization for verification 
+
+
+## Start here
+When you have fulfilled all the prerequisites, you can start managing your Allow Lists via the environment specific Allow List Management Tool:
+
+- [**Test** infrastructure](https://allowlist-test.gecko.hs-heilbronn.de)
+- [**Production** infrastructure](https://allowlist.gecko.hs-heilbronn.de)
+
+We use different highlight colors for the DSF Allow List Management Tool: Green for the **Test** environment and blue for the **Production** infrastructure. To access the site, you have to authenticate yourself with a client certificate. Your web-browser will show a dialog to choose a valid certificate.
+
+::: tip Ideas for improvement?
+Have you found an error or is something unclear to you? Then please feel free to contact us on the <a href="https://mii.zulipchat.com/#narrow/stream/392426-Data-Sharing-Framework-.28DSF.29">MII-Zulip Channel</a> or write us at <a href="mailto:dsf-gecko@hs-heilbronn.de">gth-gecko@hs-heilbronn.de</a>. Thank you very much!
+:::

docs/src/v1.4.0/maintain/bpe/README.md

@@ -0,0 +1,6 @@
+---
+title: BPE Server
+icon: module
+---
+## Overview
+- [Configuration Parameters](configuration)