Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clin 3527 test for broken link #19

Merged
merged 16 commits into from
Nov 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions .github/workflows/action.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: Linkspector
on: [ pull_request ]
jobs:
check-links:
name: runner / linkspector
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

# Step to set up Node.js environment
- name: Set up Node.js
uses: actions/setup-node@v3
with:
node-version: 'latest'

# Step to install Docsify CLI
- name: Install Docsify CLI
run: npm install -g docsify-cli@latest

# Step to start Docsify server
- name: Start Docsify server
run: docsify serve ./docs &

# Step to run Linkspector
- name: Run linkspector
uses: umbrelladocs/action-linkspector@v1
with:
reporter: github-pr-review
config_file: linkspector_config.yaml
fail_on_error: true
2 changes: 1 addition & 1 deletion docs/_sidebar.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
- Qlin Prescriptions
- [Create a New Prescription](qlin_prescriptions/create_prescription.md)
- [My prescriptions](qlin_prescriptions/my_prescription.md)
- Qlin Genetics
- [Qlin Genetics](qlin_genetic/home.md)
- [Prescriptions](qlin_genetic/prescription/landing.md)
- [Details](qlin_genetic/prescription/details.md)
- [Variants](qlin_genetic/prescription/variants.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/docs-fr/_sidebar.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
- Qlin Prescriptions
- [Créer une nouvelle prescription](fr/qlin_prescriptions/create_prescription.md)
- [Mes prescriptions](fr/qlin_prescriptions/my_prescription.md)
- Qlin Génétique
- [Qlin Génétique](fr/qlin_genetic/home.md)
- [Prescriptions](fr/qlin_genetic/prescription/landing.md)
- [Détails](fr/qlin_genetic/prescription/details.md)
- [Contrôle qualité](fr/qlin_genetic/prescription/qc.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/docs-fr/qlin_genetic/exploration.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

La section **Exploration** permet de consulter l'entièreté des variants génétiques SNV présents dans Qlin Génétique.

L'utilisation du [gestionnaire de filtres](/fr/qlin_genetic/_filter_manager/filter_manager.md) et du [panneau latéral de filtres](/fr/qlin_genetic/filter_panel/filter_panel.md) facilite la visualisation des variants SNV dans le [tableau](/fr/qlin_genetic/tables/tables.md).
L'utilisation du [gestionnaire de filtres](/fr/qlin_genetic/filters_manager/filters_manager.md) et du [panneau latéral de filtres](/fr/qlin_genetic/filter_panel/filter_panel.md) facilite la visualisation des variants SNV dans le [tableau](/fr/qlin_genetic/tables/tables.md).
2 changes: 1 addition & 1 deletion docs/docs-fr/qlin_genetic/home.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@

La page d'accueil vous permet de rechercher :

- une [prescription](fr/prescription/details.md) par numéro de prescription, requête, échantillon, dossier, numéro de patient et numéro de lot
- une [prescription](fr/qlin_genetic/prescription/details.md) par numéro de prescription, requête, échantillon, dossier, numéro de patient et numéro de lot
- un [variant](fr/qlin_genetic/exploration.md) par locus, dbSNP, ClinVar
2 changes: 1 addition & 1 deletion docs/qlin_genetic/archives.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Archives

The **Archives** section allows the search for [files of a prescription](prescription/files.md) by request ID or patient ID.
The **Archives** section allows the search for [files of a prescription](qlin_genetic/prescription/files.md) by request ID or patient ID.
2 changes: 1 addition & 1 deletion docs/qlin_genetic/exploration.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

The **Exploration** section allows you to view all the SNV genetic variants present in Qlin Genetics.

The use of the [filter manager](_filter_manager/filter_manager.md) and the [filter sidebar](filter_panel/filter_panel.md) facilitates the visualization of SNV variants in the [table](tables/tables.md).
The use of the [filter manager](qlin_genetic/filters_manager/filters_manager.md) and the [filter sidebar](filter_panel/filter_panel.md) facilitates the visualization of SNV variants in the [table](tables/tables.md).
4 changes: 2 additions & 2 deletions docs/qlin_genetic/home.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@

The homepage allows you to search:

- a [prescription](prescription/details.md) by prescription, requisition, sample, medical record number, patient number and run number
- a [variant](qlin_genetic/exploration.md) by locus, dbSNP, ClinVar
- a [prescription](qlin_genetic/prescription/details.md) by prescription, requisition, sample, medical record number, patient number and run number
- a [variant](qlin_genetic/exploration.md) by locus, dbSNP, ClinVar
14 changes: 14 additions & 0 deletions linkspector_config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
dirs:
- docs
useGitIgnore: true
replacementPatterns:
- pattern: "(fr/)(.*)(?<!https://raw.githubusercontent.com.*)"
replacement: '$2'
baseUrl: http://localhost:3000
excludedFiles:
- ./docs/qlin_genetic/home.md
- ./docs/qlin_genetic/archives.md
- ./docs/qlin_genetic/exploration.md
- ./docs/docs-fr/qlin_genetic/home.md
- ./docs/docs-fr/qlin_genetic/exploration.md
- ./docs/docs-fr/qlin_genetic/archives.md
12 changes: 10 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,16 @@ https://docsify.js.org/#/quickstart
docsify serve docs
```

### Broken hyperlinks test

[Start locally](#to-start-locally) then run linkspector

```
linkspector check -c linkspector_config.yaml
```

https://github.com/UmbrellaDocs/linkspector

#### To start in Docker
```
docker-compose up
Expand All @@ -35,5 +45,3 @@ docker-compose up
Issue with images and alias (fr)
It works when viewing the .md file but not when served by Docsify
https://github.com/docsifyjs/docsify/issues/1891
If not fix an alternative could be to host the images in a CND or straight on github by putting the repo public
https://stackoverflow.com/questions/61537403/how-to-host-image-at-https-user-images-githubusercontent-com-path-filename