fix: documentation with s3 links

OHIF · Jan 11, 2022 · da6ebd5 · da6ebd5
1 parent 06dc46d
commit da6ebd5
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 24 deletions.
diff --git a/platform/docs/docs/configuration/dataSources/dicom-json.md b/platform/docs/docs/configuration/dataSources/dicom-json.md
@@ -10,21 +10,18 @@ server as well as a list of study and series instance UIDs along with metadata.
 
 An example would look like
 
-`http://localhost:3000/myModeName/dicomjson?url=http://localhost:3000/LIDC-IDRI-0001.json`
+`https://v3-demo.ohif.org/viewer/dicomjson?url=https://ohif-dicom-json-example.s3.amazonaws.com/LIDC-IDRI-0001.json`
 
 As you can see the url to the location of the JSON file is passed in the query
 after the `dicomjson` string, which is
-`http://localhost:3000/LIDC-IDRI-0001.json` (in this case we have stored the
-json file in the `public` directory of the `platform/viewer`).
+`https://ohif-dicom-json-example.s3.amazonaws.com/LIDC-IDRI-0001.json` (this
+json file has been generated by OHIF team and stored in an amazon s3 bucket for
+the purpose of the guide).
 
 ## DICOM JSON sample
 
-Here we are using the LIDC-IDRI-0001.json file which is a sample of the
-LIDC-IDRI dataset (which is also stored in the `public` directory of the
-`platform/viewer` for the purpose of this documentation). You can download the
-LIDC-IDRI-0001.json files at the end of this guide.
-
-Let's have a look at the JSON file:
+Here we are using the LIDC-IDRI-0001 case which is a sample of the LIDC-IDRI
+dataset. Let's have a look at the JSON file:
 
 ### Metadata
 
@@ -34,9 +31,9 @@ level. A JSON launch file should follow the same structure as the one below.
 Note that at the instance level metadata we are storing both the `metadata` and
 also the `url` for the dicom file on the dicom server. In this case we are
 referring to
-`dicomweb:http://localhost:3000/LIDC-IDRI-0001/01-01-2000-30178/3000566.000000-03192/1-001.dcm`
-which is the `LIDC-IDRI-0001` in the `public` directory of the
-`platform/viewer`.
+`dicomweb:https://ohif-dicom-json-example.s3.amazonaws.com/LIDC-IDRI-0001/01-01-2000-30178/3000566.000000-03192/1-001.dcm`
+which is stored in another directory in our s3. (You can actually try
+downloading the dicom file by opening the url in your browser).
 
 ```json
 {
@@ -85,7 +82,7 @@ which is the `LIDC-IDRI-0001` in the `public` directory of the
                 "WindowWidth": 1600,
                 "SeriesDate": "20000101"
               },
-              "url": "dicomweb:http://localhost:3000/LIDC-IDRI-0001/01-01-2000-30178/3000566.000000-03192/1-001.dcm"
+              "url": "dicomweb:https://ohif-dicom-json-example.s3.amazonaws.com/LIDC-IDRI-0001/01-01-2000-30178/3000566.000000-03192/1-001.dcm"
             },
             // second instance metadata
             {
@@ -113,7 +110,7 @@ which is the `LIDC-IDRI-0001` in the `public` directory of the
                 "WindowWidth": 1600,
                 "SeriesDate": "20000101"
               },
-              "url": "dicomweb:http://localhost:3000/LIDC-IDRI-0001/01-01-2000-30178/3000566.000000-03192/1-002.dcm"
+              "url": "dicomweb:https://ohif-dicom-json-example.s3.amazonaws.com/LIDC-IDRI-0001/01-01-2000-30178/3000566.000000-03192/1-002.dcm"
             }
             // ..... other instances metadata
           ]
@@ -128,14 +125,22 @@ which is the `LIDC-IDRI-0001` in the `public` directory of the
 }
 ```
 
-### Demo
+![](../../assets/img/dicom-json.png)
+
+### Local Demo
+
+You can run OHIF with a JSON data source againts you local datasets (given that
+their JSON metadata is extracted).
 
-After you located the JSON file and the folder containing the dicom files inside
-your `public` folder, you can navigate to
+First you need to put the JSON file and the folder containing the dicom files
+inside your `public` folder. Since files are served from your local server the
+`url` for the JSON file will be `http://localhost:3000/LIDC-IDRI-0001.json` and
+the dicom files will be
+`dicomweb:http://localhost:3000/LIDC-IDRI-0001/01-01-2000-30178/3000566.000000-03192/1-001.dcm`.
+
+After `yarn install` and running `yarn dev` and opening the browser at
 `http://localhost:3000/viewer/dicomjson?url=http://localhost:3000/LIDC-IDRI-0001.json`
-which would load the viewer with the study that we have specified in the JSON
-(don't forget `yarn install` and `yarn dev`). As seen in the image bellow, all
-the instances (133) have been loaded.
+will display the viewer.
 
 Download JSON file from
 [here](https://www.dropbox.com/sh/zvkv6mrhpdze67x/AADLGK46WuforD2LopP99gFXa?dl=0)
@@ -148,5 +153,3 @@ directly from
 Your public folder should look like this:
 
 ![](../../assets/img/dicom-json-public.png)
-
-![](../../assets/img/dicom-json.png)
diff --git a/platform/docs/docs/configuration/dataSources/dicom-web.md b/platform/docs/docs/configuration/dataSources/dicom-web.md
@@ -97,7 +97,7 @@ yarn run dev:orthanc
 #### Configuration: Learn More
 
 > For more configuration fun, check out the
-> [Essentials Configuration](./index.md) guide.
+> [Essentials Configuration](../index.md) guide.
 
 Let's take a look at what's going on under the hood here. `yarn run dev:orthanc`
 is running the `dev:orthanc` script in our project's `package.json` (inside
@@ -154,7 +154,7 @@ window.config = {
 ```
 
 To learn more about how you can configure the OHIF Viewer, check out our
-[Configuration Guide](./index.md).
+[Configuration Guide](../index.md).
 
 ### Running DCM4CHEE