working docs v3

2021-06-15 23:32:37 -04:00
1 parent 9d49bf4348
commit d501335143
@@ -0,0 +1,4 @@
+{
+  "label": "Development",
+  "position": 4
+}
@@ -1,3 +1,7 @@
+---
+sidebar_position: 3
+sidebar_label: Continous Integration
+---
 # Continous Integration (CI)

 This repository uses `CircleCI` and `Netlify` for continous integration.
@@ -25,12 +29,8 @@ The PR_CHECKS workflow (Pull Request Checks) runs our automated unit and
 end-to-end tests for every code check-in. These tests must all pass before code
 can be merged to our `master` branch.

-<div style="text-align: center;">
-  <a href="/assets/img/WORKFLOW_PR_CHECKS.png">
-    <img src="/assets/img/WORKFLOW_PR_CHECKS.png" alt="workflow diagram" style="margin: 0 auto; max-width: 500px;" />
-  </a>
-  <div><i>Workflow diagram for PR_CHECKS</i></div>
-</div>
+
+![PR_CHECKS](../assets/img/WORKFLOW_PR_CHECKS.png)

 ### Workflow: PR_OPTIONAL_DOCKER_PUBLISH

@@ -38,12 +38,9 @@ The PR_OPTIONAL_DOCKER_PUBLISH workflow allows for "manual approval" to publish
 the pull request as a tagged docker image. This is helpful when changes need to
 be tested with the Google Adapter before merging to `master`.

-<div style="text-align: center;">
-  <a href="/assets/img/WORKFLOW_PR_OPTIONAL_DOCKER_PUBLISH.png">
-    <img src="/assets/img/WORKFLOW_PR_OPTIONAL_DOCKER_PUBLISH.png" alt="workflow diagram" style="margin: 0 auto; max-width: 500px;" />
-  </a>
-  <div><i>Workflow diagram for PR_WORKFLOW_PR_OPTIONAL_DOCKER_PUBLISH</i></div>
-</div>
+
+
+![PR_Workflow](../assets/img/WORKFLOW_PR_OPTIONAL_DOCKER_PUBLISH.png)

 > NOTE: This workflow will fail unless it's for a branch on our `upstream`
 > repository. If you need this functionality, but the branch is from a fork,
@@ -56,12 +53,9 @@ It uses the Netlify CLI to deploy assets created as part of the repository's PWA
 Build process (`yarn run build`). The workflow allows for "Manual Approval" to
 promote the build to `STAGING` and `PRODUCTION` environments.

-<div style="text-align: center;">
-  <a href="/assets/img/WORKFLOW_DEPLOY.png">
-    <img src="/assets/img/WORKFLOW_DEPLOY.png" alt="workflow diagram" style="margin: 0 auto; max-width: 500px;" />
-  </a>
-  <div><i>Workflow diagram for WORKFLOW_DEPLOY</i></div>
-</div>
+
+![WORKFLOW_DEPLOY](../assets/img/WORKFLOW_DEPLOY.png)
+

 | Environment | Description                                                                        | URL                                           |
 | ----------- | ---------------------------------------------------------------------------------- | --------------------------------------------- |
@@ -82,16 +76,11 @@ GitHub hosts the `gh-pages` branch with GitHub Pages.
 - Extension Packages: https://github.com/ohif/viewers/#extensions
 - Documentation: https://docs.ohif.org/

-<div style="text-align: center;">
-  <a href="/assets/img/WORKFLOW_RELEASE.png">
-    <img src="/assets/img/WORKFLOW_RELEASE.png" alt="workflow diagram" style="margin: 0 auto; max-width: 500px;" />
-  </a>
-  <div><i>Workflow diagram for WORKFLOW_RELEASE</i></div>
-</div>

-### HOTFIX

-_Not yet implemented_
+![WORKFLOW_RELEASE](../assets/img/WORKFLOW_RELEASE.png)
+
+

 <!--
  LINKS
