Merge pull request #387 from dannyrb/chore/update-docs-outline

chore: restore docs
2019-04-17 14:43:35 -04:00 · 2019-04-17 14:43:35 -04:00 · 891118afa0
commit 891118afa0
parent a9896b0135 4941e271ed
12 changed files with 12827 additions and 159 deletions
--- a/.gitignore
+++ b/.gitignore
@ -5,7 +5,6 @@ node_modules
 build
 dist
 docs/_book
-src/sha.js
 src/version.js

 # YALC (for Erik)
@ -16,5 +15,6 @@ yalc.lock
 .idea/
 .npm
 npm-debug.log
+package-lock.json
 yarn-error.log
 .DS_Store
--- a/.travis.yml
+++ b/.travis.yml
@ -1,123 +0,0 @@
-language: node_js
-
-node_js:
-  - "lts/*"
-
-services:
-  - docker
-
-before_script:
-  - export PATH=$HOME/.meteor:$PATH
-
-cache:
-  directories:
-    - ~/.meteor
-    - node_modules
-    - OHIFViewer/node_modules
-
-env:
-  global:
-    - METEOR_PACKAGE_DIRS=../Packages
-    - secure: "ZhIMR4geQP/BXdXrQkcARPCSPnyry2aTgszo+Jg+lZfRHWil2FmAweCiWyOC/5rRxrYYSik/ZyEMAX54v9N9sNjYsPlA9UFqovMirEQhXCYmIG+DNBsU58zgnrDWQoolF1xD4f/IFtLjUGG9WQNR7SavHeL/2VmWK9Nis8TChnyTdmlL8IaWEeKjznseLqyVKZSMb490bG34I4ztdumaYHWWt01uhNFZ/XA048NVd/E8LhO7yLIqwtmCt7Cr1Z61TfSzgyajJaCiuTLvrNDU8W/f/j4wlhybGJruvvOH9qDPRRp2aw3surgAB33irZftYFgG1h/6NjjKeRrBvqocW9sZdAeXWcqw4xiNyi4AbbSGk5aPrFuYMswJWP0/i9MkSF5N0eRcFoWl/DvTeaG4bkzTQquT29pdYE/Ef3KXDgKevwUKH0OBU79v8VSLjIT9Tr0ps/FOvNXjeGHjI6FoqCkLt2XYgDMteltRC7rjtmxTGBRpQQFoRksa/11jwr6t5YNxYootzM11g8EFA/uX56aJHkTjZBpSzMsImDPsWjpqu/MTttVmdtq6iFEkA9NBwZYIZEJBmiy/wfNXhNgCe2lDuaSdK6MMF8PHXWIjvcW2/+h6u355ktr+LRXeolVuYDIAaN3SDSJBsDkJg4duYWuCeq8ptJ4bzeRjZtPchew=" # DOCKER_USER
-    - secure: "PrUMwM360a1KMLhfIPmx7qp9+Ry2cMDJpW4WspE28UQTrqcSZdhUYFCs5Q2DISZXrZWGI1/utHK+JYeqCAt3xOf3qRsLqupzJIPqzMPyb2AKtyR1JbJZGyBv7y4s6HMrXZ9pNfRBoR7hHFtiZfmTBo8avpMne8gBN1JGGXM0GTqbZwY6JGAG+vQ0Nt+DculhEraDAzFdNF5vBO+lg8wTmvh2qp+espa+4i9JzjTeRk8O09+33jkqRFugZtJOcgIi9iBvZjKUPedmFA1w/hU3lHLUuofi7tTmpAOyqaQyB8Grfj1JsgaCfbOZQs7kPHtsQ1Ai0zw2MbJtTKoA8kHcU9XWDU4Kxa1K1qXyp+ZdofTXYYnHkN4pgS+EU2it/OlKnpJV4I73JK28aF7A+fe8zheWkpJV8rFBiI04xXdILr+jxQKfdM4TOWos/XShp4bJru4VJuIfnveKuR+1EPIpuOhJ2jj4HB7g6AbIAbGsjICbFq98jSiXENeGaYmx1qIBSIlFn+lLJxp40fx/OsGKC0y5orfDgyUcPUkseckEk/H7zc90DGdCLCFmJVVgrKGWnfq8ifFI8GPVTomUVy41PLGv1LTCIYyrjM02mxLIEMIKrKboy4MSbaOidasaobjYFtwjABR3GLnUK5ETLANhO0LLC4Z4w6KFvARFfZ6JPec=" # DOCKER_PASS
-    - secure: "G5qjTBS6CuCCtueEqCRAEUhznycGz2kRXB7nChUK/ftKbAMW6F487sj8uujDEO0CXTv9aWnKyrPoXPnhlB5APQ5PtmC8F8DJEqWGW29J/oBv1giJq2K2Elcz6a0a7ys8pTgGKJyDT+mEvFF9boxVKI/eZQ+4ACI0EkGHBakpzey7Y1YSMsymtG6eM3ic1Fgrxna8FynzazKS0YdoE5Aj6yPDVpfj/7vSucz3wR3r2JxMtq95hiWKWYPdc/iir0dcDnedU+MF9aaAUv+ReHpM6FPScnan4mqOhrYKK5sBx27p0C/IxJhtaB4RVzU2F0kYLynK1vgUOBFc+9H/G2P+wl6TfO5dGjMmGU6kF2eWtTzRqT7JELRdqu9v/QGOlKpKmhmA3diGfkY0E2keEUyIRchHZAZKYQfLUhUObYcve2/4skmg9qhcxSMuh2qjkfTyFj/M4mcfkTZZWB9izgkHO2O3MxQm1d5DJDtoSfNQZOZiLjckyxmghWF3TEKNp3OhDOt+JikrDboZBts3F9+ocAVjLyg3upmWnlE6rFfkmVtWCXmI6Rto+laHtV/ng83Z3M4wL3VcvoOlPXLb0moqCGN4HGvpfolBqryFksGbUybaIqbQ7hQHhQuThzQ9UHq0AQN44rwzxEuKbxY7bTuyb4vSEAkrvjeLFbz4MSHQgno=" # AWS_ACCESS_KEY_ID
-    - secure: "ngqtUAXc8sR84CZTzOtRmg+Di/UFXCASV5bLHBmbgmXrvidIisHGW8O7TTx54ZU4UXlbY+Rg/8K6iIyy+uuCLhRcVRDW4sxacdQTNnoDPDNczqwrbBrOCLU7aW0imNBcIDqEvza+1fXsBrFV/iejtOFYVPn4l/yAb/j9MVo65hTGaKwQ4371lNMbRQp9p9DTEGGmkABo/EOtvbNR2H4qVgTuzeR8XdHC8GJUN0bujwQoK3EPTgkaMO6M7XevSNieO35opmy/Ip0GKYNTt4smKPQrUIokokwApCrjn2URdcGLoHENTTHtjLWMM0QMOV47qRBD+FeVaTUe0I4MB1toEZEIck+Vdy7PTCQ/f1HZtlI+bbDLlDPFwB/EMr7J1EKbudu7NnRopN6/zWupmDnL9VWxZy9boCDXCF47OxL1Kba9qqPYigiaS4vQEXygrceQgr+22axowtgTYYyhcsIbXQPq8COlLS/Ls/OgJMKIcQjMhTlKw01B/a08yZ0WxfVD9HJJbDA4EJiztOT7IZCyJvSv1mxJ8uI5hHC4TUBMWIKM6hVVZb0bjvtJjq7kFP9T4gCe/+OKxLIsSqWwY8AZoot6bY5lreZvb0epmyeM4fmf6qQxjIUviaGgj2o4eU7awDQzevwS8hNTsXPdFGItVUrjtKyLFHPkCMiZcTskSZo=" # AWS_SECRET_ACCESS_KEY
-    - secure: "TfbqhcBGGRbvmJ5KevU60dyCczRbiX7Pt1N36Bgy8Ozj6Cv79jC1K+AaB98j+Q1e0A7PaL7sbuOy7hIV/OqePhGEk0D2mowYj8/ORp14UXQ89FpIL7exUCXSwSPhCIwUaGdY4S5yT0DL1rkb5qeSS8L9KEEEVPvVY1F2vGE/lzzgS1MCLCdk7ajs+3c9HP9N4J2PjYRg3WFkgWmfGNitEjGApSJ91NIJW4Sw9pqLhweWqKO8sAbpsADlE+NhfoDd0kzDTkecxWzSf3siO6yfGKAeh3bf8WE4qZReuLXYDWL3XjJ3LTfK018P1J8Cx9PlMb3M+nHU0B3T6mC1t+XtLrUE/fr1LF89diyDCSRB+ZW2H/l8SNQNVIqgTrXzoBcwqGNeZOPJwd2qcq1vLDAkxgC5QFsoRfyxJmzNff70ESClSmBQy/mNd/pXQZ9JZRMoa097j4pXGZlLGarotiCYUdtlPSZmN/eMsIhLtvxNQ8ryk1ASij5sN7WOdg0r+gZcDAY8AwuuDpmktEu9pHd7iEVFw78DIJmD1N5OgKYdVT6o0WTJnVySBf/+luYK9J/rd6vwvlB4C2LLzhEkWlAGp6n7rl/1V18akM+HPVUPWuDRH69ZYWRPq4TIZwfEPTEG4jYizlTjkn55R+CNi3AWoxL2kr1Qv+zUJSruIvixWvc=" # GITHUB_TOKEN
-
-jobs:
-  include:
-    - stage: build production docker image
-      before_script:
-        - export REPO=ohif/viewer
-        - export COMMIT=${TRAVIS_COMMIT::8}
-        - export BRANCH=$(if [ "$TRAVIS_PULL_REQUEST" == "false" ]; then echo $TRAVIS_BRANCH; else echo $TRAVIS_PULL_REQUEST_BRANCH; fi)
-        - echo "TRAVIS_BRANCH=$TRAVIS_BRANCH, PR=$PR, BRANCH=$BRANCH"
-        - export TAG=`if [ "$BRANCH" == "master" ]; then echo "latest"; else echo $BRANCH ; fi`
-        - echo "TAG=$TAG, COMMIT=$COMMIT"
-        - docker pull $REPO:latest
-        - docker --version
-      script:
-        - docker build -t $REPO:$COMMIT . --cache-from $REPO:latest
-      after_success:
-        - docker tag $REPO:$COMMIT $REPO:$TAG
-        - docker tag $REPO:$COMMIT $REPO:travis-$TRAVIS_BUILD_NUMBER
-        - docker images
-        - docker login -u $DOCKER_USER -p $DOCKER_PASS
-        - docker push $REPO:$TAG
-        - docker push $REPO:travis-$TRAVIS_BUILD_NUMBER
-        - docker push $REPO:$COMMIT
-
-    - stage: build development docker image
-      before_script:
-        - export REPO=ohif/viewer-dev
-        - export COMMIT=${TRAVIS_COMMIT::8}
-        - export BRANCH=$(if [ "$TRAVIS_PULL_REQUEST" == "false" ]; then echo $TRAVIS_BRANCH; else echo $TRAVIS_PULL_REQUEST_BRANCH; fi)
-        - echo "TRAVIS_BRANCH=$TRAVIS_BRANCH, PR=$PR, BRANCH=$BRANCH"
-        - export TAG=`if [ "$TRAVIS_BRANCH" == "master" ]; then echo "latest"; else echo $TRAVIS_BRANCH ; fi`
-        - echo "TAG=$TAG, COMMIT=$COMMIT"
-        - docker pull $REPO:latest
-        - docker --version
-      script:
-        - docker build -f development.Dockerfile -t $REPO:$COMMIT . --cache-from $REPO:latest
-      after_success:
-        - docker tag $REPO:$COMMIT $REPO:$TAG
-        - docker tag $REPO:$COMMIT $REPO:travis-$TRAVIS_BUILD_NUMBER
-        - docker images
-        - docker login -u $DOCKER_USER -p $DOCKER_PASS
-        - docker push $REPO:$TAG
-        - docker push $REPO:travis-$TRAVIS_BUILD_NUMBER
-        - docker push $REPO:$COMMIT
-
-    - stage: build standalone viewer
-      if: branch = master
-      before_script:
-        - export ROOT_URL=http://ohif-viewer.s3-website.eu-central-1.amazonaws.com
-        - export METEOR_PACKAGE_DIRS="../../Packages"
-        - cd StandaloneViewer
-        - mkdir buildDirectory
-        - cd StandaloneViewer
-        - npm install -g meteor-build-client-fixed@0.4.3
-        - meteor-build-client-fixed --version
-        - curl https://install.meteor.com | /bin/sh
-        - meteor npm install
-      script:
-        - meteor-build-client-fixed ~/standaloneViewerBuild -u $ROOT_URL
-      after_success:
-        - ls ~/standaloneViewerBuild
-        - ls /home/travis
-        - ls /home/travis/build
-        - ls /home/travis/build/Viewers/StandaloneViewer
-      deploy:
-        provider: s3
-        access_key_id: $AWS_ACCESS_KEY_ID
-        secret_access_key: $AWS_SECRET_ACCESS_KEY
-        bucket: ohif-viewer
-        region: eu-central-1
-        skip_cleanup: true
-        local_dir: /home/travis/standaloneViewerBuild
-        acl: public_read
-        on:
-          branch: master
-
-    - stage: build documentation
-      if: branch = master
-      before_script:
-        - cd docs
-        - rm -rf _book
-        - npm install
-        - npm install -g gitbook-cli
-        - gitbook install
-      script:
-        - gitbook build
-      after_success:
-        - cp assets/CNAME _book/CNAME
-      deploy:
-        provider: pages
-        skip-cleanup: true
-        local-dir: docs/_book
-        github-token: $GITHUB_TOKEN
-        keep-history: true
-        fqdn: docs.ohif.org
-        verbose: true
-        on:
-          branch: master
--- a/docs/latest/assets/CNAME
+++ b/docs/latest/assets/CNAME
--- a/docs/latest/README.md
+++ b/docs/latest/README.md
@ -1,6 +1,6 @@
 ##### Looking for your Deploy Preview? - <a onclick="function redirect() { window.location.href='/demo/'; } redirect();">Deploy Preview for Viewer</a>

