diff --git a/docs/src/.vuepress/sidebar/operations-v1.ts b/docs/src/.vuepress/sidebar/operations-v1.ts index 27e1c9ed2..95778edf3 100644 --- a/docs/src/.vuepress/sidebar/operations-v1.ts +++ b/docs/src/.vuepress/sidebar/operations-v1.ts @@ -2,11 +2,11 @@ export function generate_v1_latest_sidebar() { return [ { - text: "Maintain a DSF instance", + text: "Get Started", icon: "tool", - prefix: "maintain/", - link: "maintain/", - children: ["install", "upgrade-from-1", "upgrade-from-0", "allowList-mgm", "root-certificates", "passwords-secrets", { + link: "./", + }, + "install", "upgrade-from-1", "upgrade-from-0", "allowList-mgm", "root-certificates", "passwords-secrets", { text: "FHIR Reverse Proxy", icon: "module", prefix: "fhir-reverse-proxy/", @@ -67,9 +67,7 @@ export function generate_v1_latest_sidebar() { text: "Install Plugins", icon: "plugin", link: "install-plugins" - }], - }, - ]; + }] } @@ -77,11 +75,12 @@ export function generate_v1_gt_eq_1_7_0_sidebar() { return [ { - text: "Maintain a DSF instance", + text: "Get Started", icon: "tool", - prefix: "maintain/", - link: "maintain/", - children: ["install", "upgrade-from-1", "upgrade-from-0", "allowList-mgm", "root-certificates", "passwords-secrets", { + link: "./" + + }, + "install", "upgrade-from-1", "upgrade-from-0", "allowList-mgm", "root-certificates", "passwords-secrets", { text: "FHIR Reverse Proxy", icon: "module", prefix: "fhir-reverse-proxy/", @@ -142,20 +141,17 @@ export function generate_v1_gt_eq_1_7_0_sidebar() { text: "Install Plugins", icon: "plugin", link: "install-plugins" - }], - } - ]; + }] } export function generate_v1_gt_eq_1_5_0_sidebar() { return [ { - text: "Maintain a DSF instance", + text: "Get Started", icon: "tool", - prefix: "maintain/", - link: "maintain/", - children: ["install", "upgrade-from-1", "upgrade-from-0", "allowList-mgm", { + link: "./", + }, "install", "upgrade-from-1", "upgrade-from-0", "allowList-mgm", { text: "FHIR Reverse Proxy", icon: "module", prefix: "fhir-reverse-proxy/", @@ -216,16 +212,8 @@ export function generate_v1_gt_eq_1_5_0_sidebar() { text: "Install Plugins", icon: "plugin", link: "install-plugins" - }], }, - { - text: "Develop process plugins", - icon: "plugin", - prefix: "develop/", - link: "develop/", - children: ["create", "upgrade-from-0" ], - }, - ]; + ] } @@ -233,11 +221,10 @@ export function generate_v1_gt_eq_1_0_0_sidebar() { return [ { - text: "Maintain a DSF instance", + text: "Get Started", icon: "tool", - prefix: "maintain/", - link: "maintain/", - children: ["install", "upgrade-from-1", "upgrade-from-0", "allowList-mgm", { + link: "./", + }, "install", "upgrade-from-1", "upgrade-from-0", "allowList-mgm", { text: "FHIR Reverse Proxy", icon: "module", prefix: "fhir-reverse-proxy/", @@ -280,14 +267,6 @@ export function generate_v1_gt_eq_1_0_0_sidebar() { text: "Install Plugins", icon: "plugin", link: "install-plugins" - }], - }, - { - text: "Develop process plugins", - icon: "plugin", - prefix: "develop/", - link: "develop/", - children: ["create", "upgrade-from-0" ], }, ]; } \ No newline at end of file diff --git a/docs/src/.vuepress/styles/index.scss b/docs/src/.vuepress/styles/index.scss index c3cd8ebac..5e818b22b 100644 --- a/docs/src/.vuepress/styles/index.scss +++ b/docs/src/.vuepress/styles/index.scss @@ -36,4 +36,12 @@ h1, h2, h3, h4, h5 { .page-category-item { color: black !important; background: #63C7A6 !important; +} + +.vp-sidebar > .vp-sidebar-links > li > .vp-sidebar-link { + line-height: 0.8em; +} + +.vp-sidebar { + font-size: 85%; } \ No newline at end of file diff --git a/docs/src/.vuepress/theme.ts b/docs/src/.vuepress/theme.ts index 49a921f0c..30414205e 100644 --- a/docs/src/.vuepress/theme.ts +++ b/docs/src/.vuepress/theme.ts @@ -37,22 +37,7 @@ export default hopeTheme({ text: "Process Development", icon: "plugin", prefix: "/process-development/", - children: [ - { - text: "API v1", - children: [ - "api-v1/readme.md", - "api-v1/get-started.md" - ] - }, - { - text: "API v2", - children: [ - "api-v2/readme.md", - "api-v2/get-started.md" - ] - } - ] + children: [ "api-v1/", "api-v2/" ] }, { text: "DSF Development", diff --git a/docs/src/explore/concepts/allow-list.md b/docs/src/explore/concepts/allow-list.md index 8b1515515..30b23752a 100644 --- a/docs/src/explore/concepts/allow-list.md +++ b/docs/src/explore/concepts/allow-list.md @@ -12,6 +12,6 @@ The Allow List consists of Organization-, Endpoint- and OrganisationAffiliation- ![Architecture](/photos/info/allowList/allowList-architecture.png) ## Allow List Managment -[Here](/operations/latest/maintain/allowList-mgm.md) you can read all the information if you want to create or update an Allow List. +[Here](/operations/latest/allowList-mgm.md) you can read all the information if you want to create or update an Allow List. If you have the need for allowlist management feel free to contact us via E-Mail (dsf-gecko@hs-heilbronn.de) and we will take care of your request as soon as possible. \ No newline at end of file diff --git a/docs/src/operations/v1.0.0/maintain/allowList-mgm.md b/docs/src/operations/v1.0.0/allowList-mgm.md similarity index 100% rename from docs/src/operations/v1.0.0/maintain/allowList-mgm.md rename to docs/src/operations/v1.0.0/allowList-mgm.md diff --git a/docs/src/operations/v1.0.0/maintain/configuration/README.md b/docs/src/operations/v1.0.0/configuration/README.md similarity index 100% rename from docs/src/operations/v1.0.0/maintain/configuration/README.md rename to docs/src/operations/v1.0.0/configuration/README.md diff --git a/docs/src/operations/v1.0.0/maintain/configuration/bpe.md b/docs/src/operations/v1.0.0/configuration/bpe.md similarity index 100% rename from docs/src/operations/v1.0.0/maintain/configuration/bpe.md rename to docs/src/operations/v1.0.0/configuration/bpe.md diff --git a/docs/src/operations/v1.0.0/maintain/configuration/common.md b/docs/src/operations/v1.0.0/configuration/common.md similarity index 100% rename from docs/src/operations/v1.0.0/maintain/configuration/common.md rename to docs/src/operations/v1.0.0/configuration/common.md diff --git a/docs/src/operations/v1.0.0/maintain/configuration/fhir.md b/docs/src/operations/v1.0.0/configuration/fhir.md similarity index 100% rename from docs/src/operations/v1.0.0/maintain/configuration/fhir.md rename to docs/src/operations/v1.0.0/configuration/fhir.md diff --git a/docs/src/operations/v1.0.0/maintain/configuration/reverseproxy.md b/docs/src/operations/v1.0.0/configuration/reverseproxy.md similarity index 100% rename from docs/src/operations/v1.0.0/maintain/configuration/reverseproxy.md rename to docs/src/operations/v1.0.0/configuration/reverseproxy.md diff --git a/docs/src/operations/v1.0.0/develop/README.md b/docs/src/operations/v1.0.0/develop/README.md deleted file mode 100644 index 7c7613cb5..000000000 --- a/docs/src/operations/v1.0.0/develop/README.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Develop Process Plugins -icon: plugin ---- -## Overview -- [Create a new process plugin](create) -- [Upgrade processes from 0.9.x](upgrade-from-0) \ No newline at end of file diff --git a/docs/src/operations/v1.0.0/develop/create.md b/docs/src/operations/v1.0.0/develop/create.md deleted file mode 100644 index 19231a57e..000000000 --- a/docs/src/operations/v1.0.0/develop/create.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -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/guideline/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/tree/develop) -- The [ping pong plugin](https://github.com/datasharingframework/dsf-process-ping-pong) -- The [update allowlist plugin](https://github.com/datasharingframework/dsf-process-allow-list) -::: \ No newline at end of file diff --git a/docs/src/operations/v1.0.0/develop/upgrade-from-0.md b/docs/src/operations/v1.0.0/develop/upgrade-from-0.md deleted file mode 100644 index a8f2bdcd7..000000000 --- a/docs/src/operations/v1.0.0/develop/upgrade-from-0.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -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/tree/develop) -- The [ping pong plugin](https://github.com/datasharingframework/dsf-process-ping-pong) -- The [update allowlist plugin](https://github.com/datasharingframework/dsf-process-allow-list) -::: \ No newline at end of file diff --git a/docs/src/operations/v1.0.0/index.md b/docs/src/operations/v1.0.0/index.md index dfbbf43d7..6c46285a8 100644 --- a/docs/src/operations/v1.0.0/index.md +++ b/docs/src/operations/v1.0.0/index.md @@ -10,14 +10,10 @@ This is a major DSF release not compatible with 0.9.x and older version develope # System Administrators -- [Upgrade from DSF 0.9.x.](maintain/upgrade-from-0) -- [Install DSF 1.0.0](maintain/install) +- [Upgrade from DSF 0.9.x.](upgrade-from-0) +- [Install DSF 1.0.0](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 diff --git a/docs/src/operations/v1.0.0/maintain/install.md b/docs/src/operations/v1.0.0/install.md similarity index 100% rename from docs/src/operations/v1.0.0/maintain/install.md rename to docs/src/operations/v1.0.0/install.md diff --git a/docs/src/operations/v1.0.0/maintain/README.md b/docs/src/operations/v1.0.0/maintain/README.md deleted file mode 100644 index e695ec745..000000000 --- a/docs/src/operations/v1.0.0/maintain/README.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Maintain a DSF instance -icon: tool ---- -## Overview -- [Install DSF 1.0.0](install) -- [Upgrade from DSF 0.9.x](upgrade-from-0) -- [Allow List Management](allowList-mgm) -- [Configuration Paramters](configuration/) diff --git a/docs/src/operations/v1.0.0/maintain/upgrade-from-0.md b/docs/src/operations/v1.0.0/upgrade-from-0.md similarity index 100% rename from docs/src/operations/v1.0.0/maintain/upgrade-from-0.md rename to docs/src/operations/v1.0.0/upgrade-from-0.md diff --git a/docs/src/operations/v1.0.0/maintain/upgrade-from-1.md b/docs/src/operations/v1.0.0/upgrade-from-1.md similarity index 100% rename from docs/src/operations/v1.0.0/maintain/upgrade-from-1.md rename to docs/src/operations/v1.0.0/upgrade-from-1.md diff --git a/docs/src/operations/v1.1.0/maintain/allowList-mgm.md b/docs/src/operations/v1.1.0/allowList-mgm.md similarity index 100% rename from docs/src/operations/v1.1.0/maintain/allowList-mgm.md rename to docs/src/operations/v1.1.0/allowList-mgm.md diff --git a/docs/src/operations/v1.1.0/maintain/bpe/README.md b/docs/src/operations/v1.1.0/bpe/README.md similarity index 100% rename from docs/src/operations/v1.1.0/maintain/bpe/README.md rename to docs/src/operations/v1.1.0/bpe/README.md diff --git a/docs/src/operations/v1.1.0/maintain/bpe/configuration.md b/docs/src/operations/v1.1.0/bpe/configuration.md similarity index 100% rename from docs/src/operations/v1.1.0/maintain/bpe/configuration.md rename to docs/src/operations/v1.1.0/bpe/configuration.md diff --git a/docs/src/operations/v1.1.0/develop/README.md b/docs/src/operations/v1.1.0/develop/README.md deleted file mode 100644 index 7c7613cb5..000000000 --- a/docs/src/operations/v1.1.0/develop/README.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Develop Process Plugins -icon: plugin ---- -## Overview -- [Create a new process plugin](create) -- [Upgrade processes from 0.9.x](upgrade-from-0) \ No newline at end of file diff --git a/docs/src/operations/v1.1.0/develop/create.md b/docs/src/operations/v1.1.0/develop/create.md deleted file mode 100644 index 3a99e69b1..000000000 --- a/docs/src/operations/v1.1.0/develop/create.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -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) -::: \ No newline at end of file diff --git a/docs/src/operations/v1.1.0/develop/upgrade-from-0.md b/docs/src/operations/v1.1.0/develop/upgrade-from-0.md deleted file mode 100644 index d27d7a228..000000000 --- a/docs/src/operations/v1.1.0/develop/upgrade-from-0.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -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) -::: \ No newline at end of file diff --git a/docs/src/operations/v1.1.0/maintain/fhir-reverse-proxy/README.md b/docs/src/operations/v1.1.0/fhir-reverse-proxy/README.md similarity index 100% rename from docs/src/operations/v1.1.0/maintain/fhir-reverse-proxy/README.md rename to docs/src/operations/v1.1.0/fhir-reverse-proxy/README.md diff --git a/docs/src/operations/v1.1.0/maintain/fhir-reverse-proxy/configuration.md b/docs/src/operations/v1.1.0/fhir-reverse-proxy/configuration.md similarity index 100% rename from docs/src/operations/v1.1.0/maintain/fhir-reverse-proxy/configuration.md rename to docs/src/operations/v1.1.0/fhir-reverse-proxy/configuration.md diff --git a/docs/src/operations/v1.1.0/maintain/fhir/README.md b/docs/src/operations/v1.1.0/fhir/README.md similarity index 100% rename from docs/src/operations/v1.1.0/maintain/fhir/README.md rename to docs/src/operations/v1.1.0/fhir/README.md diff --git a/docs/src/operations/v1.1.0/maintain/fhir/access-control.md b/docs/src/operations/v1.1.0/fhir/access-control.md similarity index 100% rename from docs/src/operations/v1.1.0/maintain/fhir/access-control.md rename to docs/src/operations/v1.1.0/fhir/access-control.md diff --git a/docs/src/operations/v1.1.0/maintain/fhir/configuration.md b/docs/src/operations/v1.1.0/fhir/configuration.md similarity index 100% rename from docs/src/operations/v1.1.0/maintain/fhir/configuration.md rename to docs/src/operations/v1.1.0/fhir/configuration.md diff --git a/docs/src/operations/v1.1.0/maintain/fhir/oidc.md b/docs/src/operations/v1.1.0/fhir/oidc.md similarity index 100% rename from docs/src/operations/v1.1.0/maintain/fhir/oidc.md rename to docs/src/operations/v1.1.0/fhir/oidc.md diff --git a/docs/src/operations/v1.1.0/index.md b/docs/src/operations/v1.1.0/index.md index 1c6266f1b..8fd884f5d 100644 --- a/docs/src/operations/v1.1.0/index.md +++ b/docs/src/operations/v1.1.0/index.md @@ -10,15 +10,11 @@ This is a major DSF release not compatible with 0.9.x and older version develope # System Administrators -- [Upgrade from DSF 0.9.x.](maintain/upgrade-from-0) -- [Upgrade from DSF 1.x.](maintain/upgrade-from-1) -- [Install DSF 1.1.0](maintain/install) +- [Upgrade from DSF 0.9.x.](upgrade-from-0) +- [Upgrade from DSF 1.x.](upgrade-from-1) +- [Install DSF 1.1.0](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 diff --git a/docs/src/operations/v1.1.0/maintain/install.md b/docs/src/operations/v1.1.0/install.md similarity index 100% rename from docs/src/operations/v1.1.0/maintain/install.md rename to docs/src/operations/v1.1.0/install.md diff --git a/docs/src/operations/v1.1.0/maintain/README.md b/docs/src/operations/v1.1.0/maintain/README.md deleted file mode 100644 index c1207651c..000000000 --- a/docs/src/operations/v1.1.0/maintain/README.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Maintain a DSF instance -icon: tool ---- -## Overview -- [Install DSF 1.1.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) diff --git a/docs/src/operations/v1.1.0/maintain/upgrade-from-0.md b/docs/src/operations/v1.1.0/upgrade-from-0.md similarity index 100% rename from docs/src/operations/v1.1.0/maintain/upgrade-from-0.md rename to docs/src/operations/v1.1.0/upgrade-from-0.md diff --git a/docs/src/operations/v1.1.0/maintain/upgrade-from-1.md b/docs/src/operations/v1.1.0/upgrade-from-1.md similarity index 100% rename from docs/src/operations/v1.1.0/maintain/upgrade-from-1.md rename to docs/src/operations/v1.1.0/upgrade-from-1.md diff --git a/docs/src/operations/v1.2.0/maintain/allowList-mgm.md b/docs/src/operations/v1.2.0/allowList-mgm.md similarity index 100% rename from docs/src/operations/v1.2.0/maintain/allowList-mgm.md rename to docs/src/operations/v1.2.0/allowList-mgm.md diff --git a/docs/src/operations/v1.2.0/maintain/bpe/README.md b/docs/src/operations/v1.2.0/bpe/README.md similarity index 100% rename from docs/src/operations/v1.2.0/maintain/bpe/README.md rename to docs/src/operations/v1.2.0/bpe/README.md diff --git a/docs/src/operations/v1.2.0/maintain/bpe/configuration.md b/docs/src/operations/v1.2.0/bpe/configuration.md similarity index 100% rename from docs/src/operations/v1.2.0/maintain/bpe/configuration.md rename to docs/src/operations/v1.2.0/bpe/configuration.md diff --git a/docs/src/operations/v1.2.0/develop/README.md b/docs/src/operations/v1.2.0/develop/README.md deleted file mode 100644 index 7c7613cb5..000000000 --- a/docs/src/operations/v1.2.0/develop/README.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Develop Process Plugins -icon: plugin ---- -## Overview -- [Create a new process plugin](create) -- [Upgrade processes from 0.9.x](upgrade-from-0) \ No newline at end of file diff --git a/docs/src/operations/v1.2.0/develop/create.md b/docs/src/operations/v1.2.0/develop/create.md deleted file mode 100644 index 3a99e69b1..000000000 --- a/docs/src/operations/v1.2.0/develop/create.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -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) -::: \ No newline at end of file diff --git a/docs/src/operations/v1.2.0/develop/upgrade-from-0.md b/docs/src/operations/v1.2.0/develop/upgrade-from-0.md deleted file mode 100644 index d27d7a228..000000000 --- a/docs/src/operations/v1.2.0/develop/upgrade-from-0.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -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) -::: \ No newline at end of file diff --git a/docs/src/operations/v1.2.0/maintain/fhir-reverse-proxy/README.md b/docs/src/operations/v1.2.0/fhir-reverse-proxy/README.md similarity index 100% rename from docs/src/operations/v1.2.0/maintain/fhir-reverse-proxy/README.md rename to docs/src/operations/v1.2.0/fhir-reverse-proxy/README.md diff --git a/docs/src/operations/v1.2.0/maintain/fhir-reverse-proxy/configuration.md b/docs/src/operations/v1.2.0/fhir-reverse-proxy/configuration.md similarity index 100% rename from docs/src/operations/v1.2.0/maintain/fhir-reverse-proxy/configuration.md rename to docs/src/operations/v1.2.0/fhir-reverse-proxy/configuration.md diff --git a/docs/src/operations/v1.2.0/maintain/fhir/README.md b/docs/src/operations/v1.2.0/fhir/README.md similarity index 100% rename from docs/src/operations/v1.2.0/maintain/fhir/README.md rename to docs/src/operations/v1.2.0/fhir/README.md diff --git a/docs/src/operations/v1.2.0/maintain/fhir/access-control.md b/docs/src/operations/v1.2.0/fhir/access-control.md similarity index 100% rename from docs/src/operations/v1.2.0/maintain/fhir/access-control.md rename to docs/src/operations/v1.2.0/fhir/access-control.md diff --git a/docs/src/operations/v1.2.0/maintain/fhir/configuration.md b/docs/src/operations/v1.2.0/fhir/configuration.md similarity index 100% rename from docs/src/operations/v1.2.0/maintain/fhir/configuration.md rename to docs/src/operations/v1.2.0/fhir/configuration.md diff --git a/docs/src/operations/v1.2.0/maintain/fhir/oidc.md b/docs/src/operations/v1.2.0/fhir/oidc.md similarity index 100% rename from docs/src/operations/v1.2.0/maintain/fhir/oidc.md rename to docs/src/operations/v1.2.0/fhir/oidc.md diff --git a/docs/src/operations/v1.2.0/index.md b/docs/src/operations/v1.2.0/index.md index e4046c9c9..fb15ddfbf 100644 --- a/docs/src/operations/v1.2.0/index.md +++ b/docs/src/operations/v1.2.0/index.md @@ -10,15 +10,11 @@ This is a major DSF release not compatible with 0.9.x and older version develope # System Administrators -- [Upgrade from DSF 0.9.x.](maintain/upgrade-from-0) -- [Upgrade from DSF 1.x.](maintain/upgrade-from-1) -- [Install DSF 1.2.0](maintain/install) +- [Upgrade from DSF 0.9.x.](upgrade-from-0) +- [Upgrade from DSF 1.x.](upgrade-from-1) +- [Install DSF 1.2.0](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 diff --git a/docs/src/operations/v1.2.0/maintain/install.md b/docs/src/operations/v1.2.0/install.md similarity index 100% rename from docs/src/operations/v1.2.0/maintain/install.md rename to docs/src/operations/v1.2.0/install.md diff --git a/docs/src/operations/v1.2.0/maintain/README.md b/docs/src/operations/v1.2.0/maintain/README.md deleted file mode 100644 index 481486b0d..000000000 --- a/docs/src/operations/v1.2.0/maintain/README.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Maintain a DSF instance -icon: tool ---- -## Overview -- [Install DSF 1.2.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) diff --git a/docs/src/operations/v1.2.0/maintain/upgrade-from-0.md b/docs/src/operations/v1.2.0/upgrade-from-0.md similarity index 100% rename from docs/src/operations/v1.2.0/maintain/upgrade-from-0.md rename to docs/src/operations/v1.2.0/upgrade-from-0.md diff --git a/docs/src/operations/v1.2.0/maintain/upgrade-from-1.md b/docs/src/operations/v1.2.0/upgrade-from-1.md similarity index 100% rename from docs/src/operations/v1.2.0/maintain/upgrade-from-1.md rename to docs/src/operations/v1.2.0/upgrade-from-1.md diff --git a/docs/src/operations/v1.3.0/maintain/allowList-mgm.md b/docs/src/operations/v1.3.0/allowList-mgm.md similarity index 100% rename from docs/src/operations/v1.3.0/maintain/allowList-mgm.md rename to docs/src/operations/v1.3.0/allowList-mgm.md diff --git a/docs/src/operations/v1.3.0/maintain/bpe/README.md b/docs/src/operations/v1.3.0/bpe/README.md similarity index 100% rename from docs/src/operations/v1.3.0/maintain/bpe/README.md rename to docs/src/operations/v1.3.0/bpe/README.md diff --git a/docs/src/operations/v1.3.0/maintain/bpe/configuration.md b/docs/src/operations/v1.3.0/bpe/configuration.md similarity index 100% rename from docs/src/operations/v1.3.0/maintain/bpe/configuration.md rename to docs/src/operations/v1.3.0/bpe/configuration.md diff --git a/docs/src/operations/v1.3.0/develop/README.md b/docs/src/operations/v1.3.0/develop/README.md deleted file mode 100644 index 7c7613cb5..000000000 --- a/docs/src/operations/v1.3.0/develop/README.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Develop Process Plugins -icon: plugin ---- -## Overview -- [Create a new process plugin](create) -- [Upgrade processes from 0.9.x](upgrade-from-0) \ No newline at end of file diff --git a/docs/src/operations/v1.3.0/develop/create.md b/docs/src/operations/v1.3.0/develop/create.md deleted file mode 100644 index 3a99e69b1..000000000 --- a/docs/src/operations/v1.3.0/develop/create.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -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) -::: \ No newline at end of file diff --git a/docs/src/operations/v1.3.0/develop/upgrade-from-0.md b/docs/src/operations/v1.3.0/develop/upgrade-from-0.md deleted file mode 100644 index d27d7a228..000000000 --- a/docs/src/operations/v1.3.0/develop/upgrade-from-0.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -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) -::: \ No newline at end of file diff --git a/docs/src/operations/v1.3.0/maintain/fhir-reverse-proxy/README.md b/docs/src/operations/v1.3.0/fhir-reverse-proxy/README.md similarity index 100% rename from docs/src/operations/v1.3.0/maintain/fhir-reverse-proxy/README.md rename to docs/src/operations/v1.3.0/fhir-reverse-proxy/README.md diff --git a/docs/src/operations/v1.3.0/maintain/fhir-reverse-proxy/configuration.md b/docs/src/operations/v1.3.0/fhir-reverse-proxy/configuration.md similarity index 100% rename from docs/src/operations/v1.3.0/maintain/fhir-reverse-proxy/configuration.md rename to docs/src/operations/v1.3.0/fhir-reverse-proxy/configuration.md diff --git a/docs/src/operations/v1.3.0/maintain/fhir/README.md b/docs/src/operations/v1.3.0/fhir/README.md similarity index 100% rename from docs/src/operations/v1.3.0/maintain/fhir/README.md rename to docs/src/operations/v1.3.0/fhir/README.md diff --git a/docs/src/operations/v1.3.0/maintain/fhir/access-control.md b/docs/src/operations/v1.3.0/fhir/access-control.md similarity index 100% rename from docs/src/operations/v1.3.0/maintain/fhir/access-control.md rename to docs/src/operations/v1.3.0/fhir/access-control.md diff --git a/docs/src/operations/v1.3.0/maintain/fhir/configuration.md b/docs/src/operations/v1.3.0/fhir/configuration.md similarity index 100% rename from docs/src/operations/v1.3.0/maintain/fhir/configuration.md rename to docs/src/operations/v1.3.0/fhir/configuration.md diff --git a/docs/src/operations/v1.3.0/maintain/fhir/oidc.md b/docs/src/operations/v1.3.0/fhir/oidc.md similarity index 100% rename from docs/src/operations/v1.3.0/maintain/fhir/oidc.md rename to docs/src/operations/v1.3.0/fhir/oidc.md diff --git a/docs/src/operations/v1.3.0/index.md b/docs/src/operations/v1.3.0/index.md index ec716d84e..d3bf4a913 100644 --- a/docs/src/operations/v1.3.0/index.md +++ b/docs/src/operations/v1.3.0/index.md @@ -10,15 +10,11 @@ This is a major DSF release not compatible with 0.9.x and older version develope # System Administrators -- [Upgrade from DSF 0.9.x.](maintain/upgrade-from-0) -- [Upgrade from DSF 1.x.](maintain/upgrade-from-1) -- [Install DSF 1.3.0](maintain/install) +- [Upgrade from DSF 0.9.x.](upgrade-from-0) +- [Upgrade from DSF 1.x.](upgrade-from-1) +- [Install DSF 1.3.0](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 diff --git a/docs/src/operations/v1.3.0/maintain/install-plugins.md b/docs/src/operations/v1.3.0/install-plugins.md similarity index 100% rename from docs/src/operations/v1.3.0/maintain/install-plugins.md rename to docs/src/operations/v1.3.0/install-plugins.md diff --git a/docs/src/operations/v1.3.0/maintain/install.md b/docs/src/operations/v1.3.0/install.md similarity index 100% rename from docs/src/operations/v1.3.0/maintain/install.md rename to docs/src/operations/v1.3.0/install.md diff --git a/docs/src/operations/v1.3.0/maintain/README.md b/docs/src/operations/v1.3.0/maintain/README.md deleted file mode 100644 index c318c64a3..000000000 --- a/docs/src/operations/v1.3.0/maintain/README.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Maintain a DSF instance -icon: tool ---- -## Overview -- [Install DSF 1.3.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) diff --git a/docs/src/operations/v1.3.0/maintain/upgrade-from-0.md b/docs/src/operations/v1.3.0/upgrade-from-0.md similarity index 100% rename from docs/src/operations/v1.3.0/maintain/upgrade-from-0.md rename to docs/src/operations/v1.3.0/upgrade-from-0.md diff --git a/docs/src/operations/v1.3.0/maintain/upgrade-from-1.md b/docs/src/operations/v1.3.0/upgrade-from-1.md similarity index 100% rename from docs/src/operations/v1.3.0/maintain/upgrade-from-1.md rename to docs/src/operations/v1.3.0/upgrade-from-1.md diff --git a/docs/src/operations/v1.3.1/maintain/allowList-mgm.md b/docs/src/operations/v1.3.1/allowList-mgm.md similarity index 100% rename from docs/src/operations/v1.3.1/maintain/allowList-mgm.md rename to docs/src/operations/v1.3.1/allowList-mgm.md diff --git a/docs/src/operations/v1.3.1/maintain/bpe/README.md b/docs/src/operations/v1.3.1/bpe/README.md similarity index 100% rename from docs/src/operations/v1.3.1/maintain/bpe/README.md rename to docs/src/operations/v1.3.1/bpe/README.md diff --git a/docs/src/operations/v1.3.1/maintain/bpe/configuration.md b/docs/src/operations/v1.3.1/bpe/configuration.md similarity index 100% rename from docs/src/operations/v1.3.1/maintain/bpe/configuration.md rename to docs/src/operations/v1.3.1/bpe/configuration.md diff --git a/docs/src/operations/v1.3.1/develop/README.md b/docs/src/operations/v1.3.1/develop/README.md deleted file mode 100644 index 7c7613cb5..000000000 --- a/docs/src/operations/v1.3.1/develop/README.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Develop Process Plugins -icon: plugin ---- -## Overview -- [Create a new process plugin](create) -- [Upgrade processes from 0.9.x](upgrade-from-0) \ No newline at end of file diff --git a/docs/src/operations/v1.3.1/develop/create.md b/docs/src/operations/v1.3.1/develop/create.md deleted file mode 100644 index 3a99e69b1..000000000 --- a/docs/src/operations/v1.3.1/develop/create.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -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) -::: \ No newline at end of file diff --git a/docs/src/operations/v1.3.1/develop/upgrade-from-0.md b/docs/src/operations/v1.3.1/develop/upgrade-from-0.md deleted file mode 100644 index d27d7a228..000000000 --- a/docs/src/operations/v1.3.1/develop/upgrade-from-0.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -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) -::: \ No newline at end of file diff --git a/docs/src/operations/v1.3.1/maintain/fhir-reverse-proxy/README.md b/docs/src/operations/v1.3.1/fhir-reverse-proxy/README.md similarity index 100% rename from docs/src/operations/v1.3.1/maintain/fhir-reverse-proxy/README.md rename to docs/src/operations/v1.3.1/fhir-reverse-proxy/README.md diff --git a/docs/src/operations/v1.3.1/maintain/fhir-reverse-proxy/configuration.md b/docs/src/operations/v1.3.1/fhir-reverse-proxy/configuration.md similarity index 100% rename from docs/src/operations/v1.3.1/maintain/fhir-reverse-proxy/configuration.md rename to docs/src/operations/v1.3.1/fhir-reverse-proxy/configuration.md diff --git a/docs/src/operations/v1.3.1/maintain/fhir/README.md b/docs/src/operations/v1.3.1/fhir/README.md similarity index 100% rename from docs/src/operations/v1.3.1/maintain/fhir/README.md rename to docs/src/operations/v1.3.1/fhir/README.md diff --git a/docs/src/operations/v1.3.1/maintain/fhir/access-control.md b/docs/src/operations/v1.3.1/fhir/access-control.md similarity index 100% rename from docs/src/operations/v1.3.1/maintain/fhir/access-control.md rename to docs/src/operations/v1.3.1/fhir/access-control.md diff --git a/docs/src/operations/v1.3.1/maintain/fhir/configuration.md b/docs/src/operations/v1.3.1/fhir/configuration.md similarity index 100% rename from docs/src/operations/v1.3.1/maintain/fhir/configuration.md rename to docs/src/operations/v1.3.1/fhir/configuration.md diff --git a/docs/src/operations/v1.3.1/maintain/fhir/oidc.md b/docs/src/operations/v1.3.1/fhir/oidc.md similarity index 100% rename from docs/src/operations/v1.3.1/maintain/fhir/oidc.md rename to docs/src/operations/v1.3.1/fhir/oidc.md diff --git a/docs/src/operations/v1.3.1/index.md b/docs/src/operations/v1.3.1/index.md index ec02e7b5a..0a69a5b16 100644 --- a/docs/src/operations/v1.3.1/index.md +++ b/docs/src/operations/v1.3.1/index.md @@ -10,15 +10,11 @@ This is a major DSF release not compatible with 0.9.x and older version develope # System Administrators -- [Upgrade from DSF 0.9.x.](maintain/upgrade-from-0) -- [Upgrade from DSF 1.3.0](maintain/upgrade-from-1) -- [Install DSF 1.3.1](maintain/install) +- [Upgrade from DSF 0.9.x.](upgrade-from-0) +- [Upgrade from DSF 1.3.0](upgrade-from-1) +- [Install DSF 1.3.1](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 diff --git a/docs/src/operations/v1.3.1/maintain/install-plugins.md b/docs/src/operations/v1.3.1/install-plugins.md similarity index 100% rename from docs/src/operations/v1.3.1/maintain/install-plugins.md rename to docs/src/operations/v1.3.1/install-plugins.md diff --git a/docs/src/operations/v1.3.1/maintain/install.md b/docs/src/operations/v1.3.1/install.md similarity index 100% rename from docs/src/operations/v1.3.1/maintain/install.md rename to docs/src/operations/v1.3.1/install.md diff --git a/docs/src/operations/v1.3.1/maintain/README.md b/docs/src/operations/v1.3.1/maintain/README.md deleted file mode 100644 index 1922c5dea..000000000 --- a/docs/src/operations/v1.3.1/maintain/README.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Maintain a DSF instance -icon: tool ---- -## Overview -- [Install DSF 1.3.1](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) diff --git a/docs/src/operations/v1.3.1/maintain/upgrade-from-0.md b/docs/src/operations/v1.3.1/upgrade-from-0.md similarity index 100% rename from docs/src/operations/v1.3.1/maintain/upgrade-from-0.md rename to docs/src/operations/v1.3.1/upgrade-from-0.md diff --git a/docs/src/operations/v1.3.1/maintain/upgrade-from-1.md b/docs/src/operations/v1.3.1/upgrade-from-1.md similarity index 100% rename from docs/src/operations/v1.3.1/maintain/upgrade-from-1.md rename to docs/src/operations/v1.3.1/upgrade-from-1.md diff --git a/docs/src/operations/v1.3.2/maintain/allowList-mgm.md b/docs/src/operations/v1.3.2/allowList-mgm.md similarity index 100% rename from docs/src/operations/v1.3.2/maintain/allowList-mgm.md rename to docs/src/operations/v1.3.2/allowList-mgm.md diff --git a/docs/src/operations/v1.3.2/maintain/bpe/README.md b/docs/src/operations/v1.3.2/bpe/README.md similarity index 100% rename from docs/src/operations/v1.3.2/maintain/bpe/README.md rename to docs/src/operations/v1.3.2/bpe/README.md diff --git a/docs/src/operations/v1.3.2/maintain/bpe/configuration.md b/docs/src/operations/v1.3.2/bpe/configuration.md similarity index 100% rename from docs/src/operations/v1.3.2/maintain/bpe/configuration.md rename to docs/src/operations/v1.3.2/bpe/configuration.md diff --git a/docs/src/operations/v1.3.2/develop/README.md b/docs/src/operations/v1.3.2/develop/README.md deleted file mode 100644 index 7c7613cb5..000000000 --- a/docs/src/operations/v1.3.2/develop/README.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Develop Process Plugins -icon: plugin ---- -## Overview -- [Create a new process plugin](create) -- [Upgrade processes from 0.9.x](upgrade-from-0) \ No newline at end of file diff --git a/docs/src/operations/v1.3.2/develop/create.md b/docs/src/operations/v1.3.2/develop/create.md deleted file mode 100644 index 3a99e69b1..000000000 --- a/docs/src/operations/v1.3.2/develop/create.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -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) -::: \ No newline at end of file diff --git a/docs/src/operations/v1.3.2/develop/upgrade-from-0.md b/docs/src/operations/v1.3.2/develop/upgrade-from-0.md deleted file mode 100644 index d27d7a228..000000000 --- a/docs/src/operations/v1.3.2/develop/upgrade-from-0.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -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) -::: \ No newline at end of file diff --git a/docs/src/operations/v1.3.2/maintain/fhir-reverse-proxy/README.md b/docs/src/operations/v1.3.2/fhir-reverse-proxy/README.md similarity index 100% rename from docs/src/operations/v1.3.2/maintain/fhir-reverse-proxy/README.md rename to docs/src/operations/v1.3.2/fhir-reverse-proxy/README.md diff --git a/docs/src/operations/v1.3.2/maintain/fhir-reverse-proxy/configuration.md b/docs/src/operations/v1.3.2/fhir-reverse-proxy/configuration.md similarity index 100% rename from docs/src/operations/v1.3.2/maintain/fhir-reverse-proxy/configuration.md rename to docs/src/operations/v1.3.2/fhir-reverse-proxy/configuration.md diff --git a/docs/src/operations/v1.3.2/maintain/fhir/README.md b/docs/src/operations/v1.3.2/fhir/README.md similarity index 100% rename from docs/src/operations/v1.3.2/maintain/fhir/README.md rename to docs/src/operations/v1.3.2/fhir/README.md diff --git a/docs/src/operations/v1.3.2/maintain/fhir/access-control.md b/docs/src/operations/v1.3.2/fhir/access-control.md similarity index 100% rename from docs/src/operations/v1.3.2/maintain/fhir/access-control.md rename to docs/src/operations/v1.3.2/fhir/access-control.md diff --git a/docs/src/operations/v1.3.2/maintain/fhir/configuration.md b/docs/src/operations/v1.3.2/fhir/configuration.md similarity index 100% rename from docs/src/operations/v1.3.2/maintain/fhir/configuration.md rename to docs/src/operations/v1.3.2/fhir/configuration.md diff --git a/docs/src/operations/v1.3.2/maintain/fhir/oidc.md b/docs/src/operations/v1.3.2/fhir/oidc.md similarity index 100% rename from docs/src/operations/v1.3.2/maintain/fhir/oidc.md rename to docs/src/operations/v1.3.2/fhir/oidc.md diff --git a/docs/src/operations/v1.3.2/index.md b/docs/src/operations/v1.3.2/index.md index 760e0c910..bf7cd4167 100644 --- a/docs/src/operations/v1.3.2/index.md +++ b/docs/src/operations/v1.3.2/index.md @@ -10,16 +10,9 @@ This is a major DSF release not compatible with 0.9.x and older version develope # System Administrators -- [Install DSF 1.3.2](maintain/install) -- [Upgrade from DSF 1.3.0](maintain/upgrade-from-1) -- [Upgrade from DSF 0.9.x.](maintain/upgrade-from-0) - - - - -# Developers -- [Create a new process plugin](develop/create) -- [Upgrade from DSF 0.9.x.](develop/upgrade-from-0) +- [Install DSF 1.3.2](install) +- [Upgrade from DSF 1.3.0](upgrade-from-1) +- [Upgrade from DSF 0.9.x.](upgrade-from-0) ## New features - Improved versioning to support up- and downwards-compatibility diff --git a/docs/src/operations/v1.3.2/maintain/install-plugins.md b/docs/src/operations/v1.3.2/install-plugins.md similarity index 100% rename from docs/src/operations/v1.3.2/maintain/install-plugins.md rename to docs/src/operations/v1.3.2/install-plugins.md diff --git a/docs/src/operations/v1.3.2/maintain/install.md b/docs/src/operations/v1.3.2/install.md similarity index 100% rename from docs/src/operations/v1.3.2/maintain/install.md rename to docs/src/operations/v1.3.2/install.md diff --git a/docs/src/operations/v1.3.2/maintain/README.md b/docs/src/operations/v1.3.2/maintain/README.md deleted file mode 100644 index 1922c5dea..000000000 --- a/docs/src/operations/v1.3.2/maintain/README.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Maintain a DSF instance -icon: tool ---- -## Overview -- [Install DSF 1.3.1](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) diff --git a/docs/src/operations/v1.3.2/maintain/upgrade-from-0.md b/docs/src/operations/v1.3.2/upgrade-from-0.md similarity index 100% rename from docs/src/operations/v1.3.2/maintain/upgrade-from-0.md rename to docs/src/operations/v1.3.2/upgrade-from-0.md diff --git a/docs/src/operations/v1.3.2/maintain/upgrade-from-1.md b/docs/src/operations/v1.3.2/upgrade-from-1.md similarity index 100% rename from docs/src/operations/v1.3.2/maintain/upgrade-from-1.md rename to docs/src/operations/v1.3.2/upgrade-from-1.md diff --git a/docs/src/operations/v1.4.0/maintain/allowList-mgm.md b/docs/src/operations/v1.4.0/allowList-mgm.md similarity index 100% rename from docs/src/operations/v1.4.0/maintain/allowList-mgm.md rename to docs/src/operations/v1.4.0/allowList-mgm.md diff --git a/docs/src/operations/v1.4.0/maintain/bpe/README.md b/docs/src/operations/v1.4.0/bpe/README.md similarity index 100% rename from docs/src/operations/v1.4.0/maintain/bpe/README.md rename to docs/src/operations/v1.4.0/bpe/README.md diff --git a/docs/src/operations/v1.4.0/maintain/bpe/configuration.md b/docs/src/operations/v1.4.0/bpe/configuration.md similarity index 100% rename from docs/src/operations/v1.4.0/maintain/bpe/configuration.md rename to docs/src/operations/v1.4.0/bpe/configuration.md diff --git a/docs/src/operations/v1.4.0/contribute/code.md b/docs/src/operations/v1.4.0/contribute/code.md deleted file mode 100644 index b4f16ba6e..000000000 --- a/docs/src/operations/v1.4.0/contribute/code.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -title: Contribute code -icon: info ---- - -Your code can make a difference for the Data Sharing Framework (DSF). We invite all users to share their code, tests, scripts and improvement ideas. Contributions of any size enhance the DSF and support the data sharing framework community. - -### Benefits of Contributing: -- Foster community growth and diversification. -- Sharpen your coding skills. -- Gain recognition in the DSF community. -- Directly impact the future of data sharing in medicine. - -Start now by visiting our contribution pages. Every line of code helps us build a stronger and more versatile DSF. - -## General - -### Code style - -You can import our code style for your specific IDE: - -* [Eclipse](https://github.com/datasharingframework/dsf/blob/main/src/main/resources/eclipse-formatter-config.xml). Open your preferences, click on `Java`, `Code style`, `Formatter`, `Import` and select the downloaded file. -* [IntelliJ](https://github.com/datasharingframework/dsf/blob/main/src/main/resources/intellij-formatter-config.xml). Open your settings, click on `Editor`, `Code style`, `Java`, the settings icon, `import scheme`, `IntelliJ` and select the downloaded file. - -Pull requests will only be approved if the code is formatted according to the code style configurations above. To format the code with maven before pushing to GitHub, use `mvn compile -Pformat-and-sort`. - -### Branching strategy - -[Git Flow](https://www.atlassian.com/de/git/tutorials/comparing-workflows/gitflow-workflow) is used as this project's branching strategy. Therefore, you will find the following structure: - -* main -* develop -* issue -* hotfix -* release - -Notice that only the first two elements listed are actual branches. The other elements are containers to hold all branches belonging to that category. - - -#### Branch naming - -The following ruleset is applied to name branches: - -* `issue/_` -* `hotfix/` -* `release/` - -## Setting up the project - -This chapter lists all important requirements to get the project buildable and running properly. - -### Java - -This project uses Java JDK 17, so make sure you have it installed on your system. - -### Docker - -[Docker](https://www.docker.com/) is used in this project to test database functionality and to run more complex test-setups. - -### Maven - -The project relies on [Maven](https://maven.apache.org/) as its management tool. -*Important:* When building the project you might encounter the following error: -*Could not determine gpg version* [GPG](https://gnupg.org/) is used to sign artifacts for public release. Since this does not concern contributors, you may skip this step in the maven build process with `-Dgpg.skip`. - - -## Workflow - -1. Create an issue or comment on an issue that you want to contribute some feature -2. Fork the repository, create a branch and mention it in the issue -3. If you desire feedback, create a pull request or comment on it in the issue. Feel free to @ any member with write permissions if you feel like your request has not been registered yet. They will review your changes and/or change requests -4. If your changes are production-ready, create a [pull request](https://github.com/datasharingframework/dsf/pulls). - -### Pull request process - -We follow Martin Fowler's method for managing pull requests. This approach categorizes pull requests based on the level of trust and experience of the contributor, as well as the impact of the changes. Here's how we apply it: - -1. **Ship**: For our most trusted contributors with a proven track record. These members can merge their pull requests without prior review, typically for minor or highly confident changes. - -2. **Show**: This level is for trusted contributors who need some oversight, as well as for experienced developers who want to demonstrate how certain changes should be made in the future. They create pull requests and show their work to the team. - -3. **Ask**: New or less experienced contributors, as well as those submitting more complex changes, fall into this category. They are required to ask for feedback and approval before their changes can be merged, ensuring thorough review and quality control. - - -This method helps us maintain a balance between code quality and efficient development, recognizing the varying levels of expertise among our contributors. - -For more information on Fowler's approach, visit [Martin Fowler's article on Pull Requests](https://martinfowler.com/articles/ship-show-ask.html). - - -## Data Security in DSF Development - -The DSF (Data Sharing Framework) and its process plugins are frequently used to transmit sensitive personal data. To prevent the release of personal data during development, please adhere to the following guidelines: - -- **No development with real personal data:** Always use anonymized or synthetic data for development purposes. -- **No personal data in repositories:** Ensure no personal data is present in local and remote repositories intended for publication, not even temporarily. -- **Review all log files:** Before using log files in issues, examples, etc., thoroughly review them to ensure no personal and sensitive data is included. - diff --git a/docs/src/operations/v1.4.0/contribute/documentation.md b/docs/src/operations/v1.4.0/contribute/documentation.md deleted file mode 100644 index afbaf5511..000000000 --- a/docs/src/operations/v1.4.0/contribute/documentation.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: Contribute documentation -icon: info ---- - -**Join us in enhancing our documentation!** - -We believe in the power of community collaboration to make our documentation clearer, more comprehensive, and more user-friendly. There are several ways you can contribute, and we welcome greatly your input! - - -1. **Contact us with feedback**: If you find any of our documentation unclear or if you think there's a topic not covered yet, please don't hesitate to reach out to us. Your perspective as a reader is invaluable in helping us to identify areas for improvement. -2. **Create an issue**: You noticed something that needs fixing or you have a suggestion? Head over to our GitHub repository at [Data Sharing Framework Documentation](https://github.com/datasharingframework/datasharingframework.github.io/issues) and please create an issue. This way, our team and other contributors can track and address documentation changes systematically. -3. **Contribute directly with a pull request**: If you're feeling proactive and want to make direct changes, you're more than welcome to submit a pull request. Visit our GitHub repository at [Data Sharing Framework Documentation](https://github.com/datasharingframework/datasharingframework.github.io) and feel free to propose your changes. Whether it's a typo fix, a new section, or enhanced explanations, every contribution counts. - -We're excited to see your suggestions and are grateful for every contribution that helps us improve. Let's build better documentation together! \ No newline at end of file diff --git a/docs/src/operations/v1.4.0/contribute/readme.md b/docs/src/operations/v1.4.0/contribute/readme.md deleted file mode 100644 index bbacced29..000000000 --- a/docs/src/operations/v1.4.0/contribute/readme.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: Contribute -icon: info ---- - -We are thrilled that you consider contributing to our projects. Your contributions, big or small, are greatly valued and play a significant role in the success and improvement of our work. Whether you're a seasoned developer or just starting out, there's a place for you here to make a meaningful impact. - -### **Ways you can contribute:** - - -1. **Helping other users**: - * **MII Zulip**: If you are part of the German Medical Informatics Initiative, [join the MII Zulip community](https://mii.zulipchat.com/#narrow/stream/392426-Data-Sharing-Framework-.28DSF.29) to assist others, share your knowledge, and learn from fellow contributors. - * **GitHub Discussions**: Engage with our community in [GitHub Discussions](https://github.com/datasharingframework/dsf/discussions) by answering questions, providing feedback, and sharing your insights. -2. **Testing releases**: - * **Stay ahead**: Help us testing the latest releases. Your feedback on functionality, bugs, and user experience is invaluable. - * **Report findings**: Share your testing results to help us refine and enhance our releases. -3. **Reviewing changes**: - * **Peer review**: Contribute by reviewing pull requests. Your insights can help ensure the quality and integrity of code changes. - * **Constructive feedback**: Offer constructive feedback and suggestions to help improve and refine proposed changes. -4. **Documentation changes**: - * **Improve documentation**: Help us improving and updating our documentation. Clear and accurate documentation is crucial for user understanding and success. Please checkout our [Getting started guide for documentation contributions](./documentation) to DSF. - * **Suggest improvements**: If you notice gaps or areas for enhancement in our documentation, we welcome [your suggestions and contributions](https://github.com/datasharingframework/datasharingframework.github.io). -5. **Contributing bug reports**: - * **Report bugs**: If you find a bug, please report it via [an issue on GitHub](https://github.com/datasharingframework/dsf/issues). Detailed bug reports are incredibly helpful. - * **Reproduction steps**: Include steps to reproduce the bug and any relevant logs according to our bug report issue template. -6. **Contributing feature requests**: - * **Suggest features**: You have an idea for a new feature? We'd love to hear it! Open an issue to describe your proposed feature and its potential benefits according to our feature request template. - * **Collaborate on implementation**: If you're able to, contribute to the development of your proposed feature or bug fix. Collaboration can lead to more innovative and effective solutions. Please checkout our [Getting started guide for code contributions](./code) to DSF. -7. **Contributing process plugins**: - * **Develop process plugins for the DSF**: If you have ideas for a process plugin, we encourage you to develop and contribute them. Our [Getting started guide for process plugin development](https://dsf.dev/stable/develop/) will be a useful reference. - * **Share your work**: Your plugins could be a valuable addition to the ecosystem and benefit other users. - -Before you start contributing, we recommend reading our getting started guidelines for detailed information on our processes and standards. This ensures a smooth and productive experience for everyone involved. - -**Your contributions in any form, are what drives the continuous growth and improvement of this project. Thank you for being a part of our community and for your willingness to contribute!** \ No newline at end of file diff --git a/docs/src/operations/v1.4.0/develop/README.md b/docs/src/operations/v1.4.0/develop/README.md deleted file mode 100644 index 7c7613cb5..000000000 --- a/docs/src/operations/v1.4.0/develop/README.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Develop Process Plugins -icon: plugin ---- -## Overview -- [Create a new process plugin](create) -- [Upgrade processes from 0.9.x](upgrade-from-0) \ No newline at end of file diff --git a/docs/src/operations/v1.4.0/develop/create.md b/docs/src/operations/v1.4.0/develop/create.md deleted file mode 100644 index 13f5b32bc..000000000 --- a/docs/src/operations/v1.4.0/develop/create.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: Create a new process plugin -icon: code ---- - -Visit the [how the DSF can help you](../../for-you/) page to get started. - - -::: 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) -::: \ No newline at end of file diff --git a/docs/src/operations/v1.4.0/develop/upgrade-from-0.md b/docs/src/operations/v1.4.0/develop/upgrade-from-0.md deleted file mode 100644 index d27d7a228..000000000 --- a/docs/src/operations/v1.4.0/develop/upgrade-from-0.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -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) -::: \ No newline at end of file diff --git a/docs/src/operations/v1.4.0/maintain/fhir-reverse-proxy/README.md b/docs/src/operations/v1.4.0/fhir-reverse-proxy/README.md similarity index 100% rename from docs/src/operations/v1.4.0/maintain/fhir-reverse-proxy/README.md rename to docs/src/operations/v1.4.0/fhir-reverse-proxy/README.md diff --git a/docs/src/operations/v1.4.0/maintain/fhir-reverse-proxy/configuration.md b/docs/src/operations/v1.4.0/fhir-reverse-proxy/configuration.md similarity index 100% rename from docs/src/operations/v1.4.0/maintain/fhir-reverse-proxy/configuration.md rename to docs/src/operations/v1.4.0/fhir-reverse-proxy/configuration.md diff --git a/docs/src/operations/v1.4.0/maintain/fhir/README.md b/docs/src/operations/v1.4.0/fhir/README.md similarity index 100% rename from docs/src/operations/v1.4.0/maintain/fhir/README.md rename to docs/src/operations/v1.4.0/fhir/README.md diff --git a/docs/src/operations/v1.4.0/maintain/fhir/access-control.md b/docs/src/operations/v1.4.0/fhir/access-control.md similarity index 100% rename from docs/src/operations/v1.4.0/maintain/fhir/access-control.md rename to docs/src/operations/v1.4.0/fhir/access-control.md diff --git a/docs/src/operations/v1.4.0/maintain/fhir/configuration.md b/docs/src/operations/v1.4.0/fhir/configuration.md similarity index 100% rename from docs/src/operations/v1.4.0/maintain/fhir/configuration.md rename to docs/src/operations/v1.4.0/fhir/configuration.md diff --git a/docs/src/operations/v1.4.0/maintain/fhir/oidc.md b/docs/src/operations/v1.4.0/fhir/oidc.md similarity index 100% rename from docs/src/operations/v1.4.0/maintain/fhir/oidc.md rename to docs/src/operations/v1.4.0/fhir/oidc.md diff --git a/docs/src/operations/v1.4.0/index.md b/docs/src/operations/v1.4.0/index.md index 0573d598a..e146c02c4 100644 --- a/docs/src/operations/v1.4.0/index.md +++ b/docs/src/operations/v1.4.0/index.md @@ -10,15 +10,11 @@ This is a major DSF release not compatible with 0.9.x and older version develope # System Administrators -- [Install DSF 1.4.0](maintain/install) -- [Upgrade from DSF 1.3.2](maintain/upgrade-from-1) -- [Upgrade from DSF 0.9.x.](maintain/upgrade-from-0) +- [Install DSF 1.4.0](install) +- [Upgrade from DSF 1.3.2](upgrade-from-1) +- [Upgrade from DSF 0.9.x.](upgrade-from-0) -# 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 diff --git a/docs/src/operations/v1.4.0/maintain/install-plugins.md b/docs/src/operations/v1.4.0/install-plugins.md similarity index 100% rename from docs/src/operations/v1.4.0/maintain/install-plugins.md rename to docs/src/operations/v1.4.0/install-plugins.md diff --git a/docs/src/operations/v1.4.0/maintain/install.md b/docs/src/operations/v1.4.0/install.md similarity index 100% rename from docs/src/operations/v1.4.0/maintain/install.md rename to docs/src/operations/v1.4.0/install.md diff --git a/docs/src/operations/v1.4.0/maintain/README.md b/docs/src/operations/v1.4.0/maintain/README.md deleted file mode 100644 index b3f4582b1..000000000 --- a/docs/src/operations/v1.4.0/maintain/README.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -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) diff --git a/docs/src/operations/v1.4.0/maintain/upgrade-from-0.md b/docs/src/operations/v1.4.0/upgrade-from-0.md similarity index 100% rename from docs/src/operations/v1.4.0/maintain/upgrade-from-0.md rename to docs/src/operations/v1.4.0/upgrade-from-0.md diff --git a/docs/src/operations/v1.4.0/maintain/upgrade-from-1.md b/docs/src/operations/v1.4.0/upgrade-from-1.md similarity index 100% rename from docs/src/operations/v1.4.0/maintain/upgrade-from-1.md rename to docs/src/operations/v1.4.0/upgrade-from-1.md diff --git a/docs/src/operations/v1.5.0/maintain/allowList-mgm.md b/docs/src/operations/v1.5.0/allowList-mgm.md similarity index 100% rename from docs/src/operations/v1.5.0/maintain/allowList-mgm.md rename to docs/src/operations/v1.5.0/allowList-mgm.md diff --git a/docs/src/operations/v1.5.0/maintain/bpe-reverse-proxy/README.md b/docs/src/operations/v1.5.0/bpe-reverse-proxy/README.md similarity index 100% rename from docs/src/operations/v1.5.0/maintain/bpe-reverse-proxy/README.md rename to docs/src/operations/v1.5.0/bpe-reverse-proxy/README.md diff --git a/docs/src/operations/v1.5.0/maintain/bpe-reverse-proxy/configuration.md b/docs/src/operations/v1.5.0/bpe-reverse-proxy/configuration.md similarity index 100% rename from docs/src/operations/v1.5.0/maintain/bpe-reverse-proxy/configuration.md rename to docs/src/operations/v1.5.0/bpe-reverse-proxy/configuration.md diff --git a/docs/src/operations/v1.5.0/maintain/bpe/README.md b/docs/src/operations/v1.5.0/bpe/README.md similarity index 100% rename from docs/src/operations/v1.5.0/maintain/bpe/README.md rename to docs/src/operations/v1.5.0/bpe/README.md diff --git a/docs/src/operations/v1.5.0/maintain/bpe/access-control.md b/docs/src/operations/v1.5.0/bpe/access-control.md similarity index 100% rename from docs/src/operations/v1.5.0/maintain/bpe/access-control.md rename to docs/src/operations/v1.5.0/bpe/access-control.md diff --git a/docs/src/operations/v1.5.0/maintain/bpe/configuration.md b/docs/src/operations/v1.5.0/bpe/configuration.md similarity index 100% rename from docs/src/operations/v1.5.0/maintain/bpe/configuration.md rename to docs/src/operations/v1.5.0/bpe/configuration.md diff --git a/docs/src/operations/v1.5.0/maintain/bpe/oidc.md b/docs/src/operations/v1.5.0/bpe/oidc.md similarity index 100% rename from docs/src/operations/v1.5.0/maintain/bpe/oidc.md rename to docs/src/operations/v1.5.0/bpe/oidc.md diff --git a/docs/src/operations/v1.5.0/contribute/code.md b/docs/src/operations/v1.5.0/contribute/code.md deleted file mode 100644 index b4f16ba6e..000000000 --- a/docs/src/operations/v1.5.0/contribute/code.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -title: Contribute code -icon: info ---- - -Your code can make a difference for the Data Sharing Framework (DSF). We invite all users to share their code, tests, scripts and improvement ideas. Contributions of any size enhance the DSF and support the data sharing framework community. - -### Benefits of Contributing: -- Foster community growth and diversification. -- Sharpen your coding skills. -- Gain recognition in the DSF community. -- Directly impact the future of data sharing in medicine. - -Start now by visiting our contribution pages. Every line of code helps us build a stronger and more versatile DSF. - -## General - -### Code style - -You can import our code style for your specific IDE: - -* [Eclipse](https://github.com/datasharingframework/dsf/blob/main/src/main/resources/eclipse-formatter-config.xml). Open your preferences, click on `Java`, `Code style`, `Formatter`, `Import` and select the downloaded file. -* [IntelliJ](https://github.com/datasharingframework/dsf/blob/main/src/main/resources/intellij-formatter-config.xml). Open your settings, click on `Editor`, `Code style`, `Java`, the settings icon, `import scheme`, `IntelliJ` and select the downloaded file. - -Pull requests will only be approved if the code is formatted according to the code style configurations above. To format the code with maven before pushing to GitHub, use `mvn compile -Pformat-and-sort`. - -### Branching strategy - -[Git Flow](https://www.atlassian.com/de/git/tutorials/comparing-workflows/gitflow-workflow) is used as this project's branching strategy. Therefore, you will find the following structure: - -* main -* develop -* issue -* hotfix -* release - -Notice that only the first two elements listed are actual branches. The other elements are containers to hold all branches belonging to that category. - - -#### Branch naming - -The following ruleset is applied to name branches: - -* `issue/_` -* `hotfix/` -* `release/` - -## Setting up the project - -This chapter lists all important requirements to get the project buildable and running properly. - -### Java - -This project uses Java JDK 17, so make sure you have it installed on your system. - -### Docker - -[Docker](https://www.docker.com/) is used in this project to test database functionality and to run more complex test-setups. - -### Maven - -The project relies on [Maven](https://maven.apache.org/) as its management tool. -*Important:* When building the project you might encounter the following error: -*Could not determine gpg version* [GPG](https://gnupg.org/) is used to sign artifacts for public release. Since this does not concern contributors, you may skip this step in the maven build process with `-Dgpg.skip`. - - -## Workflow - -1. Create an issue or comment on an issue that you want to contribute some feature -2. Fork the repository, create a branch and mention it in the issue -3. If you desire feedback, create a pull request or comment on it in the issue. Feel free to @ any member with write permissions if you feel like your request has not been registered yet. They will review your changes and/or change requests -4. If your changes are production-ready, create a [pull request](https://github.com/datasharingframework/dsf/pulls). - -### Pull request process - -We follow Martin Fowler's method for managing pull requests. This approach categorizes pull requests based on the level of trust and experience of the contributor, as well as the impact of the changes. Here's how we apply it: - -1. **Ship**: For our most trusted contributors with a proven track record. These members can merge their pull requests without prior review, typically for minor or highly confident changes. - -2. **Show**: This level is for trusted contributors who need some oversight, as well as for experienced developers who want to demonstrate how certain changes should be made in the future. They create pull requests and show their work to the team. - -3. **Ask**: New or less experienced contributors, as well as those submitting more complex changes, fall into this category. They are required to ask for feedback and approval before their changes can be merged, ensuring thorough review and quality control. - - -This method helps us maintain a balance between code quality and efficient development, recognizing the varying levels of expertise among our contributors. - -For more information on Fowler's approach, visit [Martin Fowler's article on Pull Requests](https://martinfowler.com/articles/ship-show-ask.html). - - -## Data Security in DSF Development - -The DSF (Data Sharing Framework) and its process plugins are frequently used to transmit sensitive personal data. To prevent the release of personal data during development, please adhere to the following guidelines: - -- **No development with real personal data:** Always use anonymized or synthetic data for development purposes. -- **No personal data in repositories:** Ensure no personal data is present in local and remote repositories intended for publication, not even temporarily. -- **Review all log files:** Before using log files in issues, examples, etc., thoroughly review them to ensure no personal and sensitive data is included. - diff --git a/docs/src/operations/v1.5.0/contribute/documentation.md b/docs/src/operations/v1.5.0/contribute/documentation.md deleted file mode 100644 index afbaf5511..000000000 --- a/docs/src/operations/v1.5.0/contribute/documentation.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: Contribute documentation -icon: info ---- - -**Join us in enhancing our documentation!** - -We believe in the power of community collaboration to make our documentation clearer, more comprehensive, and more user-friendly. There are several ways you can contribute, and we welcome greatly your input! - - -1. **Contact us with feedback**: If you find any of our documentation unclear or if you think there's a topic not covered yet, please don't hesitate to reach out to us. Your perspective as a reader is invaluable in helping us to identify areas for improvement. -2. **Create an issue**: You noticed something that needs fixing or you have a suggestion? Head over to our GitHub repository at [Data Sharing Framework Documentation](https://github.com/datasharingframework/datasharingframework.github.io/issues) and please create an issue. This way, our team and other contributors can track and address documentation changes systematically. -3. **Contribute directly with a pull request**: If you're feeling proactive and want to make direct changes, you're more than welcome to submit a pull request. Visit our GitHub repository at [Data Sharing Framework Documentation](https://github.com/datasharingframework/datasharingframework.github.io) and feel free to propose your changes. Whether it's a typo fix, a new section, or enhanced explanations, every contribution counts. - -We're excited to see your suggestions and are grateful for every contribution that helps us improve. Let's build better documentation together! \ No newline at end of file diff --git a/docs/src/operations/v1.5.0/contribute/readme.md b/docs/src/operations/v1.5.0/contribute/readme.md deleted file mode 100644 index bbacced29..000000000 --- a/docs/src/operations/v1.5.0/contribute/readme.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: Contribute -icon: info ---- - -We are thrilled that you consider contributing to our projects. Your contributions, big or small, are greatly valued and play a significant role in the success and improvement of our work. Whether you're a seasoned developer or just starting out, there's a place for you here to make a meaningful impact. - -### **Ways you can contribute:** - - -1. **Helping other users**: - * **MII Zulip**: If you are part of the German Medical Informatics Initiative, [join the MII Zulip community](https://mii.zulipchat.com/#narrow/stream/392426-Data-Sharing-Framework-.28DSF.29) to assist others, share your knowledge, and learn from fellow contributors. - * **GitHub Discussions**: Engage with our community in [GitHub Discussions](https://github.com/datasharingframework/dsf/discussions) by answering questions, providing feedback, and sharing your insights. -2. **Testing releases**: - * **Stay ahead**: Help us testing the latest releases. Your feedback on functionality, bugs, and user experience is invaluable. - * **Report findings**: Share your testing results to help us refine and enhance our releases. -3. **Reviewing changes**: - * **Peer review**: Contribute by reviewing pull requests. Your insights can help ensure the quality and integrity of code changes. - * **Constructive feedback**: Offer constructive feedback and suggestions to help improve and refine proposed changes. -4. **Documentation changes**: - * **Improve documentation**: Help us improving and updating our documentation. Clear and accurate documentation is crucial for user understanding and success. Please checkout our [Getting started guide for documentation contributions](./documentation) to DSF. - * **Suggest improvements**: If you notice gaps or areas for enhancement in our documentation, we welcome [your suggestions and contributions](https://github.com/datasharingframework/datasharingframework.github.io). -5. **Contributing bug reports**: - * **Report bugs**: If you find a bug, please report it via [an issue on GitHub](https://github.com/datasharingframework/dsf/issues). Detailed bug reports are incredibly helpful. - * **Reproduction steps**: Include steps to reproduce the bug and any relevant logs according to our bug report issue template. -6. **Contributing feature requests**: - * **Suggest features**: You have an idea for a new feature? We'd love to hear it! Open an issue to describe your proposed feature and its potential benefits according to our feature request template. - * **Collaborate on implementation**: If you're able to, contribute to the development of your proposed feature or bug fix. Collaboration can lead to more innovative and effective solutions. Please checkout our [Getting started guide for code contributions](./code) to DSF. -7. **Contributing process plugins**: - * **Develop process plugins for the DSF**: If you have ideas for a process plugin, we encourage you to develop and contribute them. Our [Getting started guide for process plugin development](https://dsf.dev/stable/develop/) will be a useful reference. - * **Share your work**: Your plugins could be a valuable addition to the ecosystem and benefit other users. - -Before you start contributing, we recommend reading our getting started guidelines for detailed information on our processes and standards. This ensures a smooth and productive experience for everyone involved. - -**Your contributions in any form, are what drives the continuous growth and improvement of this project. Thank you for being a part of our community and for your willingness to contribute!** \ No newline at end of file diff --git a/docs/src/operations/v1.5.0/develop/README.md b/docs/src/operations/v1.5.0/develop/README.md deleted file mode 100644 index 7c7613cb5..000000000 --- a/docs/src/operations/v1.5.0/develop/README.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Develop Process Plugins -icon: plugin ---- -## Overview -- [Create a new process plugin](create) -- [Upgrade processes from 0.9.x](upgrade-from-0) \ No newline at end of file diff --git a/docs/src/operations/v1.5.0/develop/create.md b/docs/src/operations/v1.5.0/develop/create.md deleted file mode 100644 index 13f5b32bc..000000000 --- a/docs/src/operations/v1.5.0/develop/create.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: Create a new process plugin -icon: code ---- - -Visit the [how the DSF can help you](../../for-you/) page to get started. - - -::: 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) -::: \ No newline at end of file diff --git a/docs/src/operations/v1.5.0/develop/upgrade-from-0.md b/docs/src/operations/v1.5.0/develop/upgrade-from-0.md deleted file mode 100644 index d27d7a228..000000000 --- a/docs/src/operations/v1.5.0/develop/upgrade-from-0.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -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) -::: \ No newline at end of file diff --git a/docs/src/operations/v1.5.0/maintain/fhir-reverse-proxy/README.md b/docs/src/operations/v1.5.0/fhir-reverse-proxy/README.md similarity index 100% rename from docs/src/operations/v1.5.0/maintain/fhir-reverse-proxy/README.md rename to docs/src/operations/v1.5.0/fhir-reverse-proxy/README.md diff --git a/docs/src/operations/v1.5.0/maintain/fhir-reverse-proxy/configuration.md b/docs/src/operations/v1.5.0/fhir-reverse-proxy/configuration.md similarity index 100% rename from docs/src/operations/v1.5.0/maintain/fhir-reverse-proxy/configuration.md rename to docs/src/operations/v1.5.0/fhir-reverse-proxy/configuration.md diff --git a/docs/src/operations/v1.5.0/maintain/fhir/README.md b/docs/src/operations/v1.5.0/fhir/README.md similarity index 100% rename from docs/src/operations/v1.5.0/maintain/fhir/README.md rename to docs/src/operations/v1.5.0/fhir/README.md diff --git a/docs/src/operations/v1.5.0/maintain/fhir/access-control.md b/docs/src/operations/v1.5.0/fhir/access-control.md similarity index 100% rename from docs/src/operations/v1.5.0/maintain/fhir/access-control.md rename to docs/src/operations/v1.5.0/fhir/access-control.md diff --git a/docs/src/operations/v1.5.0/maintain/fhir/configuration.md b/docs/src/operations/v1.5.0/fhir/configuration.md similarity index 100% rename from docs/src/operations/v1.5.0/maintain/fhir/configuration.md rename to docs/src/operations/v1.5.0/fhir/configuration.md diff --git a/docs/src/operations/v1.5.0/maintain/fhir/oidc.md b/docs/src/operations/v1.5.0/fhir/oidc.md similarity index 100% rename from docs/src/operations/v1.5.0/maintain/fhir/oidc.md rename to docs/src/operations/v1.5.0/fhir/oidc.md diff --git a/docs/src/operations/v1.5.0/index.md b/docs/src/operations/v1.5.0/index.md index 8bf4d5124..50b4705b2 100644 --- a/docs/src/operations/v1.5.0/index.md +++ b/docs/src/operations/v1.5.0/index.md @@ -10,15 +10,11 @@ This is a major DSF release not compatible with 0.9.x and older version develope # System Administrators -- [Install DSF 1.5.0](maintain/install) -- [Upgrade from DSF 1.4.0](maintain/upgrade-from-1) -- [Upgrade from DSF 0.9.x.](maintain/upgrade-from-0) +- [Install DSF 1.5.0](install) +- [Upgrade from DSF 1.4.0](upgrade-from-1) +- [Upgrade from DSF 0.9.x.](upgrade-from-0) -# 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 diff --git a/docs/src/operations/v1.5.0/maintain/install-plugins.md b/docs/src/operations/v1.5.0/install-plugins.md similarity index 100% rename from docs/src/operations/v1.5.0/maintain/install-plugins.md rename to docs/src/operations/v1.5.0/install-plugins.md diff --git a/docs/src/operations/v1.5.0/maintain/install.md b/docs/src/operations/v1.5.0/install.md similarity index 100% rename from docs/src/operations/v1.5.0/maintain/install.md rename to docs/src/operations/v1.5.0/install.md diff --git a/docs/src/operations/v1.5.0/maintain/README.md b/docs/src/operations/v1.5.0/maintain/README.md deleted file mode 100644 index 47e693740..000000000 --- a/docs/src/operations/v1.5.0/maintain/README.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Maintain a DSF instance -icon: tool ---- -## Overview -- [Install DSF 1.5.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 Reverse Proxy - - [Configuration Parameters](bpe-reverse-proxy/configuration) -- BPE Server - - [Configuration Parameters](bpe/configuration) - - [Access Control](bpe/access-control) - - [OpenID Connect](bpe/oidc) diff --git a/docs/src/operations/v1.5.0/maintain/upgrade-from-0.md b/docs/src/operations/v1.5.0/upgrade-from-0.md similarity index 100% rename from docs/src/operations/v1.5.0/maintain/upgrade-from-0.md rename to docs/src/operations/v1.5.0/upgrade-from-0.md diff --git a/docs/src/operations/v1.5.0/maintain/upgrade-from-1.md b/docs/src/operations/v1.5.0/upgrade-from-1.md similarity index 100% rename from docs/src/operations/v1.5.0/maintain/upgrade-from-1.md rename to docs/src/operations/v1.5.0/upgrade-from-1.md diff --git a/docs/src/operations/v1.5.1/maintain/allowList-mgm.md b/docs/src/operations/v1.5.1/allowList-mgm.md similarity index 100% rename from docs/src/operations/v1.5.1/maintain/allowList-mgm.md rename to docs/src/operations/v1.5.1/allowList-mgm.md diff --git a/docs/src/operations/v1.5.1/maintain/bpe-reverse-proxy/README.md b/docs/src/operations/v1.5.1/bpe-reverse-proxy/README.md similarity index 100% rename from docs/src/operations/v1.5.1/maintain/bpe-reverse-proxy/README.md rename to docs/src/operations/v1.5.1/bpe-reverse-proxy/README.md diff --git a/docs/src/operations/v1.5.1/maintain/bpe-reverse-proxy/configuration.md b/docs/src/operations/v1.5.1/bpe-reverse-proxy/configuration.md similarity index 100% rename from docs/src/operations/v1.5.1/maintain/bpe-reverse-proxy/configuration.md rename to docs/src/operations/v1.5.1/bpe-reverse-proxy/configuration.md diff --git a/docs/src/operations/v1.5.1/maintain/bpe/README.md b/docs/src/operations/v1.5.1/bpe/README.md similarity index 100% rename from docs/src/operations/v1.5.1/maintain/bpe/README.md rename to docs/src/operations/v1.5.1/bpe/README.md diff --git a/docs/src/operations/v1.5.1/maintain/bpe/access-control.md b/docs/src/operations/v1.5.1/bpe/access-control.md similarity index 100% rename from docs/src/operations/v1.5.1/maintain/bpe/access-control.md rename to docs/src/operations/v1.5.1/bpe/access-control.md diff --git a/docs/src/operations/v1.5.1/maintain/bpe/configuration.md b/docs/src/operations/v1.5.1/bpe/configuration.md similarity index 100% rename from docs/src/operations/v1.5.1/maintain/bpe/configuration.md rename to docs/src/operations/v1.5.1/bpe/configuration.md diff --git a/docs/src/operations/v1.5.1/maintain/bpe/oidc.md b/docs/src/operations/v1.5.1/bpe/oidc.md similarity index 100% rename from docs/src/operations/v1.5.1/maintain/bpe/oidc.md rename to docs/src/operations/v1.5.1/bpe/oidc.md diff --git a/docs/src/operations/v1.5.1/contribute/code.md b/docs/src/operations/v1.5.1/contribute/code.md deleted file mode 100644 index b4f16ba6e..000000000 --- a/docs/src/operations/v1.5.1/contribute/code.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -title: Contribute code -icon: info ---- - -Your code can make a difference for the Data Sharing Framework (DSF). We invite all users to share their code, tests, scripts and improvement ideas. Contributions of any size enhance the DSF and support the data sharing framework community. - -### Benefits of Contributing: -- Foster community growth and diversification. -- Sharpen your coding skills. -- Gain recognition in the DSF community. -- Directly impact the future of data sharing in medicine. - -Start now by visiting our contribution pages. Every line of code helps us build a stronger and more versatile DSF. - -## General - -### Code style - -You can import our code style for your specific IDE: - -* [Eclipse](https://github.com/datasharingframework/dsf/blob/main/src/main/resources/eclipse-formatter-config.xml). Open your preferences, click on `Java`, `Code style`, `Formatter`, `Import` and select the downloaded file. -* [IntelliJ](https://github.com/datasharingframework/dsf/blob/main/src/main/resources/intellij-formatter-config.xml). Open your settings, click on `Editor`, `Code style`, `Java`, the settings icon, `import scheme`, `IntelliJ` and select the downloaded file. - -Pull requests will only be approved if the code is formatted according to the code style configurations above. To format the code with maven before pushing to GitHub, use `mvn compile -Pformat-and-sort`. - -### Branching strategy - -[Git Flow](https://www.atlassian.com/de/git/tutorials/comparing-workflows/gitflow-workflow) is used as this project's branching strategy. Therefore, you will find the following structure: - -* main -* develop -* issue -* hotfix -* release - -Notice that only the first two elements listed are actual branches. The other elements are containers to hold all branches belonging to that category. - - -#### Branch naming - -The following ruleset is applied to name branches: - -* `issue/_` -* `hotfix/` -* `release/` - -## Setting up the project - -This chapter lists all important requirements to get the project buildable and running properly. - -### Java - -This project uses Java JDK 17, so make sure you have it installed on your system. - -### Docker - -[Docker](https://www.docker.com/) is used in this project to test database functionality and to run more complex test-setups. - -### Maven - -The project relies on [Maven](https://maven.apache.org/) as its management tool. -*Important:* When building the project you might encounter the following error: -*Could not determine gpg version* [GPG](https://gnupg.org/) is used to sign artifacts for public release. Since this does not concern contributors, you may skip this step in the maven build process with `-Dgpg.skip`. - - -## Workflow - -1. Create an issue or comment on an issue that you want to contribute some feature -2. Fork the repository, create a branch and mention it in the issue -3. If you desire feedback, create a pull request or comment on it in the issue. Feel free to @ any member with write permissions if you feel like your request has not been registered yet. They will review your changes and/or change requests -4. If your changes are production-ready, create a [pull request](https://github.com/datasharingframework/dsf/pulls). - -### Pull request process - -We follow Martin Fowler's method for managing pull requests. This approach categorizes pull requests based on the level of trust and experience of the contributor, as well as the impact of the changes. Here's how we apply it: - -1. **Ship**: For our most trusted contributors with a proven track record. These members can merge their pull requests without prior review, typically for minor or highly confident changes. - -2. **Show**: This level is for trusted contributors who need some oversight, as well as for experienced developers who want to demonstrate how certain changes should be made in the future. They create pull requests and show their work to the team. - -3. **Ask**: New or less experienced contributors, as well as those submitting more complex changes, fall into this category. They are required to ask for feedback and approval before their changes can be merged, ensuring thorough review and quality control. - - -This method helps us maintain a balance between code quality and efficient development, recognizing the varying levels of expertise among our contributors. - -For more information on Fowler's approach, visit [Martin Fowler's article on Pull Requests](https://martinfowler.com/articles/ship-show-ask.html). - - -## Data Security in DSF Development - -The DSF (Data Sharing Framework) and its process plugins are frequently used to transmit sensitive personal data. To prevent the release of personal data during development, please adhere to the following guidelines: - -- **No development with real personal data:** Always use anonymized or synthetic data for development purposes. -- **No personal data in repositories:** Ensure no personal data is present in local and remote repositories intended for publication, not even temporarily. -- **Review all log files:** Before using log files in issues, examples, etc., thoroughly review them to ensure no personal and sensitive data is included. - diff --git a/docs/src/operations/v1.5.1/contribute/documentation.md b/docs/src/operations/v1.5.1/contribute/documentation.md deleted file mode 100644 index afbaf5511..000000000 --- a/docs/src/operations/v1.5.1/contribute/documentation.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: Contribute documentation -icon: info ---- - -**Join us in enhancing our documentation!** - -We believe in the power of community collaboration to make our documentation clearer, more comprehensive, and more user-friendly. There are several ways you can contribute, and we welcome greatly your input! - - -1. **Contact us with feedback**: If you find any of our documentation unclear or if you think there's a topic not covered yet, please don't hesitate to reach out to us. Your perspective as a reader is invaluable in helping us to identify areas for improvement. -2. **Create an issue**: You noticed something that needs fixing or you have a suggestion? Head over to our GitHub repository at [Data Sharing Framework Documentation](https://github.com/datasharingframework/datasharingframework.github.io/issues) and please create an issue. This way, our team and other contributors can track and address documentation changes systematically. -3. **Contribute directly with a pull request**: If you're feeling proactive and want to make direct changes, you're more than welcome to submit a pull request. Visit our GitHub repository at [Data Sharing Framework Documentation](https://github.com/datasharingframework/datasharingframework.github.io) and feel free to propose your changes. Whether it's a typo fix, a new section, or enhanced explanations, every contribution counts. - -We're excited to see your suggestions and are grateful for every contribution that helps us improve. Let's build better documentation together! \ No newline at end of file diff --git a/docs/src/operations/v1.5.1/contribute/readme.md b/docs/src/operations/v1.5.1/contribute/readme.md deleted file mode 100644 index bbacced29..000000000 --- a/docs/src/operations/v1.5.1/contribute/readme.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: Contribute -icon: info ---- - -We are thrilled that you consider contributing to our projects. Your contributions, big or small, are greatly valued and play a significant role in the success and improvement of our work. Whether you're a seasoned developer or just starting out, there's a place for you here to make a meaningful impact. - -### **Ways you can contribute:** - - -1. **Helping other users**: - * **MII Zulip**: If you are part of the German Medical Informatics Initiative, [join the MII Zulip community](https://mii.zulipchat.com/#narrow/stream/392426-Data-Sharing-Framework-.28DSF.29) to assist others, share your knowledge, and learn from fellow contributors. - * **GitHub Discussions**: Engage with our community in [GitHub Discussions](https://github.com/datasharingframework/dsf/discussions) by answering questions, providing feedback, and sharing your insights. -2. **Testing releases**: - * **Stay ahead**: Help us testing the latest releases. Your feedback on functionality, bugs, and user experience is invaluable. - * **Report findings**: Share your testing results to help us refine and enhance our releases. -3. **Reviewing changes**: - * **Peer review**: Contribute by reviewing pull requests. Your insights can help ensure the quality and integrity of code changes. - * **Constructive feedback**: Offer constructive feedback and suggestions to help improve and refine proposed changes. -4. **Documentation changes**: - * **Improve documentation**: Help us improving and updating our documentation. Clear and accurate documentation is crucial for user understanding and success. Please checkout our [Getting started guide for documentation contributions](./documentation) to DSF. - * **Suggest improvements**: If you notice gaps or areas for enhancement in our documentation, we welcome [your suggestions and contributions](https://github.com/datasharingframework/datasharingframework.github.io). -5. **Contributing bug reports**: - * **Report bugs**: If you find a bug, please report it via [an issue on GitHub](https://github.com/datasharingframework/dsf/issues). Detailed bug reports are incredibly helpful. - * **Reproduction steps**: Include steps to reproduce the bug and any relevant logs according to our bug report issue template. -6. **Contributing feature requests**: - * **Suggest features**: You have an idea for a new feature? We'd love to hear it! Open an issue to describe your proposed feature and its potential benefits according to our feature request template. - * **Collaborate on implementation**: If you're able to, contribute to the development of your proposed feature or bug fix. Collaboration can lead to more innovative and effective solutions. Please checkout our [Getting started guide for code contributions](./code) to DSF. -7. **Contributing process plugins**: - * **Develop process plugins for the DSF**: If you have ideas for a process plugin, we encourage you to develop and contribute them. Our [Getting started guide for process plugin development](https://dsf.dev/stable/develop/) will be a useful reference. - * **Share your work**: Your plugins could be a valuable addition to the ecosystem and benefit other users. - -Before you start contributing, we recommend reading our getting started guidelines for detailed information on our processes and standards. This ensures a smooth and productive experience for everyone involved. - -**Your contributions in any form, are what drives the continuous growth and improvement of this project. Thank you for being a part of our community and for your willingness to contribute!** \ No newline at end of file diff --git a/docs/src/operations/v1.5.1/develop/README.md b/docs/src/operations/v1.5.1/develop/README.md deleted file mode 100644 index 7c7613cb5..000000000 --- a/docs/src/operations/v1.5.1/develop/README.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Develop Process Plugins -icon: plugin ---- -## Overview -- [Create a new process plugin](create) -- [Upgrade processes from 0.9.x](upgrade-from-0) \ No newline at end of file diff --git a/docs/src/operations/v1.5.1/develop/create.md b/docs/src/operations/v1.5.1/develop/create.md deleted file mode 100644 index 13f5b32bc..000000000 --- a/docs/src/operations/v1.5.1/develop/create.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: Create a new process plugin -icon: code ---- - -Visit the [how the DSF can help you](../../for-you/) page to get started. - - -::: 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) -::: \ No newline at end of file diff --git a/docs/src/operations/v1.5.1/develop/upgrade-from-0.md b/docs/src/operations/v1.5.1/develop/upgrade-from-0.md deleted file mode 100644 index d27d7a228..000000000 --- a/docs/src/operations/v1.5.1/develop/upgrade-from-0.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -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) -::: \ No newline at end of file diff --git a/docs/src/operations/v1.5.1/maintain/fhir-reverse-proxy/README.md b/docs/src/operations/v1.5.1/fhir-reverse-proxy/README.md similarity index 100% rename from docs/src/operations/v1.5.1/maintain/fhir-reverse-proxy/README.md rename to docs/src/operations/v1.5.1/fhir-reverse-proxy/README.md diff --git a/docs/src/operations/v1.5.1/maintain/fhir-reverse-proxy/configuration.md b/docs/src/operations/v1.5.1/fhir-reverse-proxy/configuration.md similarity index 100% rename from docs/src/operations/v1.5.1/maintain/fhir-reverse-proxy/configuration.md rename to docs/src/operations/v1.5.1/fhir-reverse-proxy/configuration.md diff --git a/docs/src/operations/v1.5.1/maintain/fhir/README.md b/docs/src/operations/v1.5.1/fhir/README.md similarity index 100% rename from docs/src/operations/v1.5.1/maintain/fhir/README.md rename to docs/src/operations/v1.5.1/fhir/README.md diff --git a/docs/src/operations/v1.5.1/maintain/fhir/access-control.md b/docs/src/operations/v1.5.1/fhir/access-control.md similarity index 100% rename from docs/src/operations/v1.5.1/maintain/fhir/access-control.md rename to docs/src/operations/v1.5.1/fhir/access-control.md diff --git a/docs/src/operations/v1.5.1/maintain/fhir/configuration.md b/docs/src/operations/v1.5.1/fhir/configuration.md similarity index 100% rename from docs/src/operations/v1.5.1/maintain/fhir/configuration.md rename to docs/src/operations/v1.5.1/fhir/configuration.md diff --git a/docs/src/operations/v1.5.1/maintain/fhir/oidc.md b/docs/src/operations/v1.5.1/fhir/oidc.md similarity index 100% rename from docs/src/operations/v1.5.1/maintain/fhir/oidc.md rename to docs/src/operations/v1.5.1/fhir/oidc.md diff --git a/docs/src/operations/v1.5.1/index.md b/docs/src/operations/v1.5.1/index.md index 2a7cb32cc..58ab5018d 100644 --- a/docs/src/operations/v1.5.1/index.md +++ b/docs/src/operations/v1.5.1/index.md @@ -10,13 +10,9 @@ This is a major DSF release not compatible with 0.9.x and older version develope # System Administrators -- [Install DSF 1.5.1](maintain/install) -- [Upgrade from DSF 1.5.0](maintain/upgrade-from-1) -- [Upgrade from DSF 0.9.x.](maintain/upgrade-from-0) - -# Developers -- [Create a new process plugin](develop/create) -- [Upgrade from DSF 0.9.x.](develop/upgrade-from-0) +- [Install DSF 1.5.1](install) +- [Upgrade from DSF 1.5.0](upgrade-from-1) +- [Upgrade from DSF 0.9.x.](upgrade-from-0) ## New features - Improved versioning to support up- and downwards-compatibility diff --git a/docs/src/operations/v1.5.1/maintain/install-plugins.md b/docs/src/operations/v1.5.1/install-plugins.md similarity index 100% rename from docs/src/operations/v1.5.1/maintain/install-plugins.md rename to docs/src/operations/v1.5.1/install-plugins.md diff --git a/docs/src/operations/v1.5.1/maintain/install.md b/docs/src/operations/v1.5.1/install.md similarity index 100% rename from docs/src/operations/v1.5.1/maintain/install.md rename to docs/src/operations/v1.5.1/install.md diff --git a/docs/src/operations/v1.5.1/maintain/README.md b/docs/src/operations/v1.5.1/maintain/README.md deleted file mode 100644 index 7f7d83063..000000000 --- a/docs/src/operations/v1.5.1/maintain/README.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Maintain a DSF instance -icon: tool ---- -## Overview -- [Install DSF 1.5.1](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 Reverse Proxy - - [Configuration Parameters](bpe-reverse-proxy/configuration) -- BPE Server - - [Configuration Parameters](bpe/configuration) - - [Access Control](bpe/access-control) - - [OpenID Connect](bpe/oidc) diff --git a/docs/src/operations/v1.5.1/maintain/upgrade-from-0.md b/docs/src/operations/v1.5.1/upgrade-from-0.md similarity index 100% rename from docs/src/operations/v1.5.1/maintain/upgrade-from-0.md rename to docs/src/operations/v1.5.1/upgrade-from-0.md diff --git a/docs/src/operations/v1.5.1/maintain/upgrade-from-1.md b/docs/src/operations/v1.5.1/upgrade-from-1.md similarity index 100% rename from docs/src/operations/v1.5.1/maintain/upgrade-from-1.md rename to docs/src/operations/v1.5.1/upgrade-from-1.md diff --git a/docs/src/operations/v1.5.2/maintain/allowList-mgm.md b/docs/src/operations/v1.5.2/allowList-mgm.md similarity index 100% rename from docs/src/operations/v1.5.2/maintain/allowList-mgm.md rename to docs/src/operations/v1.5.2/allowList-mgm.md diff --git a/docs/src/operations/v1.5.2/maintain/bpe-reverse-proxy/README.md b/docs/src/operations/v1.5.2/bpe-reverse-proxy/README.md similarity index 100% rename from docs/src/operations/v1.5.2/maintain/bpe-reverse-proxy/README.md rename to docs/src/operations/v1.5.2/bpe-reverse-proxy/README.md diff --git a/docs/src/operations/v1.5.2/maintain/bpe-reverse-proxy/configuration.md b/docs/src/operations/v1.5.2/bpe-reverse-proxy/configuration.md similarity index 100% rename from docs/src/operations/v1.5.2/maintain/bpe-reverse-proxy/configuration.md rename to docs/src/operations/v1.5.2/bpe-reverse-proxy/configuration.md diff --git a/docs/src/operations/v1.5.2/maintain/bpe/README.md b/docs/src/operations/v1.5.2/bpe/README.md similarity index 100% rename from docs/src/operations/v1.5.2/maintain/bpe/README.md rename to docs/src/operations/v1.5.2/bpe/README.md diff --git a/docs/src/operations/v1.5.2/maintain/bpe/access-control.md b/docs/src/operations/v1.5.2/bpe/access-control.md similarity index 100% rename from docs/src/operations/v1.5.2/maintain/bpe/access-control.md rename to docs/src/operations/v1.5.2/bpe/access-control.md diff --git a/docs/src/operations/v1.5.2/maintain/bpe/configuration.md b/docs/src/operations/v1.5.2/bpe/configuration.md similarity index 100% rename from docs/src/operations/v1.5.2/maintain/bpe/configuration.md rename to docs/src/operations/v1.5.2/bpe/configuration.md diff --git a/docs/src/operations/v1.5.2/maintain/bpe/oidc.md b/docs/src/operations/v1.5.2/bpe/oidc.md similarity index 100% rename from docs/src/operations/v1.5.2/maintain/bpe/oidc.md rename to docs/src/operations/v1.5.2/bpe/oidc.md diff --git a/docs/src/operations/v1.5.2/contribute/code.md b/docs/src/operations/v1.5.2/contribute/code.md deleted file mode 100644 index b4f16ba6e..000000000 --- a/docs/src/operations/v1.5.2/contribute/code.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -title: Contribute code -icon: info ---- - -Your code can make a difference for the Data Sharing Framework (DSF). We invite all users to share their code, tests, scripts and improvement ideas. Contributions of any size enhance the DSF and support the data sharing framework community. - -### Benefits of Contributing: -- Foster community growth and diversification. -- Sharpen your coding skills. -- Gain recognition in the DSF community. -- Directly impact the future of data sharing in medicine. - -Start now by visiting our contribution pages. Every line of code helps us build a stronger and more versatile DSF. - -## General - -### Code style - -You can import our code style for your specific IDE: - -* [Eclipse](https://github.com/datasharingframework/dsf/blob/main/src/main/resources/eclipse-formatter-config.xml). Open your preferences, click on `Java`, `Code style`, `Formatter`, `Import` and select the downloaded file. -* [IntelliJ](https://github.com/datasharingframework/dsf/blob/main/src/main/resources/intellij-formatter-config.xml). Open your settings, click on `Editor`, `Code style`, `Java`, the settings icon, `import scheme`, `IntelliJ` and select the downloaded file. - -Pull requests will only be approved if the code is formatted according to the code style configurations above. To format the code with maven before pushing to GitHub, use `mvn compile -Pformat-and-sort`. - -### Branching strategy - -[Git Flow](https://www.atlassian.com/de/git/tutorials/comparing-workflows/gitflow-workflow) is used as this project's branching strategy. Therefore, you will find the following structure: - -* main -* develop -* issue -* hotfix -* release - -Notice that only the first two elements listed are actual branches. The other elements are containers to hold all branches belonging to that category. - - -#### Branch naming - -The following ruleset is applied to name branches: - -* `issue/_` -* `hotfix/` -* `release/` - -## Setting up the project - -This chapter lists all important requirements to get the project buildable and running properly. - -### Java - -This project uses Java JDK 17, so make sure you have it installed on your system. - -### Docker - -[Docker](https://www.docker.com/) is used in this project to test database functionality and to run more complex test-setups. - -### Maven - -The project relies on [Maven](https://maven.apache.org/) as its management tool. -*Important:* When building the project you might encounter the following error: -*Could not determine gpg version* [GPG](https://gnupg.org/) is used to sign artifacts for public release. Since this does not concern contributors, you may skip this step in the maven build process with `-Dgpg.skip`. - - -## Workflow - -1. Create an issue or comment on an issue that you want to contribute some feature -2. Fork the repository, create a branch and mention it in the issue -3. If you desire feedback, create a pull request or comment on it in the issue. Feel free to @ any member with write permissions if you feel like your request has not been registered yet. They will review your changes and/or change requests -4. If your changes are production-ready, create a [pull request](https://github.com/datasharingframework/dsf/pulls). - -### Pull request process - -We follow Martin Fowler's method for managing pull requests. This approach categorizes pull requests based on the level of trust and experience of the contributor, as well as the impact of the changes. Here's how we apply it: - -1. **Ship**: For our most trusted contributors with a proven track record. These members can merge their pull requests without prior review, typically for minor or highly confident changes. - -2. **Show**: This level is for trusted contributors who need some oversight, as well as for experienced developers who want to demonstrate how certain changes should be made in the future. They create pull requests and show their work to the team. - -3. **Ask**: New or less experienced contributors, as well as those submitting more complex changes, fall into this category. They are required to ask for feedback and approval before their changes can be merged, ensuring thorough review and quality control. - - -This method helps us maintain a balance between code quality and efficient development, recognizing the varying levels of expertise among our contributors. - -For more information on Fowler's approach, visit [Martin Fowler's article on Pull Requests](https://martinfowler.com/articles/ship-show-ask.html). - - -## Data Security in DSF Development - -The DSF (Data Sharing Framework) and its process plugins are frequently used to transmit sensitive personal data. To prevent the release of personal data during development, please adhere to the following guidelines: - -- **No development with real personal data:** Always use anonymized or synthetic data for development purposes. -- **No personal data in repositories:** Ensure no personal data is present in local and remote repositories intended for publication, not even temporarily. -- **Review all log files:** Before using log files in issues, examples, etc., thoroughly review them to ensure no personal and sensitive data is included. - diff --git a/docs/src/operations/v1.5.2/contribute/documentation.md b/docs/src/operations/v1.5.2/contribute/documentation.md deleted file mode 100644 index afbaf5511..000000000 --- a/docs/src/operations/v1.5.2/contribute/documentation.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: Contribute documentation -icon: info ---- - -**Join us in enhancing our documentation!** - -We believe in the power of community collaboration to make our documentation clearer, more comprehensive, and more user-friendly. There are several ways you can contribute, and we welcome greatly your input! - - -1. **Contact us with feedback**: If you find any of our documentation unclear or if you think there's a topic not covered yet, please don't hesitate to reach out to us. Your perspective as a reader is invaluable in helping us to identify areas for improvement. -2. **Create an issue**: You noticed something that needs fixing or you have a suggestion? Head over to our GitHub repository at [Data Sharing Framework Documentation](https://github.com/datasharingframework/datasharingframework.github.io/issues) and please create an issue. This way, our team and other contributors can track and address documentation changes systematically. -3. **Contribute directly with a pull request**: If you're feeling proactive and want to make direct changes, you're more than welcome to submit a pull request. Visit our GitHub repository at [Data Sharing Framework Documentation](https://github.com/datasharingframework/datasharingframework.github.io) and feel free to propose your changes. Whether it's a typo fix, a new section, or enhanced explanations, every contribution counts. - -We're excited to see your suggestions and are grateful for every contribution that helps us improve. Let's build better documentation together! \ No newline at end of file diff --git a/docs/src/operations/v1.5.2/contribute/readme.md b/docs/src/operations/v1.5.2/contribute/readme.md deleted file mode 100644 index bbacced29..000000000 --- a/docs/src/operations/v1.5.2/contribute/readme.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: Contribute -icon: info ---- - -We are thrilled that you consider contributing to our projects. Your contributions, big or small, are greatly valued and play a significant role in the success and improvement of our work. Whether you're a seasoned developer or just starting out, there's a place for you here to make a meaningful impact. - -### **Ways you can contribute:** - - -1. **Helping other users**: - * **MII Zulip**: If you are part of the German Medical Informatics Initiative, [join the MII Zulip community](https://mii.zulipchat.com/#narrow/stream/392426-Data-Sharing-Framework-.28DSF.29) to assist others, share your knowledge, and learn from fellow contributors. - * **GitHub Discussions**: Engage with our community in [GitHub Discussions](https://github.com/datasharingframework/dsf/discussions) by answering questions, providing feedback, and sharing your insights. -2. **Testing releases**: - * **Stay ahead**: Help us testing the latest releases. Your feedback on functionality, bugs, and user experience is invaluable. - * **Report findings**: Share your testing results to help us refine and enhance our releases. -3. **Reviewing changes**: - * **Peer review**: Contribute by reviewing pull requests. Your insights can help ensure the quality and integrity of code changes. - * **Constructive feedback**: Offer constructive feedback and suggestions to help improve and refine proposed changes. -4. **Documentation changes**: - * **Improve documentation**: Help us improving and updating our documentation. Clear and accurate documentation is crucial for user understanding and success. Please checkout our [Getting started guide for documentation contributions](./documentation) to DSF. - * **Suggest improvements**: If you notice gaps or areas for enhancement in our documentation, we welcome [your suggestions and contributions](https://github.com/datasharingframework/datasharingframework.github.io). -5. **Contributing bug reports**: - * **Report bugs**: If you find a bug, please report it via [an issue on GitHub](https://github.com/datasharingframework/dsf/issues). Detailed bug reports are incredibly helpful. - * **Reproduction steps**: Include steps to reproduce the bug and any relevant logs according to our bug report issue template. -6. **Contributing feature requests**: - * **Suggest features**: You have an idea for a new feature? We'd love to hear it! Open an issue to describe your proposed feature and its potential benefits according to our feature request template. - * **Collaborate on implementation**: If you're able to, contribute to the development of your proposed feature or bug fix. Collaboration can lead to more innovative and effective solutions. Please checkout our [Getting started guide for code contributions](./code) to DSF. -7. **Contributing process plugins**: - * **Develop process plugins for the DSF**: If you have ideas for a process plugin, we encourage you to develop and contribute them. Our [Getting started guide for process plugin development](https://dsf.dev/stable/develop/) will be a useful reference. - * **Share your work**: Your plugins could be a valuable addition to the ecosystem and benefit other users. - -Before you start contributing, we recommend reading our getting started guidelines for detailed information on our processes and standards. This ensures a smooth and productive experience for everyone involved. - -**Your contributions in any form, are what drives the continuous growth and improvement of this project. Thank you for being a part of our community and for your willingness to contribute!** \ No newline at end of file diff --git a/docs/src/operations/v1.5.2/develop/README.md b/docs/src/operations/v1.5.2/develop/README.md deleted file mode 100644 index 7c7613cb5..000000000 --- a/docs/src/operations/v1.5.2/develop/README.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Develop Process Plugins -icon: plugin ---- -## Overview -- [Create a new process plugin](create) -- [Upgrade processes from 0.9.x](upgrade-from-0) \ No newline at end of file diff --git a/docs/src/operations/v1.5.2/develop/create.md b/docs/src/operations/v1.5.2/develop/create.md deleted file mode 100644 index 13f5b32bc..000000000 --- a/docs/src/operations/v1.5.2/develop/create.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: Create a new process plugin -icon: code ---- - -Visit the [how the DSF can help you](../../for-you/) page to get started. - - -::: 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) -::: \ No newline at end of file diff --git a/docs/src/operations/v1.5.2/develop/upgrade-from-0.md b/docs/src/operations/v1.5.2/develop/upgrade-from-0.md deleted file mode 100644 index d27d7a228..000000000 --- a/docs/src/operations/v1.5.2/develop/upgrade-from-0.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -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) -::: \ No newline at end of file diff --git a/docs/src/operations/v1.5.2/maintain/fhir-reverse-proxy/README.md b/docs/src/operations/v1.5.2/fhir-reverse-proxy/README.md similarity index 100% rename from docs/src/operations/v1.5.2/maintain/fhir-reverse-proxy/README.md rename to docs/src/operations/v1.5.2/fhir-reverse-proxy/README.md diff --git a/docs/src/operations/v1.5.2/maintain/fhir-reverse-proxy/configuration.md b/docs/src/operations/v1.5.2/fhir-reverse-proxy/configuration.md similarity index 100% rename from docs/src/operations/v1.5.2/maintain/fhir-reverse-proxy/configuration.md rename to docs/src/operations/v1.5.2/fhir-reverse-proxy/configuration.md diff --git a/docs/src/operations/v1.5.2/maintain/fhir/README.md b/docs/src/operations/v1.5.2/fhir/README.md similarity index 100% rename from docs/src/operations/v1.5.2/maintain/fhir/README.md rename to docs/src/operations/v1.5.2/fhir/README.md diff --git a/docs/src/operations/v1.5.2/maintain/fhir/access-control.md b/docs/src/operations/v1.5.2/fhir/access-control.md similarity index 100% rename from docs/src/operations/v1.5.2/maintain/fhir/access-control.md rename to docs/src/operations/v1.5.2/fhir/access-control.md diff --git a/docs/src/operations/v1.5.2/maintain/fhir/configuration.md b/docs/src/operations/v1.5.2/fhir/configuration.md similarity index 100% rename from docs/src/operations/v1.5.2/maintain/fhir/configuration.md rename to docs/src/operations/v1.5.2/fhir/configuration.md diff --git a/docs/src/operations/v1.5.2/maintain/fhir/oidc.md b/docs/src/operations/v1.5.2/fhir/oidc.md similarity index 100% rename from docs/src/operations/v1.5.2/maintain/fhir/oidc.md rename to docs/src/operations/v1.5.2/fhir/oidc.md diff --git a/docs/src/operations/v1.5.2/index.md b/docs/src/operations/v1.5.2/index.md index e77892c03..cf0a4673f 100644 --- a/docs/src/operations/v1.5.2/index.md +++ b/docs/src/operations/v1.5.2/index.md @@ -10,17 +10,11 @@ This is a major DSF release not compatible with 0.9.x and older version develope # System Administrators -- [Install DSF 1.5.2](maintain/install) -- [Upgrade from DSF 1.5.1](maintain/upgrade-from-1) -- [Upgrade from DSF 0.9.x.](maintain/upgrade-from-0) +- [Install DSF 1.5.2](install) +- [Upgrade from DSF 1.5.1](upgrade-from-1) +- [Upgrade from DSF 0.9.x.](upgrade-from-0) - - -# 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 diff --git a/docs/src/operations/v1.5.2/maintain/install-plugins.md b/docs/src/operations/v1.5.2/install-plugins.md similarity index 100% rename from docs/src/operations/v1.5.2/maintain/install-plugins.md rename to docs/src/operations/v1.5.2/install-plugins.md diff --git a/docs/src/operations/v1.5.2/maintain/install.md b/docs/src/operations/v1.5.2/install.md similarity index 100% rename from docs/src/operations/v1.5.2/maintain/install.md rename to docs/src/operations/v1.5.2/install.md diff --git a/docs/src/operations/v1.5.2/maintain/README.md b/docs/src/operations/v1.5.2/maintain/README.md deleted file mode 100644 index 5ad9f1c58..000000000 --- a/docs/src/operations/v1.5.2/maintain/README.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Maintain a DSF instance -icon: tool ---- -## Overview -- [Install DSF 1.5.2](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 Reverse Proxy - - [Configuration Parameters](bpe-reverse-proxy/configuration) -- BPE Server - - [Configuration Parameters](bpe/configuration) - - [Access Control](bpe/access-control) - - [OpenID Connect](bpe/oidc) diff --git a/docs/src/operations/v1.5.2/maintain/upgrade-from-0.md b/docs/src/operations/v1.5.2/upgrade-from-0.md similarity index 100% rename from docs/src/operations/v1.5.2/maintain/upgrade-from-0.md rename to docs/src/operations/v1.5.2/upgrade-from-0.md diff --git a/docs/src/operations/v1.5.2/maintain/upgrade-from-1.md b/docs/src/operations/v1.5.2/upgrade-from-1.md similarity index 100% rename from docs/src/operations/v1.5.2/maintain/upgrade-from-1.md rename to docs/src/operations/v1.5.2/upgrade-from-1.md diff --git a/docs/src/operations/v1.6.0/maintain/allowList-mgm.md b/docs/src/operations/v1.6.0/allowList-mgm.md similarity index 100% rename from docs/src/operations/v1.6.0/maintain/allowList-mgm.md rename to docs/src/operations/v1.6.0/allowList-mgm.md diff --git a/docs/src/operations/v1.6.0/maintain/bpe-reverse-proxy/README.md b/docs/src/operations/v1.6.0/bpe-reverse-proxy/README.md similarity index 100% rename from docs/src/operations/v1.6.0/maintain/bpe-reverse-proxy/README.md rename to docs/src/operations/v1.6.0/bpe-reverse-proxy/README.md diff --git a/docs/src/operations/v1.6.0/maintain/bpe-reverse-proxy/configuration.md b/docs/src/operations/v1.6.0/bpe-reverse-proxy/configuration.md similarity index 100% rename from docs/src/operations/v1.6.0/maintain/bpe-reverse-proxy/configuration.md rename to docs/src/operations/v1.6.0/bpe-reverse-proxy/configuration.md diff --git a/docs/src/operations/v1.6.0/maintain/bpe/README.md b/docs/src/operations/v1.6.0/bpe/README.md similarity index 100% rename from docs/src/operations/v1.6.0/maintain/bpe/README.md rename to docs/src/operations/v1.6.0/bpe/README.md diff --git a/docs/src/operations/v1.6.0/maintain/bpe/access-control.md b/docs/src/operations/v1.6.0/bpe/access-control.md similarity index 100% rename from docs/src/operations/v1.6.0/maintain/bpe/access-control.md rename to docs/src/operations/v1.6.0/bpe/access-control.md diff --git a/docs/src/operations/v1.6.0/maintain/bpe/configuration.md b/docs/src/operations/v1.6.0/bpe/configuration.md similarity index 100% rename from docs/src/operations/v1.6.0/maintain/bpe/configuration.md rename to docs/src/operations/v1.6.0/bpe/configuration.md diff --git a/docs/src/operations/v1.6.0/maintain/bpe/oidc.md b/docs/src/operations/v1.6.0/bpe/oidc.md similarity index 100% rename from docs/src/operations/v1.6.0/maintain/bpe/oidc.md rename to docs/src/operations/v1.6.0/bpe/oidc.md diff --git a/docs/src/operations/v1.6.0/contribute/code.md b/docs/src/operations/v1.6.0/contribute/code.md deleted file mode 100644 index b4f16ba6e..000000000 --- a/docs/src/operations/v1.6.0/contribute/code.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -title: Contribute code -icon: info ---- - -Your code can make a difference for the Data Sharing Framework (DSF). We invite all users to share their code, tests, scripts and improvement ideas. Contributions of any size enhance the DSF and support the data sharing framework community. - -### Benefits of Contributing: -- Foster community growth and diversification. -- Sharpen your coding skills. -- Gain recognition in the DSF community. -- Directly impact the future of data sharing in medicine. - -Start now by visiting our contribution pages. Every line of code helps us build a stronger and more versatile DSF. - -## General - -### Code style - -You can import our code style for your specific IDE: - -* [Eclipse](https://github.com/datasharingframework/dsf/blob/main/src/main/resources/eclipse-formatter-config.xml). Open your preferences, click on `Java`, `Code style`, `Formatter`, `Import` and select the downloaded file. -* [IntelliJ](https://github.com/datasharingframework/dsf/blob/main/src/main/resources/intellij-formatter-config.xml). Open your settings, click on `Editor`, `Code style`, `Java`, the settings icon, `import scheme`, `IntelliJ` and select the downloaded file. - -Pull requests will only be approved if the code is formatted according to the code style configurations above. To format the code with maven before pushing to GitHub, use `mvn compile -Pformat-and-sort`. - -### Branching strategy - -[Git Flow](https://www.atlassian.com/de/git/tutorials/comparing-workflows/gitflow-workflow) is used as this project's branching strategy. Therefore, you will find the following structure: - -* main -* develop -* issue -* hotfix -* release - -Notice that only the first two elements listed are actual branches. The other elements are containers to hold all branches belonging to that category. - - -#### Branch naming - -The following ruleset is applied to name branches: - -* `issue/_` -* `hotfix/` -* `release/` - -## Setting up the project - -This chapter lists all important requirements to get the project buildable and running properly. - -### Java - -This project uses Java JDK 17, so make sure you have it installed on your system. - -### Docker - -[Docker](https://www.docker.com/) is used in this project to test database functionality and to run more complex test-setups. - -### Maven - -The project relies on [Maven](https://maven.apache.org/) as its management tool. -*Important:* When building the project you might encounter the following error: -*Could not determine gpg version* [GPG](https://gnupg.org/) is used to sign artifacts for public release. Since this does not concern contributors, you may skip this step in the maven build process with `-Dgpg.skip`. - - -## Workflow - -1. Create an issue or comment on an issue that you want to contribute some feature -2. Fork the repository, create a branch and mention it in the issue -3. If you desire feedback, create a pull request or comment on it in the issue. Feel free to @ any member with write permissions if you feel like your request has not been registered yet. They will review your changes and/or change requests -4. If your changes are production-ready, create a [pull request](https://github.com/datasharingframework/dsf/pulls). - -### Pull request process - -We follow Martin Fowler's method for managing pull requests. This approach categorizes pull requests based on the level of trust and experience of the contributor, as well as the impact of the changes. Here's how we apply it: - -1. **Ship**: For our most trusted contributors with a proven track record. These members can merge their pull requests without prior review, typically for minor or highly confident changes. - -2. **Show**: This level is for trusted contributors who need some oversight, as well as for experienced developers who want to demonstrate how certain changes should be made in the future. They create pull requests and show their work to the team. - -3. **Ask**: New or less experienced contributors, as well as those submitting more complex changes, fall into this category. They are required to ask for feedback and approval before their changes can be merged, ensuring thorough review and quality control. - - -This method helps us maintain a balance between code quality and efficient development, recognizing the varying levels of expertise among our contributors. - -For more information on Fowler's approach, visit [Martin Fowler's article on Pull Requests](https://martinfowler.com/articles/ship-show-ask.html). - - -## Data Security in DSF Development - -The DSF (Data Sharing Framework) and its process plugins are frequently used to transmit sensitive personal data. To prevent the release of personal data during development, please adhere to the following guidelines: - -- **No development with real personal data:** Always use anonymized or synthetic data for development purposes. -- **No personal data in repositories:** Ensure no personal data is present in local and remote repositories intended for publication, not even temporarily. -- **Review all log files:** Before using log files in issues, examples, etc., thoroughly review them to ensure no personal and sensitive data is included. - diff --git a/docs/src/operations/v1.6.0/contribute/documentation.md b/docs/src/operations/v1.6.0/contribute/documentation.md deleted file mode 100644 index afbaf5511..000000000 --- a/docs/src/operations/v1.6.0/contribute/documentation.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: Contribute documentation -icon: info ---- - -**Join us in enhancing our documentation!** - -We believe in the power of community collaboration to make our documentation clearer, more comprehensive, and more user-friendly. There are several ways you can contribute, and we welcome greatly your input! - - -1. **Contact us with feedback**: If you find any of our documentation unclear or if you think there's a topic not covered yet, please don't hesitate to reach out to us. Your perspective as a reader is invaluable in helping us to identify areas for improvement. -2. **Create an issue**: You noticed something that needs fixing or you have a suggestion? Head over to our GitHub repository at [Data Sharing Framework Documentation](https://github.com/datasharingframework/datasharingframework.github.io/issues) and please create an issue. This way, our team and other contributors can track and address documentation changes systematically. -3. **Contribute directly with a pull request**: If you're feeling proactive and want to make direct changes, you're more than welcome to submit a pull request. Visit our GitHub repository at [Data Sharing Framework Documentation](https://github.com/datasharingframework/datasharingframework.github.io) and feel free to propose your changes. Whether it's a typo fix, a new section, or enhanced explanations, every contribution counts. - -We're excited to see your suggestions and are grateful for every contribution that helps us improve. Let's build better documentation together! \ No newline at end of file diff --git a/docs/src/operations/v1.6.0/contribute/readme.md b/docs/src/operations/v1.6.0/contribute/readme.md deleted file mode 100644 index bbacced29..000000000 --- a/docs/src/operations/v1.6.0/contribute/readme.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: Contribute -icon: info ---- - -We are thrilled that you consider contributing to our projects. Your contributions, big or small, are greatly valued and play a significant role in the success and improvement of our work. Whether you're a seasoned developer or just starting out, there's a place for you here to make a meaningful impact. - -### **Ways you can contribute:** - - -1. **Helping other users**: - * **MII Zulip**: If you are part of the German Medical Informatics Initiative, [join the MII Zulip community](https://mii.zulipchat.com/#narrow/stream/392426-Data-Sharing-Framework-.28DSF.29) to assist others, share your knowledge, and learn from fellow contributors. - * **GitHub Discussions**: Engage with our community in [GitHub Discussions](https://github.com/datasharingframework/dsf/discussions) by answering questions, providing feedback, and sharing your insights. -2. **Testing releases**: - * **Stay ahead**: Help us testing the latest releases. Your feedback on functionality, bugs, and user experience is invaluable. - * **Report findings**: Share your testing results to help us refine and enhance our releases. -3. **Reviewing changes**: - * **Peer review**: Contribute by reviewing pull requests. Your insights can help ensure the quality and integrity of code changes. - * **Constructive feedback**: Offer constructive feedback and suggestions to help improve and refine proposed changes. -4. **Documentation changes**: - * **Improve documentation**: Help us improving and updating our documentation. Clear and accurate documentation is crucial for user understanding and success. Please checkout our [Getting started guide for documentation contributions](./documentation) to DSF. - * **Suggest improvements**: If you notice gaps or areas for enhancement in our documentation, we welcome [your suggestions and contributions](https://github.com/datasharingframework/datasharingframework.github.io). -5. **Contributing bug reports**: - * **Report bugs**: If you find a bug, please report it via [an issue on GitHub](https://github.com/datasharingframework/dsf/issues). Detailed bug reports are incredibly helpful. - * **Reproduction steps**: Include steps to reproduce the bug and any relevant logs according to our bug report issue template. -6. **Contributing feature requests**: - * **Suggest features**: You have an idea for a new feature? We'd love to hear it! Open an issue to describe your proposed feature and its potential benefits according to our feature request template. - * **Collaborate on implementation**: If you're able to, contribute to the development of your proposed feature or bug fix. Collaboration can lead to more innovative and effective solutions. Please checkout our [Getting started guide for code contributions](./code) to DSF. -7. **Contributing process plugins**: - * **Develop process plugins for the DSF**: If you have ideas for a process plugin, we encourage you to develop and contribute them. Our [Getting started guide for process plugin development](https://dsf.dev/stable/develop/) will be a useful reference. - * **Share your work**: Your plugins could be a valuable addition to the ecosystem and benefit other users. - -Before you start contributing, we recommend reading our getting started guidelines for detailed information on our processes and standards. This ensures a smooth and productive experience for everyone involved. - -**Your contributions in any form, are what drives the continuous growth and improvement of this project. Thank you for being a part of our community and for your willingness to contribute!** \ No newline at end of file diff --git a/docs/src/operations/v1.6.0/develop/README.md b/docs/src/operations/v1.6.0/develop/README.md deleted file mode 100644 index 7c7613cb5..000000000 --- a/docs/src/operations/v1.6.0/develop/README.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Develop Process Plugins -icon: plugin ---- -## Overview -- [Create a new process plugin](create) -- [Upgrade processes from 0.9.x](upgrade-from-0) \ No newline at end of file diff --git a/docs/src/operations/v1.6.0/develop/create.md b/docs/src/operations/v1.6.0/develop/create.md deleted file mode 100644 index 13f5b32bc..000000000 --- a/docs/src/operations/v1.6.0/develop/create.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: Create a new process plugin -icon: code ---- - -Visit the [how the DSF can help you](../../for-you/) page to get started. - - -::: 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) -::: \ No newline at end of file diff --git a/docs/src/operations/v1.6.0/develop/upgrade-from-0.md b/docs/src/operations/v1.6.0/develop/upgrade-from-0.md deleted file mode 100644 index d27d7a228..000000000 --- a/docs/src/operations/v1.6.0/develop/upgrade-from-0.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -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) -::: \ No newline at end of file diff --git a/docs/src/operations/v1.6.0/maintain/fhir-reverse-proxy/README.md b/docs/src/operations/v1.6.0/fhir-reverse-proxy/README.md similarity index 100% rename from docs/src/operations/v1.6.0/maintain/fhir-reverse-proxy/README.md rename to docs/src/operations/v1.6.0/fhir-reverse-proxy/README.md diff --git a/docs/src/operations/v1.6.0/maintain/fhir-reverse-proxy/configuration.md b/docs/src/operations/v1.6.0/fhir-reverse-proxy/configuration.md similarity index 100% rename from docs/src/operations/v1.6.0/maintain/fhir-reverse-proxy/configuration.md rename to docs/src/operations/v1.6.0/fhir-reverse-proxy/configuration.md diff --git a/docs/src/operations/v1.6.0/maintain/fhir/README.md b/docs/src/operations/v1.6.0/fhir/README.md similarity index 100% rename from docs/src/operations/v1.6.0/maintain/fhir/README.md rename to docs/src/operations/v1.6.0/fhir/README.md diff --git a/docs/src/operations/v1.6.0/maintain/fhir/access-control.md b/docs/src/operations/v1.6.0/fhir/access-control.md similarity index 100% rename from docs/src/operations/v1.6.0/maintain/fhir/access-control.md rename to docs/src/operations/v1.6.0/fhir/access-control.md diff --git a/docs/src/operations/v1.6.0/maintain/fhir/configuration.md b/docs/src/operations/v1.6.0/fhir/configuration.md similarity index 100% rename from docs/src/operations/v1.6.0/maintain/fhir/configuration.md rename to docs/src/operations/v1.6.0/fhir/configuration.md diff --git a/docs/src/operations/v1.6.0/maintain/fhir/oidc.md b/docs/src/operations/v1.6.0/fhir/oidc.md similarity index 100% rename from docs/src/operations/v1.6.0/maintain/fhir/oidc.md rename to docs/src/operations/v1.6.0/fhir/oidc.md diff --git a/docs/src/operations/v1.6.0/index.md b/docs/src/operations/v1.6.0/index.md index 5ff162fb1..c6fd7525f 100644 --- a/docs/src/operations/v1.6.0/index.md +++ b/docs/src/operations/v1.6.0/index.md @@ -10,14 +10,11 @@ This is a major DSF release not compatible with 0.9.x and older version develope # System Administrators -- [Install DSF 1.6.0](maintain/install) -- [Upgrade from DSF 1.5.2](maintain/upgrade-from-1) -- [Upgrade from DSF 0.9.x.](maintain/upgrade-from-0) +- [Install DSF 1.6.0](install) +- [Upgrade from DSF 1.5.2](upgrade-from-1) +- [Upgrade from DSF 0.9.x.](upgrade-from-0) -# 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 diff --git a/docs/src/operations/v1.6.0/maintain/install-plugins.md b/docs/src/operations/v1.6.0/install-plugins.md similarity index 100% rename from docs/src/operations/v1.6.0/maintain/install-plugins.md rename to docs/src/operations/v1.6.0/install-plugins.md diff --git a/docs/src/operations/v1.6.0/maintain/install.md b/docs/src/operations/v1.6.0/install.md similarity index 100% rename from docs/src/operations/v1.6.0/maintain/install.md rename to docs/src/operations/v1.6.0/install.md diff --git a/docs/src/operations/v1.6.0/maintain/README.md b/docs/src/operations/v1.6.0/maintain/README.md deleted file mode 100644 index feaa5ec06..000000000 --- a/docs/src/operations/v1.6.0/maintain/README.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Maintain a DSF instance -icon: tool ---- -## Overview -- [Install DSF 1.6.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 Reverse Proxy - - [Configuration Parameters](bpe-reverse-proxy/configuration) -- BPE Server - - [Configuration Parameters](bpe/configuration) - - [Access Control](bpe/access-control) - - [OpenID Connect](bpe/oidc) diff --git a/docs/src/operations/v1.6.0/maintain/upgrade-from-0.md b/docs/src/operations/v1.6.0/upgrade-from-0.md similarity index 100% rename from docs/src/operations/v1.6.0/maintain/upgrade-from-0.md rename to docs/src/operations/v1.6.0/upgrade-from-0.md diff --git a/docs/src/operations/v1.6.0/maintain/upgrade-from-1.md b/docs/src/operations/v1.6.0/upgrade-from-1.md similarity index 100% rename from docs/src/operations/v1.6.0/maintain/upgrade-from-1.md rename to docs/src/operations/v1.6.0/upgrade-from-1.md diff --git a/docs/src/operations/v1.7.0/maintain/allowList-mgm.md b/docs/src/operations/v1.7.0/allowList-mgm.md similarity index 100% rename from docs/src/operations/v1.7.0/maintain/allowList-mgm.md rename to docs/src/operations/v1.7.0/allowList-mgm.md diff --git a/docs/src/operations/v1.7.0/maintain/bpe-reverse-proxy/README.md b/docs/src/operations/v1.7.0/bpe-reverse-proxy/README.md similarity index 100% rename from docs/src/operations/v1.7.0/maintain/bpe-reverse-proxy/README.md rename to docs/src/operations/v1.7.0/bpe-reverse-proxy/README.md diff --git a/docs/src/operations/v1.7.0/maintain/bpe-reverse-proxy/configuration.md b/docs/src/operations/v1.7.0/bpe-reverse-proxy/configuration.md similarity index 100% rename from docs/src/operations/v1.7.0/maintain/bpe-reverse-proxy/configuration.md rename to docs/src/operations/v1.7.0/bpe-reverse-proxy/configuration.md diff --git a/docs/src/operations/v1.7.0/maintain/bpe/README.md b/docs/src/operations/v1.7.0/bpe/README.md similarity index 100% rename from docs/src/operations/v1.7.0/maintain/bpe/README.md rename to docs/src/operations/v1.7.0/bpe/README.md diff --git a/docs/src/operations/v1.7.0/maintain/bpe/access-control.md b/docs/src/operations/v1.7.0/bpe/access-control.md similarity index 100% rename from docs/src/operations/v1.7.0/maintain/bpe/access-control.md rename to docs/src/operations/v1.7.0/bpe/access-control.md diff --git a/docs/src/operations/v1.7.0/maintain/bpe/configuration.md b/docs/src/operations/v1.7.0/bpe/configuration.md similarity index 100% rename from docs/src/operations/v1.7.0/maintain/bpe/configuration.md rename to docs/src/operations/v1.7.0/bpe/configuration.md diff --git a/docs/src/operations/v1.7.0/maintain/bpe/oidc.md b/docs/src/operations/v1.7.0/bpe/oidc.md similarity index 100% rename from docs/src/operations/v1.7.0/maintain/bpe/oidc.md rename to docs/src/operations/v1.7.0/bpe/oidc.md diff --git a/docs/src/operations/v1.7.0/contribute/code.md b/docs/src/operations/v1.7.0/contribute/code.md deleted file mode 100644 index b4f16ba6e..000000000 --- a/docs/src/operations/v1.7.0/contribute/code.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -title: Contribute code -icon: info ---- - -Your code can make a difference for the Data Sharing Framework (DSF). We invite all users to share their code, tests, scripts and improvement ideas. Contributions of any size enhance the DSF and support the data sharing framework community. - -### Benefits of Contributing: -- Foster community growth and diversification. -- Sharpen your coding skills. -- Gain recognition in the DSF community. -- Directly impact the future of data sharing in medicine. - -Start now by visiting our contribution pages. Every line of code helps us build a stronger and more versatile DSF. - -## General - -### Code style - -You can import our code style for your specific IDE: - -* [Eclipse](https://github.com/datasharingframework/dsf/blob/main/src/main/resources/eclipse-formatter-config.xml). Open your preferences, click on `Java`, `Code style`, `Formatter`, `Import` and select the downloaded file. -* [IntelliJ](https://github.com/datasharingframework/dsf/blob/main/src/main/resources/intellij-formatter-config.xml). Open your settings, click on `Editor`, `Code style`, `Java`, the settings icon, `import scheme`, `IntelliJ` and select the downloaded file. - -Pull requests will only be approved if the code is formatted according to the code style configurations above. To format the code with maven before pushing to GitHub, use `mvn compile -Pformat-and-sort`. - -### Branching strategy - -[Git Flow](https://www.atlassian.com/de/git/tutorials/comparing-workflows/gitflow-workflow) is used as this project's branching strategy. Therefore, you will find the following structure: - -* main -* develop -* issue -* hotfix -* release - -Notice that only the first two elements listed are actual branches. The other elements are containers to hold all branches belonging to that category. - - -#### Branch naming - -The following ruleset is applied to name branches: - -* `issue/_` -* `hotfix/` -* `release/` - -## Setting up the project - -This chapter lists all important requirements to get the project buildable and running properly. - -### Java - -This project uses Java JDK 17, so make sure you have it installed on your system. - -### Docker - -[Docker](https://www.docker.com/) is used in this project to test database functionality and to run more complex test-setups. - -### Maven - -The project relies on [Maven](https://maven.apache.org/) as its management tool. -*Important:* When building the project you might encounter the following error: -*Could not determine gpg version* [GPG](https://gnupg.org/) is used to sign artifacts for public release. Since this does not concern contributors, you may skip this step in the maven build process with `-Dgpg.skip`. - - -## Workflow - -1. Create an issue or comment on an issue that you want to contribute some feature -2. Fork the repository, create a branch and mention it in the issue -3. If you desire feedback, create a pull request or comment on it in the issue. Feel free to @ any member with write permissions if you feel like your request has not been registered yet. They will review your changes and/or change requests -4. If your changes are production-ready, create a [pull request](https://github.com/datasharingframework/dsf/pulls). - -### Pull request process - -We follow Martin Fowler's method for managing pull requests. This approach categorizes pull requests based on the level of trust and experience of the contributor, as well as the impact of the changes. Here's how we apply it: - -1. **Ship**: For our most trusted contributors with a proven track record. These members can merge their pull requests without prior review, typically for minor or highly confident changes. - -2. **Show**: This level is for trusted contributors who need some oversight, as well as for experienced developers who want to demonstrate how certain changes should be made in the future. They create pull requests and show their work to the team. - -3. **Ask**: New or less experienced contributors, as well as those submitting more complex changes, fall into this category. They are required to ask for feedback and approval before their changes can be merged, ensuring thorough review and quality control. - - -This method helps us maintain a balance between code quality and efficient development, recognizing the varying levels of expertise among our contributors. - -For more information on Fowler's approach, visit [Martin Fowler's article on Pull Requests](https://martinfowler.com/articles/ship-show-ask.html). - - -## Data Security in DSF Development - -The DSF (Data Sharing Framework) and its process plugins are frequently used to transmit sensitive personal data. To prevent the release of personal data during development, please adhere to the following guidelines: - -- **No development with real personal data:** Always use anonymized or synthetic data for development purposes. -- **No personal data in repositories:** Ensure no personal data is present in local and remote repositories intended for publication, not even temporarily. -- **Review all log files:** Before using log files in issues, examples, etc., thoroughly review them to ensure no personal and sensitive data is included. - diff --git a/docs/src/operations/v1.7.0/contribute/documentation.md b/docs/src/operations/v1.7.0/contribute/documentation.md deleted file mode 100644 index afbaf5511..000000000 --- a/docs/src/operations/v1.7.0/contribute/documentation.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: Contribute documentation -icon: info ---- - -**Join us in enhancing our documentation!** - -We believe in the power of community collaboration to make our documentation clearer, more comprehensive, and more user-friendly. There are several ways you can contribute, and we welcome greatly your input! - - -1. **Contact us with feedback**: If you find any of our documentation unclear or if you think there's a topic not covered yet, please don't hesitate to reach out to us. Your perspective as a reader is invaluable in helping us to identify areas for improvement. -2. **Create an issue**: You noticed something that needs fixing or you have a suggestion? Head over to our GitHub repository at [Data Sharing Framework Documentation](https://github.com/datasharingframework/datasharingframework.github.io/issues) and please create an issue. This way, our team and other contributors can track and address documentation changes systematically. -3. **Contribute directly with a pull request**: If you're feeling proactive and want to make direct changes, you're more than welcome to submit a pull request. Visit our GitHub repository at [Data Sharing Framework Documentation](https://github.com/datasharingframework/datasharingframework.github.io) and feel free to propose your changes. Whether it's a typo fix, a new section, or enhanced explanations, every contribution counts. - -We're excited to see your suggestions and are grateful for every contribution that helps us improve. Let's build better documentation together! \ No newline at end of file diff --git a/docs/src/operations/v1.7.0/contribute/readme.md b/docs/src/operations/v1.7.0/contribute/readme.md deleted file mode 100644 index bbacced29..000000000 --- a/docs/src/operations/v1.7.0/contribute/readme.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: Contribute -icon: info ---- - -We are thrilled that you consider contributing to our projects. Your contributions, big or small, are greatly valued and play a significant role in the success and improvement of our work. Whether you're a seasoned developer or just starting out, there's a place for you here to make a meaningful impact. - -### **Ways you can contribute:** - - -1. **Helping other users**: - * **MII Zulip**: If you are part of the German Medical Informatics Initiative, [join the MII Zulip community](https://mii.zulipchat.com/#narrow/stream/392426-Data-Sharing-Framework-.28DSF.29) to assist others, share your knowledge, and learn from fellow contributors. - * **GitHub Discussions**: Engage with our community in [GitHub Discussions](https://github.com/datasharingframework/dsf/discussions) by answering questions, providing feedback, and sharing your insights. -2. **Testing releases**: - * **Stay ahead**: Help us testing the latest releases. Your feedback on functionality, bugs, and user experience is invaluable. - * **Report findings**: Share your testing results to help us refine and enhance our releases. -3. **Reviewing changes**: - * **Peer review**: Contribute by reviewing pull requests. Your insights can help ensure the quality and integrity of code changes. - * **Constructive feedback**: Offer constructive feedback and suggestions to help improve and refine proposed changes. -4. **Documentation changes**: - * **Improve documentation**: Help us improving and updating our documentation. Clear and accurate documentation is crucial for user understanding and success. Please checkout our [Getting started guide for documentation contributions](./documentation) to DSF. - * **Suggest improvements**: If you notice gaps or areas for enhancement in our documentation, we welcome [your suggestions and contributions](https://github.com/datasharingframework/datasharingframework.github.io). -5. **Contributing bug reports**: - * **Report bugs**: If you find a bug, please report it via [an issue on GitHub](https://github.com/datasharingframework/dsf/issues). Detailed bug reports are incredibly helpful. - * **Reproduction steps**: Include steps to reproduce the bug and any relevant logs according to our bug report issue template. -6. **Contributing feature requests**: - * **Suggest features**: You have an idea for a new feature? We'd love to hear it! Open an issue to describe your proposed feature and its potential benefits according to our feature request template. - * **Collaborate on implementation**: If you're able to, contribute to the development of your proposed feature or bug fix. Collaboration can lead to more innovative and effective solutions. Please checkout our [Getting started guide for code contributions](./code) to DSF. -7. **Contributing process plugins**: - * **Develop process plugins for the DSF**: If you have ideas for a process plugin, we encourage you to develop and contribute them. Our [Getting started guide for process plugin development](https://dsf.dev/stable/develop/) will be a useful reference. - * **Share your work**: Your plugins could be a valuable addition to the ecosystem and benefit other users. - -Before you start contributing, we recommend reading our getting started guidelines for detailed information on our processes and standards. This ensures a smooth and productive experience for everyone involved. - -**Your contributions in any form, are what drives the continuous growth and improvement of this project. Thank you for being a part of our community and for your willingness to contribute!** \ No newline at end of file diff --git a/docs/src/operations/v1.7.0/develop/README.md b/docs/src/operations/v1.7.0/develop/README.md deleted file mode 100644 index 7c7613cb5..000000000 --- a/docs/src/operations/v1.7.0/develop/README.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Develop Process Plugins -icon: plugin ---- -## Overview -- [Create a new process plugin](create) -- [Upgrade processes from 0.9.x](upgrade-from-0) \ No newline at end of file diff --git a/docs/src/operations/v1.7.0/develop/create.md b/docs/src/operations/v1.7.0/develop/create.md deleted file mode 100644 index 13f5b32bc..000000000 --- a/docs/src/operations/v1.7.0/develop/create.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: Create a new process plugin -icon: code ---- - -Visit the [how the DSF can help you](../../for-you/) page to get started. - - -::: 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) -::: \ No newline at end of file diff --git a/docs/src/operations/v1.7.0/develop/upgrade-from-0.md b/docs/src/operations/v1.7.0/develop/upgrade-from-0.md deleted file mode 100644 index d27d7a228..000000000 --- a/docs/src/operations/v1.7.0/develop/upgrade-from-0.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -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) -::: \ No newline at end of file diff --git a/docs/src/operations/v1.7.0/maintain/fhir-reverse-proxy/README.md b/docs/src/operations/v1.7.0/fhir-reverse-proxy/README.md similarity index 100% rename from docs/src/operations/v1.7.0/maintain/fhir-reverse-proxy/README.md rename to docs/src/operations/v1.7.0/fhir-reverse-proxy/README.md diff --git a/docs/src/operations/v1.7.0/maintain/fhir-reverse-proxy/configuration.md b/docs/src/operations/v1.7.0/fhir-reverse-proxy/configuration.md similarity index 100% rename from docs/src/operations/v1.7.0/maintain/fhir-reverse-proxy/configuration.md rename to docs/src/operations/v1.7.0/fhir-reverse-proxy/configuration.md diff --git a/docs/src/operations/v1.7.0/maintain/fhir/README.md b/docs/src/operations/v1.7.0/fhir/README.md similarity index 100% rename from docs/src/operations/v1.7.0/maintain/fhir/README.md rename to docs/src/operations/v1.7.0/fhir/README.md diff --git a/docs/src/operations/v1.7.0/maintain/fhir/access-control.md b/docs/src/operations/v1.7.0/fhir/access-control.md similarity index 100% rename from docs/src/operations/v1.7.0/maintain/fhir/access-control.md rename to docs/src/operations/v1.7.0/fhir/access-control.md diff --git a/docs/src/operations/v1.7.0/maintain/fhir/configuration.md b/docs/src/operations/v1.7.0/fhir/configuration.md similarity index 100% rename from docs/src/operations/v1.7.0/maintain/fhir/configuration.md rename to docs/src/operations/v1.7.0/fhir/configuration.md diff --git a/docs/src/operations/v1.7.0/maintain/fhir/oidc.md b/docs/src/operations/v1.7.0/fhir/oidc.md similarity index 100% rename from docs/src/operations/v1.7.0/maintain/fhir/oidc.md rename to docs/src/operations/v1.7.0/fhir/oidc.md diff --git a/docs/src/operations/v1.7.0/index.md b/docs/src/operations/v1.7.0/index.md index 0aab56b03..5f1984c5d 100644 --- a/docs/src/operations/v1.7.0/index.md +++ b/docs/src/operations/v1.7.0/index.md @@ -10,16 +10,11 @@ This is a major DSF release not compatible with 0.9.x and older version develope # System Administrators -- [Install DSF 1.7.0](maintain/install) -- [Upgrade from DSF 1.6.0](maintain/upgrade-from-1) -- [Upgrade from DSF 0.9.x.](maintain/upgrade-from-0) +- [Install DSF 1.7.0](install) +- [Upgrade from DSF 1.6.0](upgrade-from-1) +- [Upgrade from DSF 0.9.x.](upgrade-from-0) - -# 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 diff --git a/docs/src/operations/v1.7.0/maintain/install-plugins.md b/docs/src/operations/v1.7.0/install-plugins.md similarity index 100% rename from docs/src/operations/v1.7.0/maintain/install-plugins.md rename to docs/src/operations/v1.7.0/install-plugins.md diff --git a/docs/src/operations/v1.7.0/maintain/install.md b/docs/src/operations/v1.7.0/install.md similarity index 100% rename from docs/src/operations/v1.7.0/maintain/install.md rename to docs/src/operations/v1.7.0/install.md diff --git a/docs/src/operations/v1.7.0/maintain/README.md b/docs/src/operations/v1.7.0/maintain/README.md deleted file mode 100644 index 79179316e..000000000 --- a/docs/src/operations/v1.7.0/maintain/README.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Maintain a DSF instance -icon: tool ---- -## Overview -- [Install DSF 1.7.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 Reverse Proxy - - [Configuration Parameters](bpe-reverse-proxy/configuration) -- BPE Server - - [Configuration Parameters](bpe/configuration) - - [Access Control](bpe/access-control) - - [OpenID Connect](bpe/oidc) diff --git a/docs/src/operations/v1.7.0/maintain/passwords-secrets.md b/docs/src/operations/v1.7.0/passwords-secrets.md similarity index 100% rename from docs/src/operations/v1.7.0/maintain/passwords-secrets.md rename to docs/src/operations/v1.7.0/passwords-secrets.md diff --git a/docs/src/operations/v1.7.0/maintain/root-certificates.md b/docs/src/operations/v1.7.0/root-certificates.md similarity index 100% rename from docs/src/operations/v1.7.0/maintain/root-certificates.md rename to docs/src/operations/v1.7.0/root-certificates.md diff --git a/docs/src/operations/v1.7.0/maintain/upgrade-from-0.md b/docs/src/operations/v1.7.0/upgrade-from-0.md similarity index 100% rename from docs/src/operations/v1.7.0/maintain/upgrade-from-0.md rename to docs/src/operations/v1.7.0/upgrade-from-0.md diff --git a/docs/src/operations/v1.7.0/maintain/upgrade-from-1.md b/docs/src/operations/v1.7.0/upgrade-from-1.md similarity index 100% rename from docs/src/operations/v1.7.0/maintain/upgrade-from-1.md rename to docs/src/operations/v1.7.0/upgrade-from-1.md diff --git a/docs/src/operations/v1.7.1/maintain/allowList-mgm.md b/docs/src/operations/v1.7.1/allowList-mgm.md similarity index 100% rename from docs/src/operations/v1.7.1/maintain/allowList-mgm.md rename to docs/src/operations/v1.7.1/allowList-mgm.md diff --git a/docs/src/operations/v1.7.1/maintain/bpe-reverse-proxy/README.md b/docs/src/operations/v1.7.1/bpe-reverse-proxy/README.md similarity index 100% rename from docs/src/operations/v1.7.1/maintain/bpe-reverse-proxy/README.md rename to docs/src/operations/v1.7.1/bpe-reverse-proxy/README.md diff --git a/docs/src/operations/v1.7.1/maintain/bpe-reverse-proxy/configuration.md b/docs/src/operations/v1.7.1/bpe-reverse-proxy/configuration.md similarity index 100% rename from docs/src/operations/v1.7.1/maintain/bpe-reverse-proxy/configuration.md rename to docs/src/operations/v1.7.1/bpe-reverse-proxy/configuration.md diff --git a/docs/src/operations/v1.7.1/maintain/bpe/README.md b/docs/src/operations/v1.7.1/bpe/README.md similarity index 100% rename from docs/src/operations/v1.7.1/maintain/bpe/README.md rename to docs/src/operations/v1.7.1/bpe/README.md diff --git a/docs/src/operations/v1.7.1/maintain/bpe/access-control.md b/docs/src/operations/v1.7.1/bpe/access-control.md similarity index 100% rename from docs/src/operations/v1.7.1/maintain/bpe/access-control.md rename to docs/src/operations/v1.7.1/bpe/access-control.md diff --git a/docs/src/operations/v1.7.1/maintain/bpe/configuration.md b/docs/src/operations/v1.7.1/bpe/configuration.md similarity index 100% rename from docs/src/operations/v1.7.1/maintain/bpe/configuration.md rename to docs/src/operations/v1.7.1/bpe/configuration.md diff --git a/docs/src/operations/v1.7.1/maintain/bpe/oidc.md b/docs/src/operations/v1.7.1/bpe/oidc.md similarity index 100% rename from docs/src/operations/v1.7.1/maintain/bpe/oidc.md rename to docs/src/operations/v1.7.1/bpe/oidc.md diff --git a/docs/src/operations/v1.7.1/maintain/fhir-reverse-proxy/README.md b/docs/src/operations/v1.7.1/fhir-reverse-proxy/README.md similarity index 100% rename from docs/src/operations/v1.7.1/maintain/fhir-reverse-proxy/README.md rename to docs/src/operations/v1.7.1/fhir-reverse-proxy/README.md diff --git a/docs/src/operations/v1.7.1/maintain/fhir-reverse-proxy/configuration.md b/docs/src/operations/v1.7.1/fhir-reverse-proxy/configuration.md similarity index 100% rename from docs/src/operations/v1.7.1/maintain/fhir-reverse-proxy/configuration.md rename to docs/src/operations/v1.7.1/fhir-reverse-proxy/configuration.md diff --git a/docs/src/operations/v1.7.1/maintain/fhir/README.md b/docs/src/operations/v1.7.1/fhir/README.md similarity index 100% rename from docs/src/operations/v1.7.1/maintain/fhir/README.md rename to docs/src/operations/v1.7.1/fhir/README.md diff --git a/docs/src/operations/v1.7.1/maintain/fhir/access-control.md b/docs/src/operations/v1.7.1/fhir/access-control.md similarity index 100% rename from docs/src/operations/v1.7.1/maintain/fhir/access-control.md rename to docs/src/operations/v1.7.1/fhir/access-control.md diff --git a/docs/src/operations/v1.7.1/maintain/fhir/configuration.md b/docs/src/operations/v1.7.1/fhir/configuration.md similarity index 100% rename from docs/src/operations/v1.7.1/maintain/fhir/configuration.md rename to docs/src/operations/v1.7.1/fhir/configuration.md diff --git a/docs/src/operations/v1.7.1/maintain/fhir/oidc.md b/docs/src/operations/v1.7.1/fhir/oidc.md similarity index 100% rename from docs/src/operations/v1.7.1/maintain/fhir/oidc.md rename to docs/src/operations/v1.7.1/fhir/oidc.md diff --git a/docs/src/operations/v1.7.1/index.md b/docs/src/operations/v1.7.1/index.md index 9d1f5aee9..c8db218b0 100644 --- a/docs/src/operations/v1.7.1/index.md +++ b/docs/src/operations/v1.7.1/index.md @@ -7,9 +7,9 @@ Data Sharing Framework 1.x is the current major release of the Data Sharing Fram # System Administrators -- [Install DSF 1.7.1](maintain/install) -- [Upgrade from DSF 1.7.0](maintain/upgrade-from-1) -- [Upgrade from DSF 0.9.x.](maintain/upgrade-from-0) +- [Install DSF 1.7.1](install) +- [Upgrade from DSF 1.7.0](upgrade-from-1) +- [Upgrade from DSF 0.9.x.](upgrade-from-0) ## New features diff --git a/docs/src/operations/v1.7.1/maintain/install-plugins.md b/docs/src/operations/v1.7.1/install-plugins.md similarity index 100% rename from docs/src/operations/v1.7.1/maintain/install-plugins.md rename to docs/src/operations/v1.7.1/install-plugins.md diff --git a/docs/src/operations/v1.7.1/maintain/install.md b/docs/src/operations/v1.7.1/install.md similarity index 100% rename from docs/src/operations/v1.7.1/maintain/install.md rename to docs/src/operations/v1.7.1/install.md diff --git a/docs/src/operations/v1.7.1/maintain/README.md b/docs/src/operations/v1.7.1/maintain/README.md deleted file mode 100644 index f639bed83..000000000 --- a/docs/src/operations/v1.7.1/maintain/README.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Maintain a DSF instance -icon: tool ---- -## Overview -- [Install DSF 1.7.1](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 Reverse Proxy - - [Configuration Parameters](bpe-reverse-proxy/configuration) -- BPE Server - - [Configuration Parameters](bpe/configuration) - - [Access Control](bpe/access-control) - - [OpenID Connect](bpe/oidc) diff --git a/docs/src/operations/v1.7.1/maintain/passwords-secrets.md b/docs/src/operations/v1.7.1/passwords-secrets.md similarity index 100% rename from docs/src/operations/v1.7.1/maintain/passwords-secrets.md rename to docs/src/operations/v1.7.1/passwords-secrets.md diff --git a/docs/src/operations/v1.7.1/maintain/root-certificates.md b/docs/src/operations/v1.7.1/root-certificates.md similarity index 100% rename from docs/src/operations/v1.7.1/maintain/root-certificates.md rename to docs/src/operations/v1.7.1/root-certificates.md diff --git a/docs/src/operations/v1.7.1/maintain/upgrade-from-0.md b/docs/src/operations/v1.7.1/upgrade-from-0.md similarity index 100% rename from docs/src/operations/v1.7.1/maintain/upgrade-from-0.md rename to docs/src/operations/v1.7.1/upgrade-from-0.md diff --git a/docs/src/operations/v1.7.1/maintain/upgrade-from-1.md b/docs/src/operations/v1.7.1/upgrade-from-1.md similarity index 100% rename from docs/src/operations/v1.7.1/maintain/upgrade-from-1.md rename to docs/src/operations/v1.7.1/upgrade-from-1.md diff --git a/docs/src/operations/v1.8.0/maintain/allowList-mgm.md b/docs/src/operations/v1.8.0/allowList-mgm.md similarity index 100% rename from docs/src/operations/v1.8.0/maintain/allowList-mgm.md rename to docs/src/operations/v1.8.0/allowList-mgm.md diff --git a/docs/src/operations/v1.8.0/maintain/bpe-reverse-proxy/README.md b/docs/src/operations/v1.8.0/bpe-reverse-proxy/README.md similarity index 100% rename from docs/src/operations/v1.8.0/maintain/bpe-reverse-proxy/README.md rename to docs/src/operations/v1.8.0/bpe-reverse-proxy/README.md diff --git a/docs/src/operations/v1.8.0/maintain/bpe-reverse-proxy/configuration.md b/docs/src/operations/v1.8.0/bpe-reverse-proxy/configuration.md similarity index 100% rename from docs/src/operations/v1.8.0/maintain/bpe-reverse-proxy/configuration.md rename to docs/src/operations/v1.8.0/bpe-reverse-proxy/configuration.md diff --git a/docs/src/operations/v1.8.0/maintain/bpe/README.md b/docs/src/operations/v1.8.0/bpe/README.md similarity index 100% rename from docs/src/operations/v1.8.0/maintain/bpe/README.md rename to docs/src/operations/v1.8.0/bpe/README.md diff --git a/docs/src/operations/v1.8.0/maintain/bpe/access-control.md b/docs/src/operations/v1.8.0/bpe/access-control.md similarity index 100% rename from docs/src/operations/v1.8.0/maintain/bpe/access-control.md rename to docs/src/operations/v1.8.0/bpe/access-control.md diff --git a/docs/src/operations/v1.8.0/maintain/bpe/configuration.md b/docs/src/operations/v1.8.0/bpe/configuration.md similarity index 100% rename from docs/src/operations/v1.8.0/maintain/bpe/configuration.md rename to docs/src/operations/v1.8.0/bpe/configuration.md diff --git a/docs/src/operations/v1.8.0/maintain/bpe/oidc.md b/docs/src/operations/v1.8.0/bpe/oidc.md similarity index 100% rename from docs/src/operations/v1.8.0/maintain/bpe/oidc.md rename to docs/src/operations/v1.8.0/bpe/oidc.md diff --git a/docs/src/operations/v1.8.0/maintain/fhir-reverse-proxy/README.md b/docs/src/operations/v1.8.0/fhir-reverse-proxy/README.md similarity index 100% rename from docs/src/operations/v1.8.0/maintain/fhir-reverse-proxy/README.md rename to docs/src/operations/v1.8.0/fhir-reverse-proxy/README.md diff --git a/docs/src/operations/v1.8.0/maintain/fhir-reverse-proxy/configuration.md b/docs/src/operations/v1.8.0/fhir-reverse-proxy/configuration.md similarity index 100% rename from docs/src/operations/v1.8.0/maintain/fhir-reverse-proxy/configuration.md rename to docs/src/operations/v1.8.0/fhir-reverse-proxy/configuration.md diff --git a/docs/src/operations/v1.8.0/maintain/fhir/README.md b/docs/src/operations/v1.8.0/fhir/README.md similarity index 100% rename from docs/src/operations/v1.8.0/maintain/fhir/README.md rename to docs/src/operations/v1.8.0/fhir/README.md diff --git a/docs/src/operations/v1.8.0/maintain/fhir/access-control.md b/docs/src/operations/v1.8.0/fhir/access-control.md similarity index 100% rename from docs/src/operations/v1.8.0/maintain/fhir/access-control.md rename to docs/src/operations/v1.8.0/fhir/access-control.md diff --git a/docs/src/operations/v1.8.0/maintain/fhir/configuration.md b/docs/src/operations/v1.8.0/fhir/configuration.md similarity index 100% rename from docs/src/operations/v1.8.0/maintain/fhir/configuration.md rename to docs/src/operations/v1.8.0/fhir/configuration.md diff --git a/docs/src/operations/v1.8.0/maintain/fhir/oidc.md b/docs/src/operations/v1.8.0/fhir/oidc.md similarity index 100% rename from docs/src/operations/v1.8.0/maintain/fhir/oidc.md rename to docs/src/operations/v1.8.0/fhir/oidc.md diff --git a/docs/src/operations/v1.8.0/index.md b/docs/src/operations/v1.8.0/index.md index 0bc5041c4..73a46e8b3 100644 --- a/docs/src/operations/v1.8.0/index.md +++ b/docs/src/operations/v1.8.0/index.md @@ -3,7 +3,7 @@ title: DSF 1.8.0 icon: guide --- -Data Sharing Framework 1.x is the current major release of the Data Sharing Framework. Click [here](/explore/) to find more information about the DSF in general. +Data Sharing Framework 1.x is the current major release of the Data Sharing Framework. # System Administrators diff --git a/docs/src/operations/v1.8.0/maintain/install-plugins.md b/docs/src/operations/v1.8.0/install-plugins.md similarity index 100% rename from docs/src/operations/v1.8.0/maintain/install-plugins.md rename to docs/src/operations/v1.8.0/install-plugins.md diff --git a/docs/src/operations/v1.8.0/maintain/install.md b/docs/src/operations/v1.8.0/install.md similarity index 100% rename from docs/src/operations/v1.8.0/maintain/install.md rename to docs/src/operations/v1.8.0/install.md diff --git a/docs/src/operations/v1.8.0/maintain/README.md b/docs/src/operations/v1.8.0/maintain/README.md deleted file mode 100644 index 2e1ff6426..000000000 --- a/docs/src/operations/v1.8.0/maintain/README.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Maintain a DSF instance -icon: tool ---- -## Overview -- [Install DSF 1.8.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 Reverse Proxy - - [Configuration Parameters](bpe-reverse-proxy/configuration) -- BPE Server - - [Configuration Parameters](bpe/configuration) - - [Access Control](bpe/access-control) - - [OpenID Connect](bpe/oidc) diff --git a/docs/src/operations/v1.8.0/maintain/passwords-secrets.md b/docs/src/operations/v1.8.0/passwords-secrets.md similarity index 100% rename from docs/src/operations/v1.8.0/maintain/passwords-secrets.md rename to docs/src/operations/v1.8.0/passwords-secrets.md diff --git a/docs/src/operations/v1.8.0/maintain/root-certificates.md b/docs/src/operations/v1.8.0/root-certificates.md similarity index 100% rename from docs/src/operations/v1.8.0/maintain/root-certificates.md rename to docs/src/operations/v1.8.0/root-certificates.md diff --git a/docs/src/operations/v1.8.0/maintain/upgrade-from-0.md b/docs/src/operations/v1.8.0/upgrade-from-0.md similarity index 100% rename from docs/src/operations/v1.8.0/maintain/upgrade-from-0.md rename to docs/src/operations/v1.8.0/upgrade-from-0.md diff --git a/docs/src/operations/v1.8.0/maintain/upgrade-from-1.md b/docs/src/operations/v1.8.0/upgrade-from-1.md similarity index 100% rename from docs/src/operations/v1.8.0/maintain/upgrade-from-1.md rename to docs/src/operations/v1.8.0/upgrade-from-1.md diff --git a/docs/src/process-development/api-v1/index.md b/docs/src/process-development/api-v1/index.md index 303ff76e0..436fda63f 100644 --- a/docs/src/process-development/api-v1/index.md +++ b/docs/src/process-development/api-v1/index.md @@ -1,5 +1,5 @@ --- -title: API 1 (stable) Overview +title: API v1 icon: code --- diff --git a/docs/src/process-development/api-v2/README.md b/docs/src/process-development/api-v2/README.md index f2f09e555..24fc603c0 100644 --- a/docs/src/process-development/api-v2/README.md +++ b/docs/src/process-development/api-v2/README.md @@ -1,5 +1,5 @@ --- -title: API 2 (next) Overview +title: API v2 icon: code --- ## Overview