@@ -1,3 +1,7 @@
+---
+sidebar_position: 2
+sidebar_label: Contributing
+---
 # Contributing

 ## How can I help?
@@ -34,9 +38,7 @@ dependencies:

 On your local file system:

-```bash
-# code/my-projects/
-.
+```bash title="/my-projects/"
 ├── cornerstonejs/cornerstone-tools
 └── ohif/viewers
 ```
@@ -57,12 +59,11 @@ On your local file system:
 As you make changed to `cornerstone-tools`, and it's output is rebuilt, you
 should see the following behavior:

-<div style="text-align: center;">
-  <a href="/assets/img/cornerstone-tools-link.gif">
-    <img src="/assets/img/cornerstone-tools-link.gif" alt="Example of linked cornerstone-tools package" style="margin: 0 auto; max-width: 500px;" />
-  </a>
-  <div><i>example of linked cornerstone-tools package</i></div>
-</div>
+
+
+![tools](..//assets/img/cornerstone-tools-link.gif)
+
+

 If you wish to stop using your local package, run the following commands in the
 `ohif/viewers` repository root:
@@ -1,3 +1,7 @@
+---
+sidebar_position: 1
+sidebar_label: Getting Started
+---
 # Getting Started

 ## Setup
@@ -70,7 +74,11 @@ You should see the following output:

 ### 🎉 Celebrate 🎉

-<div style="padding:56.25% 0 0 0;position:relative;"><iframe src="https://player.vimeo.com/video/545988245?badge=0&amp;autopause=0&amp;player_id=0&amp;app_id=58479" frameborder="0" allow="autoplay; fullscreen; picture-in-picture" allowfullscreen style="position:absolute;top:0;left:0;width:100%;height:100%;" title="getting-started"></iframe></div><script src="https://player.vimeo.com/api/player.js"></script>
+
+<div style={{padding:"56.25% 0 0 0", position:"relative"}}>
+    <iframe src="https://player.vimeo.com/video/545988245?badge=0&amp;autopause=0&amp;player_id=0&amp;app_id=58479" frameBorder="0" allow="autoplay; fullscreen; picture-in-picture" allowFullScreen style= {{ position:"absolute",top:0,left:0,width:"100%",height:"100%"}} title="measurement-report"></iframe>
+</div>
+

 ### Building for Production

@@ -1,3 +1,7 @@
+---
+sidebar_position: 4
+sidebar_label: Testing
+---
 # Running Tests for OHIF

 We introduce here various test types that is available
@@ -7,7 +11,7 @@ part of this page.

 ## Unit test
 To run the unit test:
-```
+```bash
 yarn run test:unit:ci
 ```

@@ -23,7 +27,7 @@ For running the OHIF e2e test you need to run the following steps:
 - Create a mini-pacs for OHIF to access the images for testing. We download
 and run our lightweight implementation which provides a collection of DICOM studies ([source code][mini-pacs]).

-  ```
+  ```bash
  docker run -p 5985:5985 -p 5984:5984 -e USE_POUCHDB=true -e DB_SERVER=http://0.0.0.0 ohif/viewer-testdata:0.1-test
  ```

@@ -33,7 +37,7 @@ and run our lightweight implementation which provides a collection of DICOM stud

 - Open a new terminal, navigate to the OHIF project, and run OHIF with the dicom-server config

-  ```
+  ```bash
  APP_CONFIG=config/dicomweb-server.js yarn start
  ```

@@ -43,7 +47,7 @@ and run our lightweight implementation which provides a collection of DICOM stud

 - Open a new terminal inside the OIHF project, and run the e2e cypress test

-  ```
+  ```bash
  yarn run test:e2e
  ```

@@ -63,7 +67,7 @@ and run our lightweight implementation which provides a collection of DICOM stud



-# Testing Philosiphy
+## Testing Philosiphy

 > Testing is an opinionated topic. Here is a rough overview of our testing
 > philosophy. See something you want to discuss or think should be changed? Open