Update Documentation Deployment

.github/workflows/deploy.yml

@@ -86,38 +86,37 @@ jobs:
           cache: 'pip'
       - run: pip install mkdocs-material
       - run: pip install mkdocs-macros-plugin
-      - run: sed -i "s/\$VERSION/${{ env.RELEASE_VERSION }}/g" mkdocs.yml
       - run: sed -i "s/\$RELEASE_VERSION/${{ env.RELEASE_VERSION }}/g" mkdocs.yml
+
       - run: mkdocs build -d site/${{ env.RELEASE_VERSION }}
       - run: mvn javadoc:javadoc
-      - run: sed -i "s/\$VERSION/${{ env.RELEASE_VERSION }}/g" .github/pages/latest.html
-      - run: sed -i "s/\$VERSION/${{ env.RELEASE_VERSION }}/g" .github/pages/javadoc-latest.html
+
       - name: Deploy Site
         uses: peaceiris/actions-gh-pages@v3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ./site/${{ env.RELEASE_VERSION }}
           destination_dir: ./docs/${{ env.RELEASE_VERSION }}
-      - name: Deploy Javadoc
+      - name: Deploy Site
         uses: peaceiris/actions-gh-pages@v3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./javadoc/${{ env.RELEASE_VERSION }}
-          destination_dir: ./javadoc/${{ env.RELEASE_VERSION }}
-      - name: Deploy latest.html
+          publish_dir: ./site/${{ env.RELEASE_VERSION }}
+          destination_dir: ./docs/latest
+
+      - name: Deploy Javadoc
         uses: peaceiris/actions-gh-pages@v3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: .github/pages/
-          keep_files: true
-          destination_dir: ./docs/
-      - name: Deploy latest.html
+          publish_dir: ./javadoc/${{ env.RELEASE_VERSION }}/apidocs
+          destination_dir: ./javadoc/${{ env.RELEASE_VERSION }}
+      - name: Deploy Javadoc
         uses: peaceiris/actions-gh-pages@v3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: .github/pages/
-          keep_files: true
-          destination_dir: ./docs/
+          publish_dir: ./javadoc/${{ env.RELEASE_VERSION }}/apidocs
+          destination_dir: ./javadoc/latest
+
 
   deploy_gh_release:
     runs-on: ubuntu-latest

docs/README.md

