Own directory for documentation generation scripts

Author: JohT

.github/workflows/cypher-reference-documentation.yml

@@ -30,7 +30,7 @@ jobs:
     - name: Generate cypher reference document
       working-directory: cypher
       run: |
-        ./../scripts/generateCypherReference.sh
+        ./../scripts/documentation/generateCypherReference.sh
 
     - name: Archive generated cypher reference document
       uses: actions/upload-artifact@v3

.github/workflows/environment-variables-reference-documentation.yml

@@ -30,7 +30,7 @@ jobs:
     - name: Generate environment variables reference document
       working-directory: scripts
       run: |
-        ./generateEnvironmentVariablesReference.sh
+        ./documentation/generateEnvironmentVariablesReference.sh
 
     - name: Archive generated environment variables reference document
       uses: actions/upload-artifact@v3

.github/workflows/scripts-reference-documentation.yml

@@ -30,7 +30,7 @@ jobs:
     - name: Generate scripts reference document
       working-directory: scripts
       run: |
-        ./generateScriptReference.sh
+        ./documentation/generateScriptReference.sh
 
     - name: Archive generated scripts reference document
       uses: actions/upload-artifact@v3

COMMANDS.md

@@ -104,37 +104,37 @@ without report generation use this command:
 
 ### Update Cypher Reference
 
-Change into the [cypher](./cypher/) directory e.g. with `cd cypher` and then execute the script [generateCypherReference.sh](./scripts/generateCypherReference.sh) with the following command:
+Change into the [cypher](./cypher/) directory e.g. with `cd cypher` and then execute the script [generateCypherReference.sh](./scripts/documentation/generateCypherReference.sh) with the following command:
 
 ```script
-./../scripts/generateCypherReference.sh
+./../scripts/documentation/generateCypherReference.sh
 ```
 
 ### Update Script Reference
 
-Change into the [scripts](./scripts/) directory e.g. with `cd scripts` and then execute the script [generateScriptReference.sh](./scripts/generateScriptReference.sh) with the following command:
+Change into the [scripts](./scripts/) directory e.g. with `cd scripts` and then execute the script [generateScriptReference.sh](./scripts/documentation/generateScriptReference.sh) with the following command:
 
 ```script
-./generateScriptReference.sh
+./documentation/generateScriptReference.sh
 ```
 
 ### Update Jupyter Notebook Markdown Report Reference
 
-Change into the [results](./results/) directory e.g. with `cd results` and then execute the script [generateJupyterReportsReference.sh](./scripts/generateJupyterReportsReference.sh) with the following command:
+Change into the [results](./results/) directory e.g. with `cd results` and then execute the script [generateJupyterReportsReference.sh](./scripts/documentation/generateJupyterReportsReference.sh) with the following command:
 
 👉**Note:** This script is automatically triggered at the end of [copyReportsIntoResults.sh](./scripts/copyReportsIntoResults.sh)
 which is included in the pipeline [code-structure-analysis.yml](.github/workflows/code-structure-analysis.yml) and doesn't need to be executed manually normally.
 
 ```script
-./../scripts/generateJupyterReportsReference.sh
+./../scripts/documentation/generateJupyterReportsReference.sh
 ```
 
 ### Update Environment Variable Reference
 
-Change into the [scripts](./scripts/) directory e.g. with `cd scripts` and then execute the script [generateEnvironmentVariablesReference.sh](./scripts/generateEnvironmentVariablesReference.sh) with the following command:
+Change into the [scripts](./scripts/) directory e.g. with `cd scripts` and then execute the script [generateEnvironmentVariablesReference.sh](./scripts/documentation/generateEnvironmentVariablesReference.sh) with the following command:
 
 ```script
-./generateEnvironmentVariablesReference.sh
+./documentation/generateEnvironmentVariablesReference.sh
 ```
 
 ## Manual Setup

scripts/copyReportsIntoResults.sh

@@ -41,4 +41,4 @@ for report_source_folder in **/"${REPORTS_DIRECTORY}"; do
 done
 
 # Generate REPORTS.md containing a reference to all Jupyter Notebook Markdown reports in the "results" directory and its subdirectories.
-(cd "./../${RESULTS_DIRECTORY}" && exec "${SCRIPTS_DIR}/generateJupyterReportReference.sh")
+(cd "./../${RESULTS_DIRECTORY}" && exec "${SCRIPTS_DIR}/documentation/generateJupyterReportsReference.sh")

scripts/appendEnvironmentVariables.sh renamed to scripts/documentation/appendEnvironmentVariables.sh

@@ -11,7 +11,7 @@ markdown_file="CYPHER.md"
   echo ""
   echo "This document serves as a reference for all Cypher files in the current directory and its subdirectories."
   echo "It provides a table listing each Cypher file and its corresponding description found in the first comment line."
-  echo "This file was generated with the script [generateCypherReference.sh](./../scripts/generateCypherReference.sh)."
+  echo "This file was generated with the script [generateCypherReference.sh](./../scripts/documentation/generateCypherReference.sh)."
   echo ""
   echo "Script | Directory | Description"
   echo "-------|-----------|------------" 

scripts/generateCypherReference.sh renamed to scripts/documentation/generateCypherReference.sh

@@ -8,11 +8,11 @@
 # Even if $BASH_SOURCE is made for Bourne-like shells it is also supported by others and therefore here the preferred solution. 
 # CDPATH reduces the scope of the cd command to potentially prevent unintended directory changes.
 # This way non-standard tools like readlink aren't needed.
-SCRIPTS_DIR=${SCRIPTS_DIR:-$( CDPATH=. cd -- "$(dirname -- "${BASH_SOURCE[0]}")" && pwd -P )} # Repository directory containing the shell scripts
-echo "generateEnvironmentVariablesReference: SCRIPTS_DIR=${SCRIPTS_DIR}"
+DOCUMENTATION_SCRIPTS_DIR=${DOCUMENTATION_SCRIPTS_DIR:-$( CDPATH=. cd -- "$(dirname -- "${BASH_SOURCE[0]}")" && pwd -P )} # Repository directory containing the documentation generation scripts
+echo "generateEnvironmentVariablesReference: DOCUMENTATION_SCRIPTS_DIR=${DOCUMENTATION_SCRIPTS_DIR}"
 
 # Loop through all script files in the current directory
 find . -type f -name "*.sh" | sort | while read -r scriptFile; do
   echo "generateEnvironmentVariablesReference: Searching for environment variables in ${scriptFile}"
-  source "${SCRIPTS_DIR}/appendEnvironmentVariables.sh" "${scriptFile}"
+  source "${DOCUMENTATION_SCRIPTS_DIR}/appendEnvironmentVariables.sh" "${scriptFile}"
 done

scripts/generateEnvironmentVariablesReference.sh renamed to scripts/documentation/generateEnvironmentVariablesReference.sh

@@ -11,7 +11,7 @@ markdown_file="JUPYTER_REPORTS.md"
   echo ""
   echo "This document serves as a reference for all Jupyter Notebook reports in the current directory and its subdirectories."
   echo "It provides a table listing each file and its corresponding description found in the first header line."
-  echo "This file was generated with the script [generateMarkdownReference.sh](./../scripts/generateMarkdownReference.sh)."
+  echo "This file was generated with the script [generateMarkdownReference.sh](./../scripts/documentation/generateMarkdownReference.sh)."
   echo ""
   echo "Report | Analysis | Description"
   echo "-------|----------|------------"