diff --git a/_includes/gallery.html b/_includes/gallery.html index a97df18..0beb32b 100644 --- a/_includes/gallery.html +++ b/_includes/gallery.html @@ -15,11 +15,19 @@ {%- assign images = images | push: include.image -%} {%- endif -%} {%- endif -%} +{% if include.alts %} + {%- assign alts = include.alts -%} +{%- else -%} + {%- assign alts = "" | split: "," -%} + {%- if include.alt -%} + {%- assign alts = alts | push: include.alt -%} + {%- endif -%} +{%- endif -%}
{%- for img in images %} - + {%- endfor %}
diff --git a/assets/css/customOpenEM.scss b/assets/css/customOpenEM.scss index 4af666d..cb93069 100644 --- a/assets/css/customOpenEM.scss +++ b/assets/css/customOpenEM.scss @@ -472,8 +472,9 @@ footer { /* Image box: scale images to one row */ .image-box { - margin-left: -1% !important; + //margin-left: -1% !important; //border: solid 1px #ddd; + margin: 0 auto; padding: .5%; & .flex-box { @@ -490,6 +491,7 @@ footer { & img { width: 100%; display: block; + box-shadow: 0 3px 5px #ccc; } } } diff --git a/documentation/admin/installation.md b/documentation/admin/installation.md index e630348..69533fb 100644 --- a/documentation/admin/installation.md +++ b/documentation/admin/installation.md @@ -1,7 +1,7 @@ --- layout: page title: Installation -permalink: /documentation/admin/installation +permalink: /documentation/admin/installation/ --- diff --git a/documentation/admin/installation/ingestor.md b/documentation/admin/installation/ingestor.md index 0874f1f..de2b499 100644 --- a/documentation/admin/installation/ingestor.md +++ b/documentation/admin/installation/ingestor.md @@ -251,8 +251,7 @@ You can use this [patch file](/assets/files/ext_transfer.patch) on the `scicatli 1. Setup keycloak, preferably with Docker 2. [OPTIONAL] Add another realm where you'll have your ingestor client added. - - ![adding a realm](/assets/img/documentation/admin/installation/ingestor/img0.png){: style="margin-top: 2em; margin-bottom: 2em;"} + {% include gallery.html alt="adding a realm" image="/assets/img/documentation/admin/installation/ingestor/img0.png" width="60%" %} 3. Add a new client with the following parameters {% assign images = "/assets/img/documentation/admin/installation/ingestor/img1.png /assets/img/documentation/admin/installation/ingestor/img2.png @@ -278,7 +277,8 @@ The next section is useful for developers only. /assets/img/documentation/admin/installation/ingestor/img8.png /assets/img/documentation/admin/installation/ingestor/img9.png" | split: " " %} - {%- include gallery.html images=images caption="Creating a user" %} + {% assign alts = "Step 1,Step 2,Step 3,Step 4" | split: "," %} + {%- include gallery.html images=images caption="Creating a user" alts=alts%} 2. Assign the read and write roles of the ingestor to this user. {% assign images = "/assets/img/documentation/admin/installation/ingestor/img10.png /assets/img/documentation/admin/installation/ingestor/img11.png" | split: " @@ -286,13 +286,17 @@ The next section is useful for developers only. {%- include gallery.html images=images caption="Assigning roles"%} 3. Go to [http://localhost:8888/login](http://localhost:8888/login) 4. This will open up the keycloak login page. Use your test user for logging in. -![login page](/assets/img/documentation/admin/installation/ingestor/img12.png) -5. If everything went well, you should be redirected to `RedirectURL`, and you should see a "user" cookie associated to the `localhost` domain in your browser's debugger. If you also have a valid `FrontendUrl` your browser will get redirected to your Ingestor frontend, where you should be able to interact with the ingestor backend using the cookie. -![browser debugger with cookie](/assets/img/documentation/admin/installation/ingestor/img13.png) + {% include gallery.html alt="login page" image="/assets/img/documentation/admin/installation/ingestor/img12.png" width="60%" %} +5. If everything went well, you should be redirected to `RedirectURL`, and you should + see a "user" cookie associated to the `localhost` domain in your browser's debugger. + If you also have a valid `FrontendUrl` your browser will get redirected to your + Ingestor frontend, where you should be able to interact with the ingestor backend + using the cookie. + ![browser debugger with cookie](/assets/img/documentation/admin/installation/ingestor/img13.png) 6. [OPTIONAL] To test the ingestor's auth directly, copy the cookie value from the browser, then you can use the following curl command: -```bash -curl -v --cookie "user=[INSERT COOKIE VALUE HERE]" "localhost:8888/transfer?page=1" -``` + ```bash + curl -v --cookie "user=[INSERT COOKIE VALUE HERE]" "localhost:8888/transfer?page=1" + ``` -If the auth is successful, you should get an empty list as a reply. + If the auth is successful, you should get an empty list as a reply. diff --git a/documentation/user/consumer.md b/documentation/user/consumer.md index 77403b9..4317b22 100644 --- a/documentation/user/consumer.md +++ b/documentation/user/consumer.md @@ -15,51 +15,22 @@ This chapter explains how to request and download a dataset from SciCat. Log in to SciCat with your organisation user. -
-
- SciCat Log In -

Figure 1: SciCat Log In

-
- -{% include } +{% include gallery.html image="/assets/img/documentation/user/dataset_download_1.png" alt="SciCat Log In" caption="Figure 1: SciCat Log In" width="60%" %} ### Select the dataset and add it to the cart After logging in, the dataset view can be opened by clicking on the SciCat logo. -
-
- SciCat Open Dataset View -

Figure 2: SciCat Open Dataset View

-
- -
-
- SciCat Select Dataset and add to Cart -

Figure 3: SciCat Select Dataset and add to Cart

-
+{% include gallery.html image="/assets/img/documentation/user/dataset_download_2.png" alt="SciCat Open Dataset View" caption="Figure 2: SciCat Open Dataset View" width="60%" %} +{% include gallery.html image="/assets/img/documentation/user/dataset_download_3.png" alt="SciCat Select Dataset and add to Cart" caption="Figure 3: SciCat Select Dataset and add to Cart" width="60%" %} ### Retrieve the dataset As soon as a data set is in the shopping basket, actions can be called up. One action is called Retrieval, which can be used to request the download of a data set. -
-
- SciCat Open Cart -

Figure 4: SciCat Open Cart

-
- -
-
- SciCat Select Dataset in Cart -

Figure 5: SciCat Select Dataset in Cart

-
- -
-
- SciCat Retrieve Dataset -

Figure 6: SciCat Retrieve Dataset

-
+{% include gallery.html image="/assets/img/documentation/user/dataset_download_4.png" alt="SciCat Open Cart" caption="Figure 4: SciCat Open Cart" width="60%" %} +{% include gallery.html image="/assets/img/documentation/user/dataset_download_5.png" alt="SciCat Select Dataset in Cart" caption="Figure 5: SciCat Select Dataset in Cart" width="60%" %} +{% include gallery.html image="/assets/img/documentation/user/dataset_download_6.png" alt="SciCat Retrieve Dataset" caption="Figure 6: SciCat Retrieve Dataset" width="60%" %} The data record is now transferred from the long-term storage to a cache server. As soon as the transfer is complete, the user is informed by e-mail. A download link is provided in the e-mail.