working docs v2 before versioning

2021-06-15 19:11:09 -04:00
1 parent 4971937171
commit ae18a92ee5
@@ -0,0 +1,4 @@
+{
+  "label": "Development",
+  "position": 3
+}
@@ -1,3 +1,7 @@
+---
+sidebar_position: 3
+title: Continous Integration
+---
 # Continous Integration (CI)

 This repository uses `CircleCI` and `Netlify` for continous integration.
@@ -25,12 +29,15 @@ 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;">
+<!-- <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>
+</div> -->
+
+
+![PR_CHECKS](../assets/img/WORKFLOW_PR_CHECKS.png)

 ### Workflow: PR_OPTIONAL_DOCKER_PUBLISH

@@ -38,12 +45,16 @@ 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;">
+<!-- <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>
+</div> -->
+
+![publish](../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 +67,14 @@ 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;">
+<!-- <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>
+</div> -->
+
+![deploy](../assets/img/WORKFLOW_DEPLOY.png)

 | Environment | Description                                                                        | URL                                           |
 | ----------- | ---------------------------------------------------------------------------------- | --------------------------------------------- |
@@ -82,12 +95,15 @@ 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;">
+<!-- <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>
+</div> -->
+
+
+![release](../assets/img/WORKFLOW_RELEASE.png)

 ### HOTFIX

@@ -1,3 +1,7 @@
+---
+sidebar_position: 2
+title: Contributing
+---
 # Contributing

 ## How can I help?
@@ -7,8 +11,8 @@ like to discuss the changes you intend to make to clarify where or how they
 should be implemented, please don't hesitate to create a new issue. At a
 minimum, you may want to read the following documentation:

- [Getting Started](/development/getting-started.md)
- [Architecture](/architecture/index.md)
+- [Getting Started](./getting-started.md)
+- [Architecture](../architecture/index.md)

 Pull requests that are:

@@ -34,8 +38,7 @@ dependencies:

 On your local file system:

-```bash
-# code/my-projects/
+```bash  title="/my-projects/"
 .
 ├── cornerstonejs/cornerstone-tools
 └── ohif/viewers
@@ -55,12 +58,10 @@ 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>
+
+![example of linked cornerstone-tools package](../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:
@@ -72,8 +73,7 @@ If you wish to stop using your local package, run the following commands in the

 On your local file system:

-```bash
-# code/my-projects/
+```bash  title="/my-projects/"
 .
 ├── ohif/react-vtkjs-viewport
 └── ohif/viewers
@@ -1,3 +1,7 @@
+---
+sidebar_position: 1
+title: Getting Started
+---
 # Getting Started

 ## Setup
@@ -69,10 +73,12 @@ You should see the following output:



-<center>
-  <div style="padding:56.25% 0 0 0;position:relative;"><iframe src="https://player.vimeo.com/video/547952862?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 (v2)"></iframe></div><script src="https://player.vimeo.com/api/player.js"></script>
-  <i>Our app, hosted by the development server</i>
-</center>
+
+<div style={{padding:"56.25% 0 0 0", position:"relative"}}>
+    <iframe src="https://player.vimeo.com/video/547952862?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,4 +1,8 @@
-# Contributing: Tests
+---
+sidebar_position: 4
+title: Testing
+---
+# Tests

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