Rename markdown to jupyter reports reference

Author: JohT

COMMANDS.md

@@ -118,15 +118,15 @@ Change into the [scripts](./scripts/) directory e.g. with `cd scripts` and then
 ./generateScriptReference.sh
 ```
 
-### Update Markdown Reference
+### Generate Jupyter Notebook Report Reference
 
-Change into the [results](./results/) directory e.g. with `cd results` and then execute the script [generateMarkdownReference.sh](./scripts/generateMarkdownReference.sh) with the following command:
+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:
 
 👉**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/generateMarkdownReference.sh
+./../scripts/generateJupyterReportsReference.sh
 ```
 
 ### Generate Environment Variable Reference

README.md

@@ -81,9 +81,9 @@ The [Code Structure Analysis Pipeline](./.github/workflows/code-structure-analys
 
 [COMMANDS.md](./COMMANDS.md) contains further details on commands and how to do a manual setup.
 
-## 📈 Report Reference
+## 📈 Jupyter Notebook Report Reference
 
-[REPORTS.md](./results/REPORTS.md) lists all Markdown reports inside the [results](./results).
+[JUPYTER_REPORTS.md](./results/JUPYTER_REPORTS.md) lists all Jupyter Notebook reports inside the [results](./results) directory. It can be generated as described in [Generate Jupyter Notebook Report Reference](./COMMANDS.md#generate-jupyter-notebook-report-reference).
 
 ## ⚙️ Script Reference
 

scripts/SCRIPTS.md

@@ -18,7 +18,7 @@ Script | Directory | Description
 | [executeQueryFunctions.sh](./executeQueryFunctions.sh) |  | Provides functions to execute Cypher queries using either "executeQuery.sh" or Neo4j's "cypher-shell".  |
 | [generateCypherReference.sh](./generateCypherReference.sh) |  | Generates "CYPHER.md" containing a reference to all Cypher files in this directory and its subdirectories. |
 | [generateEnvironmentVariablesReference.sh](./generateEnvironmentVariablesReference.sh) |  | Runs "appendEnvironmentVariable.sh" for every script file in the current directory and its sub directories. |
-| [generateMarkdownReference.sh](./generateMarkdownReference.sh) |  | Generates "REPORTS.md" containing a reference to all scripts in this directory and its subdirectories. |
+| [generateJupyterReportsReference.sh](./generateJupyterReportsReference.sh) |  | Generates "JUPYTER_REPORTS.md" containing a reference to all Jupyter Notebook Markdown reports in this directory and its subdirectories. |
 | [generateScriptReference.sh](./generateScriptReference.sh) |  | Generates "SCRIPTS.md" containing a reference to all scripts in this directory and its subdirectories. |
 | [prepareAnalysis.sh](./prepareAnalysis.sh) |  | Prepares and validates the graph database before analysis  |
 | [Default.sh](./profiles/Default.sh) | profiles | Sets (if any) settings variables for a default analysis. |

scripts/copyReportsIntoResults.sh

@@ -6,7 +6,7 @@
 
 # Notice that this scripts needs to be executed within the "temp" directory.
 
-# Requires generateMarkdownReference.sh
+# Requires generateJupyterReportReference.sh
 
 ## Get this "scripts" directory if not already set
 # Even if $BASH_SOURCE is made for Bourne-like shells it is also supported by others and therefore here the preferred solution. 
@@ -40,5 +40,5 @@ for report_source_folder in **/"${REPORTS_DIRECTORY}"; do
     cp -Rp "${report_source_folder}" "${reportTargetDirectory}"
 done
 
-# Generate REPORTS.md containing a reference to all Markdown Reports in the "results" directory and its subdirectories.
-(cd "./../${RESULTS_DIRECTORY}" && exec "${SCRIPTS_DIR}/generateMarkdownReference.sh")
+# 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")

scripts/generateMarkdownReference.sh renamed to scripts/generateJupyterReportsReference.sh

@@ -1,15 +1,15 @@
 #!/usr/bin/env bash
 
-# Generates "REPORTS.md" containing a reference to all scripts in this directory and its subdirectories.
+# Generates "JUPYTER_REPORTS.md" containing a reference to all Jupyter Notebook Markdown reports in this directory and its subdirectories.
 # This script was generated by Chat-GPT after some messages back and forth and then tuned manually.
 
 # Markdown file name
-markdown_file="REPORTS.md"
+markdown_file="JUPYTER_REPORTS.md"
 
 { 
   echo "# Markdown Reports Reference" 
   echo ""
-  echo "This document serves as a reference for all Markdown in the current directory and its subdirectories."
+  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 ""