Skip to content

Commit d84235a

Browse files
committed
Fix broken links
1 parent 1250da5 commit d84235a

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Here is an overview of reports made with [Jupyter Notebooks](https://jupyter.org
3232
Here are some reports that utilize Neo4j's [Graph Data Science Library](https://neo4j.com/product/graph-data-science). For a detailed reference of all CSV reports see [CSV Cypher Query Report Reference](#📃-csv-cypher-query-report-reference) below.
3333

3434
- [Community Detection with Leiden](./results/AxonFramework-4.8.0/community-csv/Leiden_Communities.csv) ([Source Script](./scripts/reports/CommunityCsv.sh))
35-
- [Centrality with Page Rank](./results/AxonFramework-4.8.0/centrality-csv/Centrality_Page_Rank.csv) ([Source Script](./scripts/reports/CommunityCsv.sh))
35+
- [Centrality with Page Rank](./results/AxonFramework-4.8.0/centrality-csv/Centrality_Page_Rank.csv) ([Source Script](./scripts/reports/CentralityCsv.sh))
3636
- [Similarity with Jaccard](./results/AxonFramework-4.8.0/similarity-csv/Similarity_Jaccard.csv) ([Source Script](./scripts/reports/SimilarityCsv.sh))
3737

3838
## 🛠 Prerequisites
@@ -78,7 +78,7 @@ The [Code Structure Analysis Pipeline](./.github/workflows/code-structure-analys
7878

7979
## 📃 CSV Cypher Query Report Reference
8080

81-
[CSV_REPORTS.md](./results/CSV_REPORTS.md) lists all CSV Cypher query result reports inside the [results](./results) directory. It can be generated as described in [Generate Jupyter Notebook Report Reference](./COMMANDS.md#generate-csv-cypher-query-report-reference).
81+
[CSV_REPORTS.md](./results/CSV_REPORTS.md) lists all CSV Cypher query result reports inside the [results](./results) directory. It can be generated as described in [Generate CSV Report Reference](./COMMANDS.md#generate-csv-cypher-query-report-reference).
8282

8383
## 📈 Jupyter Notebook Report Reference
8484

@@ -90,7 +90,7 @@ The [Code Structure Analysis Pipeline](./.github/workflows/code-structure-analys
9090

9191
## 🔎 Cypher Query Reference
9292

93-
[CYPHER.md](./cypher/CYPHER.md) lists all Cypher queries of this repository including their first comment line as a description. It can be generated as described in [Generate Cypher Reference](./COMMANDS.md#update-cypher-reference).
93+
[CYPHER.md](./cypher/CYPHER.md) lists all Cypher queries of this repository including their first comment line as a description. It can be generated as described in [Generate Cypher Reference](./COMMANDS.md#generate-cypher-reference).
9494
> [Cypher](https://neo4j.com/docs/getting-started/cypher-intro) is Neo4j’s graph query language that lets you retrieve data from the graph.
9595
9696
## ⚙️ Environment Variable Reference
@@ -102,18 +102,18 @@ The [Code Structure Analysis Pipeline](./.github/workflows/code-structure-analys
102102
- How can i run an analysis locally?
103103
👉 See [Start an analysis](./COMMANDS.md#start-an-analysis) in the [Commands Reference](./COMMANDS.md).
104104

105-
- How can i add an CSV report to the pipeline?
105+
- How can i add a CSV report to the pipeline?
106106
👉 Put your new cypher query into the [cypher](./cypher) directory or a suitable (new) sub directory.
107107
👉 Create a new CSV report script in the [scripts/reports](./scripts/reports/) directory. Take for example [OverviewCsv.sh](./scripts/reports/OverviewCsv.sh) as a reference.
108108
👉 The script will automatically be included because of the directory and its name ending with "Csv.sh".
109109

110-
- How can i add an Jupyter Notebook report to the pipeline?
110+
- How can i add a Jupyter Notebook report to the pipeline?
111111
👉 Put your new notebook into the [jupyter](./jupyter) directory.
112112
👉 Create a new Jupyter report script in the [scripts/reports](./scripts/reports/) directory. Take [OverviewJupyter.sh](./scripts/reports/OverviewJupyter.sh) as a reference for example.
113113
👉 The script will automatically be included because of the directory and its name ending with "Jupyter.sh".
114114

115115
- How can i add another code basis to be analyzed automatically?
116-
👉 Create a new artifacts download script in the [scripts/artifacts](./scripts/artifacts) directory. Take for example [downloadAxonFramework.sh](./scripts/downloader/downloadAxonFramework.sh) as a reference.
116+
👉 Create a new artifacts download script in the [scripts/downloader](./scripts/downloader/) directory. Take for example [downloadAxonFramework.sh](./scripts/downloader/downloadAxonFramework.sh) as a reference.
117117
👉 Run the script separately before executing [analyze.sh](./scripts/analysis/analyze.sh) also in the [pipeline](./.github/workflows/code-structure-analysis.yml).
118118

119119
- How can i trigger a full rescan of all artifacts?
@@ -125,3 +125,9 @@ The [Code Structure Analysis Pipeline](./.github/workflows/code-structure-analys
125125
```shell
126126
export SKIP_JUPYTER_NOTEBOOK_PDF_GENERATION="true"
127127
```
128+
129+
👉 Or prepend your command with `SKIP_JUPYTER_NOTEBOOK_PDF_GENERATION="true"` like:
130+
131+
```shell
132+
SKIP_JUPYTER_NOTEBOOK_PDF_GENERATION=true ./../../scripts/analysis/analyze.sh
133+
```

0 commit comments

Comments
 (0)