Merge pull request #5 from nroduit/viewer-hub_documentation_update

feat: adapt viewer-hub documentation following renaming

Author: nroduit

content/viewer-hub/debug.en.md

@@ -12,7 +12,7 @@ We recommend the use of [IntelliJ IDEA](https://www.jetbrains.com/idea/) because
 ## Add a Launcher
 
 - Open _Run > Edit Configurations..._
-- Aad in _VM options_ the following properties:
+- Add in _VM options_ the following properties:
 ```
   -Duser.timezone=UTC
   -DENVIRONMENT=local
@@ -24,14 +24,14 @@ We recommend the use of [IntelliJ IDEA](https://www.jetbrains.com/idea/) because
   -DBACKEND_URI=http://localhost:8081
   -DDB_HOST=localhost
   -DDB_PORT=45101
-  -DDB_NAME=weasis-manager
-  -DDB_USER=weasis-manager
-  -DDB_PASSWORD=weasis-manager
-  -DCONFIGSERVER_URI=http://configdecrypt:987654321@localhost:8888
+  -DDB_NAME=viewer-hub
+  -DDB_USER=viewer-hub
+  -DDB_PASSWORD=viewer-hub
+  -DCONFIGSERVER_URI=http://localhost:8888
   -DS3_ACCESS_KEY=access-key
   -DS3_SECRET_KEY=secret-key
   -DS3_ENDPOINT=http://localhost:9080
-  -DS3_BUCKET_NAME=weasis-manager-bucket
+  -DS3_BUCKET_NAME=viewer-hub-bucket
   -DBACKEND_URI=http://localhost:8081
 ```
 - Then clean/install + Run...
@@ -45,8 +45,8 @@ http://localhost:8081
 with
 
 ```
-User: weasis-manager-user
-Password: weasis-manager-password
+User: viewer-hub-user
+Password: password
 ```
 
 ## Launch Weasis

content/viewer-hub/hub.en.md

@@ -50,8 +50,8 @@ Minio is an open-source object storage server compatible with Amazon S3 APIs. It
 Access the Minio console at: http://localhost:9090
 
 Use the following credentials:
-- User: `weasis-manager`
-- Password: `weasis-manager`
+- User: `viewer-hub`
+- Password: `viewer-hub`
 
 ## Keycloak
 
@@ -81,7 +81,7 @@ ViewerHub is a web application that manages the resources required by the differ
 Access the ViewerHub console at: http://localhost:8081
 
 Use the following credentials:
-- User: `weasis-manager-user`
-- Password: `weasis-manager-password`
+- User: `viewer-hub-user`
+- Password: `password`
 
 

content/viewer-hub/manifest.en.md

@@ -8,7 +8,9 @@ weight: 80
 
 ## Manifest
 
-The manifest contains the list of exams, series, and instances to retrieve when loading images by Weasis. It is represented in this [format](../../basics/customize/integration/#build-an-xml-manifest).
+The manifest contains the list of exams, series, and instances to retrieve when loading images by Weasis. 
+
+The manifest is represented in this [format](../../basics/customize/integration/#build-an-xml-manifest).
 
 The creation of the manifest occurs when a client calls ViewerHub to launch Weasis through the launch URL using the [Launch APIs](../api).  
 

content/viewer-hub/user-guide/package.en.md

@@ -7,13 +7,21 @@ weight: 60
 
 ## Compatibility file
 
-A compatibility file named "version-compatibility.json" is present in each Weasis release <br/> (in the weasis-native.zip file => bin-dist => weasis => conf).
+A compatibility file named "version-compatibility.json" is present in each Weasis release. <br/>
+
+{{< highlight text >}}
+weasis-native.zip
+    └── bin-dist/
+        └── weasis/
+            └── conf/
+                └── version-compatibility.json
+{{< /highlight >}}
 
 This file contains the mapping between the release version ("release-version") and the minimum version of Weasis that should be installed on the client workstation ("minimal-version").
 
 This file also indicates which translation version should be used ("i18n-version").
 
-![version_compatibility_file.png](/viewer-hub/compatibility/version_compatibility_file.png)
+{{< version-compatibility >}}
 
 ## Cache
 
@@ -25,8 +33,8 @@ So when a client will launch Weasis via ViewerHub, it will directly know which v
 
 ## Minio/S3
 
-By importing a new version of Weasis into ViewerHub, if the compatibility file is more recent, ViewerHub will replace the compatibility file present on the S3. This compatibility file will be renamed on S3 "mapping-minimal-version.json"
+By importing a new version of Weasis into ViewerHub, if the compatibility file is more recent, ViewerHub will replace the compatibility file present on the S3. 
 
-![s3_compatibility_file.png](/viewer-hub/compatibility/s3_compatibility_file.png)
+This compatibility file will be renamed in the S3 bucket "mapping-minimal-version.json"
 
 In order to compare if this mapping file is more recent, ViewerHub will compare the version number of the latest release.

layouts/shortcodes/version-compatibility.html

@@ -0,0 +1,20 @@
+{{ $jsonFile := readFile "/static/viewer-hub/compatibility/version-compatibility.json" }}
+{{ $data := unmarshal $jsonFile }}
+<table>
+    <thead>
+        <tr>
+            <th>Release Version</th>
+            <th>Minimal Version</th>
+            <th>i18n Version</th>
+        </tr>
+    </thead>
+    <tbody>
+    {{ range $index, $element := $data }}
+    <tr>
+        <td>{{ index $element "release-version" }}</td>
+        <td>{{ index $element "minimal-version" }}</td>
+        <td>{{ index $element "i18n-version" }}</td>
+    </tr>
+    {{ end }}
+    </tbody>
+</table>

static/viewer-hub/compatibility/s3_compatibility_file.png

@@ -0,0 +1,107 @@
+[
+  {
+    "release-version": "3.6.0",
+    "minimal-version": "3.6.0",
+    "i18n-version": "2.0.0-SNAPSHOT"
+  },
+  {
+    "release-version": "3.6.1",
+    "minimal-version": "3.6.0",
+    "i18n-version": "2.0.0-SNAPSHOT"
+  },
+  {
+    "release-version": "3.6.2",
+    "minimal-version": "3.6.0",
+    "i18n-version": "2.0.0-SNAPSHOT"
+  },
+  {
+    "release-version": "3.7.0",
+    "minimal-version": "3.7.0",
+    "i18n-version": "3.0.0-SNAPSHOT"
+  },
+  {
+    "release-version": "3.7.1",
+    "minimal-version": "3.7.0",
+    "i18n-version": "3.0.0-SNAPSHOT"
+  },
+  {
+    "release-version": "3.8.0",
+    "minimal-version": "3.7.0",
+    "i18n-version": "3.0.0-SNAPSHOT"
+  },
+  {
+    "release-version": "3.8.1",
+    "minimal-version": "3.7.0",
+    "i18n-version": "3.0.0-SNAPSHOT"
+  },
+  {
+    "release-version": "3.8.2",
+    "minimal-version": "3.7.0",
+    "i18n-version": "3.0.0-SNAPSHOT"
+  },
+  {
+    "release-version": "4.0.0",
+    "minimal-version": "4.0.0",
+    "i18n-version": "3.0.0-SNAPSHOT"
+  },
+  {
+    "release-version": "4.0.1",
+    "minimal-version": "4.0.0",
+    "i18n-version": "3.0.0-SNAPSHOT"
+  },
+  {
+    "release-version": "4.0.2",
+    "minimal-version": "4.0.0",
+    "i18n-version": "3.0.0-SNAPSHOT"
+  },
+  {
+    "release-version": "4.0.3",
+    "minimal-version": "4.0.0",
+    "i18n-version": "3.0.0-SNAPSHOT"
+  },
+  {
+    "release-version": "4.1.0",
+    "minimal-version": "4.1.0",
+    "i18n-version": "4.0.0-SNAPSHOT"
+  },
+  {
+    "release-version": "4.1.1",
+    "minimal-version": "4.1.0",
+    "i18n-version": "4.0.0-SNAPSHOT"
+  },
+  {
+    "release-version": "4.1.2",
+    "minimal-version": "4.1.0",
+    "i18n-version": "4.0.0-SNAPSHOT"
+  },
+  {
+    "release-version": "4.2.0",
+    "minimal-version": "4.2.0",
+    "i18n-version": "4.0.0-SNAPSHOT"
+  },
+  {
+    "release-version": "4.2.1",
+    "minimal-version": "4.2.0",
+    "i18n-version": "4.0.0-SNAPSHOT"
+  },
+  {
+    "release-version": "4.3.0",
+    "minimal-version": "4.2.0",
+    "i18n-version": "4.0.0-SNAPSHOT"
+  },
+  {
+    "release-version": "4.4.0",
+    "minimal-version": "4.4.0",
+    "i18n-version": "4.0.0-SNAPSHOT"
+  },
+  {
+    "release-version": "4.5.0",
+    "minimal-version": "4.5.0",
+    "i18n-version": "4.0.0-SNAPSHOT"
+  },
+  {
+    "release-version": "4.5.1",
+    "minimal-version": "4.5.0",
+    "i18n-version": "4.0.0-SNAPSHOT"
+  }
+]