-# Introduction
+# Introduction - test

 The [Open Health Imaging Foundation](https://www.ohif.org) is developing an open source framework for constructing web-based medical imaging applications.

--- a/docs/latest/SUMMARY.md
+++ b/docs/latest/SUMMARY.md
@ -2,9 +2,9 @@

 - Documentation Version
 - <select>
-      <option value="v1">1.0 (Meteor)</option>
-      <option value="latest">Saab</option>
-    </select>
+    <option value="v1">1.0 (Meteor)</option>
+    <option value="latest">Saab</option>
+  </select>

 - Essentials
  - [Getting Started](essentials/getting-started.md)
--- a/generateStaticSite.sh
+++ b/generateStaticSite.sh
@ -22,7 +22,7 @@ for D in *; do
 done

 # Move CNAME File into `latest`
-cp CNAME ./latest/CNAME
+cp CNAME ./latest/_book/CNAME

 # Create a history folder in our latest version's output
 mkdir ./latest/_book/history
@ -41,20 +41,18 @@ done
 cd ..

 # Build and copy the StandaloneViewer into the static directory
-echo $DEPLOY_PRIME_URL
-cd Packages-react/ohif-viewer
-export ROOT_URL=$DEPLOY_PRIME_URL/demo
+# echo $DEPLOY_PRIME_URL
+# export ROOT_URL=$DEPLOY_PRIME_URL/demo

-cat package.json
-yarn install
-yarn build
+# cat package.json
+# yarn install
+# yarn build

-cd example
-yarn install
-yarn run prepare
-sed -i "s,http://localhost:5000,${ROOT_URL},g" index.html
-sed -i 's,"routerBasename": "/","routerBasename": "/demo",g' index.html
-rm -rf node_modules
-mkdir ../../../docs/latest/_book/demo/
-cp -R * ../../../docs/latest/_book/demo/
-cp ../../../_redirects ../../../docs/latest/_book/_redirects
+# cd example
+# yarn install
+# yarn run prepare
+# sed -i "s,http://localhost:5000,${ROOT_URL},g" index.html
+# sed -i 's,"routerBasename": "/","routerBasename": "/demo",g' index.html
+# rm -rf node_modules
+# mkdir docs/latest/_book/demo/
+# cp -R * docs/latest/_book/demo/
--- a/netlify.toml
+++ b/netlify.toml
@ -2,4 +2,17 @@
  # Directory (relative to root of your repo) that contains the deploy-ready 
  # HTML files and assets generated by the build. If a base directory has
  # been specified, include it in the publish directory path.
-  publish = "docs/latest/_book/"
+  publish = "docs/latest/_book/"
+
+# COMMENT: NODE_VERSION in root `.nvmrc` takes priority
+# COMMENT: Why we specify YARN_FLAGS: https://www.netlify.com/docs/build-gotchas/#yarn
+[build.environment]
+  NODE_VERSION = "10.15.3"
+  YARN_VERSION = "1.15.2"
+  YARN_FLAGS = "--no-ignore-optional --pure-lockfile"
+
+# COMMENT: This a rule for Single Page Applications
+[[redirects]]
+  from = "/*"
+  to = "/index.html"
+  status = 200
--- a/package.json
+++ b/package.json
@ -15,22 +15,19 @@
    "npm": ">=5"
  },
  "scripts": {
-    "build": "node --max-old-space-size=8192 node_modules/rollup/bin/rollup -c",
-    "prepublishOnly": "npm run build",
+    "build": "yarn run prep && node --max-old-space-size=8192 node_modules/rollup/bin/rollup -c",
+    "prepublishOnly": "yarn run build",
    "lint": "eslint -c .eslintrc --fix src && prettier --single-quote --write src/**/*.{js,jsx,json,css}",
-    "prepare": "npm run build",
-    "predeploy": "cd example && npm install && npm run build",
-    "deploy": "gh-pages -d example/build",
-    "generateStaticSite": "./generateStaticSite.sh",
+    "prepare": "yarn run build",
+    "predeploy": "cd example && npm install && yarn run build",
    "staticDeploy": "./generateStaticSite.sh",
    "test:watch": "react-scripts test --env=jsdom",
    "test": "cross-env CI=1 react-scripts test --env=jsdom",
    "copy:webworkers": "cpx 'node_modules/cornerstone-wado-image-loader/dist/*.min.js*' public",
    "version": "node -p -e \"'export default \\'' + require('./package.json').version + '\\';'\" > src/version.js",
-    "sha": "echo \"export default '\"$(git rev-parse HEAD)\"';\" > src/sha.js",
-    "details": "npm run version && npm run sha",
-    "prep": "npm run details && npm run copy:webworkers",
-    "start": "npm run prep && cross-env PORT=5000 react-scripts start",
+    "details": "yarn run version",
+    "prep": "yarn run details && yarn run copy:webworkers",
+    "start": "yarn run prep && cross-env PORT=5000 react-scripts start",
    "start:debug": "cross-env PORT=5000 react-scripts start"
  },
  "peerDependencies": {
@ -87,7 +84,6 @@
    "eslint-plugin-node": "^8.0.0",
    "eslint-plugin-promise": "^4.0.1",
    "eslint-plugin-react": "^7.11.1",
-    "gh-pages": "^2.0.1",
    "husky": "^1.3.1",
    "lint-staged": "^8.1.0",
    "lodash.clonedeep": "^4.5.0",
--- a/rollup.config.js
+++ b/rollup.config.js
@ -50,7 +50,7 @@ export default {
    commonjs({
        include: 'node_modules/**',
        namedExports: {
-            'node_modules/react-is/index.js': ['isValidElementType'],
+            'node_modules/react-is/index.js': ['isValidElementType', 'isContextConsumer'],
            'node_modules/redux-oidc/dist/redux-oidc.js': [
              'reducer', 'CallbackComponent', 'loadUser', 'OidcProvider', 'createUserManager'
            ],
--- a/src/config.js
+++ b/src/config.js
@ -2,12 +2,10 @@ import dicomParser from 'dicom-parser';
 import cornerstone from 'cornerstone-core';
 import cornerstoneWADOImageLoader from 'cornerstone-wado-image-loader';
 import OHIF from 'ohif-core';
-import sha from './sha.js';
 import version from './version.js';
 import { homepage } from '../package.json';

 window.info = {
-  sha,
  version,
  homepage
 };
--- a/src/sha.js
+++ b/src/sha.js
@ -0,0 +1 @@
+// "export default '"$(git rev-parse HEAD)"';"
--- a/yarn.lock
+++ b/yarn.lock
				`@ -0,0 +1 @@`
				`// "export default '"$(git rev-parse HEAD)"';"`