From 4bfdde58f8369689a15f572696c55180ac719ade Mon Sep 17 00:00:00 2001 From: Omar Carpentiero Date: Tue, 2 Jun 2026 17:10:06 +0200 Subject: [PATCH] added the README, replaced BraTS Reports with ReportX --- README.md | 53 ++++++++++++++++++++++++++++++++++++++++++++ clinicians.html | 18 +++++++-------- dataset-release.html | 12 +++++----- index.html | 14 ++++++------ join.html | 14 ++++++------ 5 files changed, 82 insertions(+), 29 deletions(-) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..c418f04 --- /dev/null +++ b/README.md @@ -0,0 +1,53 @@ +# ReportX + +Documentation site for the ReportX annotation protocol, served as a static nginx container. + +## Site contents + +The site covers the ReportX annotation protocol across four pages: + +- **index.html** — main protocol reference: tumor region legend and field definitions for the annotation template +- **clinicians.html** — annotators guide (available in both English and Italian) +- **dataset-release.html** — dataset release template with field definitions and tumor region legend +- **join.html** — recruitment page for new annotators + +## Repository structure + +``` +├── .github/workflows/ +│ └── deploy.yml # CI/CD pipeline (build → push → deploy) +├── Dockerfile +├── docker-compose.yml +├── *.html / *.css / *.js +└── assets/ +``` + +## Branching flow + +`dev-` → `dev` → `production` + +Work on your branch, then open a PR to `dev` for integration/staging. Once validated, `dev` is promoted to `production`. + +## Environments + +| Environment | URL | Availability | +|---|---|---| +| Dev | `http://services-host.ing.unimore.it:8096` | Unimore network only | +| Production | `https://reportx.unimore.it` | Public | + +## Deploying + +**Do not run `docker compose` manually.** Deploys are fully automated via GitHub Actions. + +- Push/merge to `dev` → builds and pushes `ghcr.io/aimagelab-zip/reportx:dev`, then restarts the dev container. +- Push/merge to `production` → builds and pushes `ghcr.io/aimagelab-zip/reportx:latest`, then restarts the production container. + +### Required GitHub secrets + +| Secret | Description | +|---|---| +| `SSH_HOST` | Server hostname or IP | +| `SSH_USER` | SSH username on the server | +| `SSH_KEY` | Private SSH key for that user | + +`GITHUB_TOKEN` is provided automatically by Actions and is used for GHCR authentication. diff --git a/clinicians.html b/clinicians.html index 46ec39e..164a761 100644 --- a/clinicians.html +++ b/clinicians.html @@ -3,10 +3,10 @@ - BraTS Reports Annotators Guide + ReportX Annotators Guide @@ -14,7 +14,7 @@
-

BraTS Reports instructions hub

+

ReportX instructions hub

One template, three ways in.

Pick the documentation path you need: dataset release fields, the Italian @@ -55,12 +55,12 @@

One template, three ways in.

Guida per annotatori

-

Guida BraTS Reports per gli Annotatori

+

Guida ReportX per gli Annotatori

Scegli la lingua per il protocollo di annotazione e la guida ai campi di annotazione.

Annotator guide

-

BraTS Reports Annotators Guide

+

ReportX Annotators Guide

Choose the language for the annotation protocol and annotator field guide.

@@ -323,7 +323,7 @@

Field Definitions

English version

-

BraTS Reports Dataset Template

+

ReportX Dataset Template

Structured definition of dataset fields for reporting on ToothFairy4M.

@@ -712,7 +712,7 @@

Using the ToothFairy4M Platform

Versione italiana

-

Template del Dataset BraTS Reports

+

Template del Dataset ReportX

Definizione strutturata dei campi del dataset per la refertazione su ToothFairy4M.

@@ -1100,7 +1100,7 @@

Utilizzo della piattaforma ToothFairy4M