@@ -1,107 +1,107 @@
-<p align="center">
-    <img src="https://github.com/dice-group/IGUANA/raw/develop/images/IGUANA_logo.png" alt="IGUANA Logo" width="200">
-</p>
-
-# IGUANA
-Iguana is a benchmarking framework for testing the read performances of HTTP endpoints.
-It is mostly designed for benchmarking triplestores by using the SPARQL protocol.
-Iguana stresstests endpoints by simulating users which send a set of queries independently of each other.
-
-Benchmarks are configured using a YAML-file, this allows them to be easily repeated and adjustable.
-Results are stored in RDF-files and can also be exported as CSV-files.
-
-## Features
-- Benchmarking of (SPARQL) HTTP endpoints
-- Reusable configuration
-- Calculation of various metrics for better comparisons
-- Processing of HTTP responses (e.g., results counting)
-
-## Setup
-
-### Prerequisites
-
-If you're using the native version of IGUANA, you need to have at least a `x86-64-v3` (Intel Haswell and AMD Excavator or newer) system that is running Linux.
-
-If you're using the Java version of IGUANA, you need to have `Java 17` or higher installed.
-On Ubuntu it can be installed by executing the following command:
-
-```bash
-sudo apt install openjdk-17-jre
-``` 
-
-### Download
-The latest release can be downloaded at https://github.com/dice-group/IGUANA/releases/latest.
-The zip file contains three files:
-
-* `iguana`
-* `iguana.jar`
-* `example-suite.yml`
-* `start-iguana.sh`
-
-The `iguana` file is a native executable for IGUANA that has been compiled with GraalVM.
-The `iguana.jar` file is the standard Java executable for IGUANA.
-The `start-iguana.sh` script is a helper script to start IGUANA with the `iguana.jar` file.
-
-### Configuration
-The `example-suite.yml` file contains an extensive configuration for a benchmark suite.
-It can be used as a starting point for your own benchmark suite.
-For a detailed explanation of the configuration, see the [configuration](./configuration/overview.md) documentation.
-
-## Usage
-
-### Native Version
-
-Start Iguana with a benchmark suite (e.g., the `example-suite.yml`) by executing the binary:
-
-```bash
-./iguana example-suite.yml
-```
-
-### Java Version
-
-Start Iguana with a benchmark suite (e.g., the `example-suite.yml`) either by using the start script:
-
-```bash
-./start-iguana.sh example-suite.yml
-```
-
-or by directly executing the jar-file:
-
-```bash
-java -jar iguana.jar example-suite.yml
-```
-
-If you're using the script, you can use JVM arguments by setting the environment variable `IGUANA_JVM`.
-For example, to let Iguana use 4GB of RAM you can set `IGUANA_JVM` as follows:
-
-```bash
-export IGUANA_JVM=-Xmx4g
-```
-
-# How to Cite
-
-```bibtex
-@InProceedings{10.1007/978-3-319-68204-4_5,
-author="Conrads, Lixi
-and Lehmann, Jens
-and Saleem, Muhammad
-and Morsey, Mohamed
-and Ngonga Ngomo, Axel-Cyrille",
-editor="d'Amato, Claudia
-and Fernandez, Miriam
-and Tamma, Valentina
-and Lecue, Freddy
-and Cudr{\'e}-Mauroux, Philippe
-and Sequeda, Juan
-and Lange, Christoph
-and Heflin, Jeff",
-title="Iguana: A Generic Framework for Benchmarking the Read-Write Performance of Triple Stores",
-booktitle="The Semantic Web -- ISWC 2017",
-year="2017",
-publisher="Springer International Publishing",
-address="Cham",
-pages="48--65",
-abstract="The performance of triples stores is crucial for applications driven by RDF. Several benchmarks have been proposed that assess the performance of triple stores. However, no integrated benchmark-independent execution framework for these benchmarks has yet been provided. We propose a novel SPARQL benchmark execution framework called Iguana. Our framework complements benchmarks by providing an execution environment which can measure the performance of triple stores during data loading, data updates as well as under different loads and parallel requests. Moreover, it allows a uniform comparison of results on different benchmarks. We execute the FEASIBLE and DBPSB benchmarks using the Iguana framework and measure the performance of popular triple stores under updates and parallel user requests. We compare our results (See https://doi.org/10.6084/m9.figshare.c.3767501.v1) with state-of-the-art benchmarking results and show that our benchmark execution framework can unveil new insights pertaining to the performance of triple stores.",
-isbn="978-3-319-68204-4"
-}
+<p align="center">
+    <img src="https://github.com/dice-group/IGUANA/raw/main/images/IGUANA_logo.png" alt="IGUANA Logo" width="200">
+</p>
+
+# IGUANA
+Iguana is a benchmarking framework for testing the read performances of HTTP endpoints.
+It is mostly designed for benchmarking triplestores by using the SPARQL protocol.
+Iguana stresstests endpoints by simulating users which send a set of queries independently of each other.
+
+Benchmarks are configured using a YAML-file, this allows them to be easily repeated and adjustable.
+Results are stored in RDF-files and can also be exported as CSV-files.
+
+## Features
+- Benchmarking of (SPARQL) HTTP endpoints
+- Reusable configuration
+- Calculation of various metrics for better comparisons
+- Processing of HTTP responses (e.g., results counting)
+
+## Setup
+
+### Prerequisites
+
+If you're using the native version of IGUANA, you need to have at least a `x86-64-v3` (Intel Haswell and AMD Excavator or newer) system that is running Linux.
+
+If you're using the Java version of IGUANA, you need to have `Java 17` or higher installed.
+On Ubuntu it can be installed by executing the following command:
+
+```bash
+sudo apt install openjdk-17-jre
+``` 
+
+### Download
+The latest release can be downloaded at https://github.com/dice-group/IGUANA/releases/latest.
+The zip file contains three files:
+
+* `iguana`
+* `iguana.jar`
+* `example-suite.yml`
+* `start-iguana.sh`
+
+The `iguana` file is a native executable for IGUANA that has been compiled with GraalVM.
+The `iguana.jar` file is the standard Java executable for IGUANA.
+The `start-iguana.sh` script is a helper script to start IGUANA with the `iguana.jar` file.
+
+### Configuration
+The `example-suite.yml` file contains an extensive configuration for a benchmark suite.
+It can be used as a starting point for your own benchmark suite.
+For a detailed explanation of the configuration, see the [configuration](./configuration/overview.md) documentation.
+
+## Usage
+
+### Native Version
+
+Start Iguana with a benchmark suite (e.g., the `example-suite.yml`) by executing the binary:
+
+```bash
+./iguana example-suite.yml
+```
+
+### Java Version
+
+Start Iguana with a benchmark suite (e.g., the `example-suite.yml`) either by using the start script:
+
+```bash
+./start-iguana.sh example-suite.yml
+```
+
+or by directly executing the jar-file:
+
+```bash
+java -jar iguana.jar example-suite.yml
+```
+
+If you're using the script, you can use JVM arguments by setting the environment variable `IGUANA_JVM`.
+For example, to let Iguana use 4GB of RAM you can set `IGUANA_JVM` as follows:
+
+```bash
+export IGUANA_JVM=-Xmx4g
+```
+
+# How to Cite
+
+```bibtex
+@InProceedings{10.1007/978-3-319-68204-4_5,
+author="Conrads, Lixi
+and Lehmann, Jens
+and Saleem, Muhammad
+and Morsey, Mohamed
+and Ngonga Ngomo, Axel-Cyrille",
+editor="d'Amato, Claudia
+and Fernandez, Miriam
+and Tamma, Valentina
+and Lecue, Freddy
+and Cudr{\'e}-Mauroux, Philippe
+and Sequeda, Juan
+and Lange, Christoph
+and Heflin, Jeff",
+title="Iguana: A Generic Framework for Benchmarking the Read-Write Performance of Triple Stores",
+booktitle="The Semantic Web -- ISWC 2017",
+year="2017",
+publisher="Springer International Publishing",
+address="Cham",
+pages="48--65",
+abstract="The performance of triples stores is crucial for applications driven by RDF. Several benchmarks have been proposed that assess the performance of triple stores. However, no integrated benchmark-independent execution framework for these benchmarks has yet been provided. We propose a novel SPARQL benchmark execution framework called Iguana. Our framework complements benchmarks by providing an execution environment which can measure the performance of triple stores during data loading, data updates as well as under different loads and parallel requests. Moreover, it allows a uniform comparison of results on different benchmarks. We execute the FEASIBLE and DBPSB benchmarks using the Iguana framework and measure the performance of popular triple stores under updates and parallel user requests. We compare our results (See https://doi.org/10.6084/m9.figshare.c.3767501.v1) with state-of-the-art benchmarking results and show that our benchmark execution framework can unveil new insights pertaining to the performance of triple stores.",
+isbn="978-3-319-68204-4"
+}
 ```

docs/configuration/workers.md

@@ -132,5 +132,6 @@ If the property is set to `false`,
 the worker will not parse the response bodies and will not calculate hash values for the response bodies.
 
 Setting the property to `false` can improve the performance of the worker. 
+This means that the worker is able to measure the performance more accurately.
 If the property is set to `true`, the worker will temporarily store the whole response bodies in memory for processing.
 If the property is set to `false`, the worker will discard any received bytes from the response.

mkdocs.yml

@@ -1,24 +1,20 @@
 site_name: Iguana $VERSION Documentation
-#repo_url: https://github.com/dice-group/Iguana/
-
-#google_analytics: ['UA-179945559-1', 'iguana-benchmark.eu']
 
 extra:
-  version: $VERSION
+  version: $RELEASE_VERSION
   release_version: $RELEASE_VERSION
   social:
     - icon: fontawesome/brands/github
-      link: https://github.com/dice-group/Iguana
+      link: https://github.com/dice-group/IGUANA
 
-repo_url: https://github.com/dice-group/Iguana
-repo_name: dice-group/Iguana
+repo_url: https://github.com/dice-group/IGUANA
+repo_name: dice-group/IGUANA
 
 edit_uri: ""
 
-
 theme: 
   #name: 'readthedocs'
-  custom_dir: 'customs/'
+  custom_dir: 'images/'
   name: material 
   features:
     - navigation.tabs
@@ -32,11 +28,11 @@ theme:
   font:
     text: Roboto
     code: Roboto Mono
-  logo: images/logo_white.png
-  favicon: images/Iguana_new_logo6.png
+  logo: logo_white.png
+  favicon: IGUANA_logo.png
   icon:
     logo: logo
-    repo: fontawesome/brands/git-alt
+    repo: fontawesome/brands/github
   palette:
     - media: "(prefers-color-scheme: light)"
       scheme: default
@@ -62,33 +58,17 @@ color: "#82BDC3"
 
 nav:
   - "General":
-    - "About": "about.md"
-    - "Architecture": "architecture.md"
-
-  - "Quick Start Guide":
-    - "Download": "download.md"
-    - "Quick Configuration": "quick-config.md"
-    - "Run Iguana": "run-iguana.md"
+    - "About": "README.md"
 
-  - "Usage":
-    - "Workflow": "usage/workflow.md"
-    - "Configuration": "usage/configuration.md" 
-    - "Stresstest" : "usage/stresstest.md"
-    - "Supported Workers": "usage/workers.md" 
-    - "Supported Queries": "usage/queries.md" 
-    - "Supported Languages": "usage/languages.md" 
-    - "Metrics": "usage/metrics.md"
-    - "Benchmark Results": "usage/results.md"
-    - "Tutorial": "usage/tutorial.md"
-  - "Development":
-    - "Overview": "develop/overview.md"
-    - "Extend": 
-      - "Tasks": "develop/extend-task.md"
-      - "Workers": "develop/extend-workers.md"
-      - "Query Handling": "develop/extend-queryhandling.md"
-      - "Languages": "develop/extend-lang.md"
-      - "Result storage": "develop/extend-result-storages.md"
-      - "Metrics": "develop/extend-metrics.md"
-    - "Use Iguana":
-      - "Maven": "develop/maven.md"
-      - "Javadoc": "http://iguana-benchmark.eu/javadoc/$VERSION/index.html"
+  - "Configuration":
+      - "Overview": "configuration/overview.md"
+      - "Tasks": "configuration/tasks.md"
+      - "Workers": "configuration/workers.md"
+      - "Queries": "configuration/queries.md"
+      - "Response Body Processing": "configuration/response_body_processor.md"
+      - "Language Processor": "configuration/language_processor.md"
+      - "Result Storage": "configuration/storages.md"
+      - "Metrics": "configuration/metrics.md"
+      - "RDF Results": "configuration/rdf_results.md"
+  - "Javadocs":
+    - "Javadocs": "http://iguana-benchmark.eu/javadoc/latest/"