From 830cb82965fdccdba4d9fdf27815f4bf7c2e6860 Mon Sep 17 00:00:00 2001
From: dannyrb <danny.ri.brown@gmail.com>
Date: Sat, 7 Dec 2019 00:12:08 -0500
Subject: [PATCH] docs: shift files around to match summary structure

---
 README.md                                     |  4 +--
 docs/latest/README.md                         |  4 +--
 docs/latest/SUMMARY.md                        | 20 +++++++------
 docs/latest/architecture/index.md             |  2 +-
 .../configuration.md                          | 28 +++++--------------
 .../data-source.md                            | 10 +++----
 docs/latest/deployment/index.md               | 12 ++++----
 .../recipes/build-for-production.md           |  7 +++--
 .../continous-integration.md                  |  0
 .../index.md => development/contributing.md}  |  2 +-
 .../{ => development}/getting-started.md      |  0
 .../{contributing => development}/testing.md  |  0
 docs/latest/{ => faq}/browser-support.md      |  0
 .../index.md}                                 |  8 +++---
 .../pwa-vs-packaged.md}                       |  2 +-
 docs/latest/{ => faq}/scope-of-project.md     |  0
 docs/latest/our-process.md                    |  2 +-
 .../{hotkeys/index.md => viewer/hotkeys.md}   |  0
 platform/i18n/README.md                       |  2 +-
 platform/ui/src/__docs__/translating.mdx      |  8 +++---
 platform/viewer/README.md                     |  2 +-
 21 files changed, 51 insertions(+), 62 deletions(-)
 rename docs/latest/{essentials => configuring}/configuration.md (71%)
 rename docs/latest/{essentials => configuring}/data-source.md (95%)
 rename docs/latest/{ => development}/continous-integration.md (100%)
 rename docs/latest/{contributing/index.md => development/contributing.md} (98%)
 rename docs/latest/{ => development}/getting-started.md (100%)
 rename docs/latest/{contributing => development}/testing.md (100%)
 rename docs/latest/{ => faq}/browser-support.md (100%)
 rename docs/latest/{frequently-asked-questions.md => faq/index.md} (92%)
 rename docs/latest/{essentials/installation.md => faq/pwa-vs-packaged.md} (99%)
 rename docs/latest/{ => faq}/scope-of-project.md (100%)
 rename docs/latest/{hotkeys/index.md => viewer/hotkeys.md} (100%)

diff --git a/README.md b/README.md
index de91e462b..e98971bcd 100644
--- a/README.md
+++ b/README.md
@@ -84,7 +84,7 @@ We offer support through
 
 For commercial support, academic collaberations, and answers to common
 questions; please read our
-[documented FAQ](https://docs.ohif.org/frequently-asked-questions.html#does-ohif-offer-commercial-support).
+[documented FAQ](https://docs.ohif.org/faq/index.html#does-ohif-offer-commercial-support).
 
 ## Quick Start Deployment
 
@@ -302,7 +302,7 @@ MIT © [OHIF](https://github.com/OHIF)
 [react-url]: https://reactjs.org/
 [pwa-url]: https://developers.google.com/web/progressive-web-apps/
 [ohif-viewer-url]: https://www.npmjs.com/package/@ohif/viewer
-[configuration-url]: https://docs.ohif.org/essentials/configuration.html
+[configuration-url]: https://docs.ohif.org/configuring/
 [extensions-url]: https://docs.ohif.org/extensions/
 <!-- Platform -->
 [platform-core]: platform/core/README.md
diff --git a/docs/latest/README.md b/docs/latest/README.md
index 4f9a8892b..296b83c41 100644
--- a/docs/latest/README.md
+++ b/docs/latest/README.md
@@ -38,9 +38,9 @@ our integration and extension points.
 Check out these helpful links:
 
 - Ready to dive into some code? Check out our
-  [Getting Started Guide](./getting-started.md).
+  [Getting Started Guide](./development/getting-started.md).
 - We're an active, vibrant community.
-  [Learn how you can be more involved.](./contributing/index.md)
+  [Learn how you can be more involved.](./development/contributing.md)
 - Feeling lost? Read our [help page](./help.md).
 
 <!--
diff --git a/docs/latest/SUMMARY.md b/docs/latest/SUMMARY.md
index 343ea1f6c..709cc1787 100644
--- a/docs/latest/SUMMARY.md
+++ b/docs/latest/SUMMARY.md
@@ -1,13 +1,14 @@
 # OHIF Viewers
 
 - [Our Process](our-process.md)
-- [Getting Started](getting-started.md)
-- Essentials
-  - [Installation](essentials/installation.md)
-  - [Data Source](essentials/data-source.md)
+- [Quick Start](quick-start.md)
+- Development
+  - [Getting Started](development/getting-started.md)
+  - [Contributing](development/contributing.md)
+  - [Continuous Integration](development/continous-integration.md)
+- [Configuring](configuring/index.md)
+  - [Data Source](configuring/data-source.md)
   - [Configuration](essentials/configuration.md)
-- [Contributing](contributing/index.md)
-  - [Continuous Integration](continous-integration.md)
 
 ---
 
@@ -54,7 +55,8 @@
 
 ---
 
-- [FAQ](frequently-asked-questions.md)
-- [Scope of Project](scope-of-project.md)
-- [Browser Support](browser-support.md)
+- [FAQ](faq/index.md)
+  - [Scope of Project](faq/scope-of-project.md)
+  - [Browser Support](faq/browser-support.md)
+  - [PWA vs Packaged](faq/pwa-vs-packaged.md)
 - [Help](help.md)
diff --git a/docs/latest/architecture/index.md b/docs/latest/architecture/index.md
index a5b7f570c..360148af3 100644
--- a/docs/latest/architecture/index.md
+++ b/docs/latest/architecture/index.md
@@ -151,7 +151,7 @@ you would need to recreate.
 [viewers-project]: https://github.com/OHIF/Viewers
 [viewer-npm]: https://www.npmjs.com/package/@ohif/viewer
 [pwa]: https://developers.google.com/web/progressive-web-apps/
-[configuration]: ../essentials/configuration.md
+[configuration]: ../configuring/index.md
 [extensions]: ../extensions/index.md
 [core-github]: https://github.com/OHIF/viewers/platform/core
 [ui-github]: https://github.com/OHIF/Viewers/platform/ui
diff --git a/docs/latest/essentials/configuration.md b/docs/latest/configuring/configuration.md
similarity index 71%
rename from docs/latest/essentials/configuration.md
rename to docs/latest/configuring/configuration.md
index 8a7624f86..8501ad2e8 100644
--- a/docs/latest/essentials/configuration.md
+++ b/docs/latest/configuring/configuration.md
@@ -2,9 +2,12 @@
 
 > This step assumes you have an imaging archive. If you need assistance setting
 > one up, check out the [`Data Source` Guide](./data-source.md) or a deployment
-> recipe that contains an open source Image Archive
+> recipe that contains an open Image Archive
 
-- [Configuration Files](#configuration-files)
+- [Overview](#overview)
+  - [Configuration Files](#configuration-files)
+  - [Environment Variables](#environment-variables)
+- [How do I configure my project?](#how-do-i-configure-my-project)
 
 ## Overview
 
@@ -18,8 +21,8 @@ and registered extension's features, are configured using this file.
 
 **Embedded Use Note:**
 
-Alternatively, when using the `commonjs` bundle for embedded use cases, these
-same values are what you'll pass to `installViewer` method:
+Alternatively, when using the `umd` bundle for embedded use cases, these same
+values are what you'll pass to `installViewer` method:
 
 `OHIFStandaloneViewer.installViewer(window.config)`
 
@@ -38,10 +41,6 @@ alternative data source (or even specify different default hotkeys).
 | `PROXY_TARGET`       | When developing, proxy requests that match this pattern to `PROXY_DOMAIN`                          | `undefined`         |
 | `PROXY_DOMAIN`       | When developing, proxy requests from `PROXY_TARGET` to `PROXY_DOMAIN`                              | `undefined`         |
 
-### Registering Extensions
-
-> :warn: Instructions coming soon
-
 ## How do I configure my project?
 
 The simplest way is to update the existing default config:
@@ -67,19 +66,6 @@ window.config = {
 };
 ```
 
-You can also create a new config file and specify its path relative to the build
-output's root by setting the `APP_CONFIG` environment variable. You can set the
-value of this environment variable a few different ways:
-
-- ~[Add a temporary environment variable in your shell](https://facebook.github.io/create-react-app/docs/adding-custom-environment-variables#adding-temporary-environment-variables-in-your-shell)~
-  - Previous `react-scripts` functionality that we need to duplicate with
-    `dotenv-webpack`
-- ~[Add environment specific variables in `.env` file(s)](https://facebook.github.io/create-react-app/docs/adding-custom-environment-variables#adding-development-environment-variables-in-env)~
-  - Previous `react-scripts` functionality that we need to duplicate with
-    `dotenv-webpack`
-- Using the `cross-env` package in an npm script:
-  - `"build": "cross-env APP_CONFIG=config/my-config.js react-scripts build"`
-
 After updating the configuration, `yarn run build` to generate updated build
 output.
 
diff --git a/docs/latest/essentials/data-source.md b/docs/latest/configuring/data-source.md
similarity index 95%
rename from docs/latest/essentials/data-source.md
rename to docs/latest/configuring/data-source.md
index 46ee770bd..1f9cbbb5b 100644
--- a/docs/latest/essentials/data-source.md
+++ b/docs/latest/configuring/data-source.md
@@ -1,9 +1,9 @@
 # Data Source
 
 After following the steps outlined in
-[Getting Started](./../getting-started.md), you'll notice that the OHIF Viewer
-has data for several studies and their images. You didn't add this data, so
-where is it coming from?
+[Getting Started](./../development/getting-started.md), you'll notice that the
+OHIF Viewer has data for several studies and their images. You didn't add this
+data, so where is it coming from?
 
 By default, the viewer is configured to connect to a remote server hosted by the
 nice folks over at [dcmjs.org][dcmjs-org]. While convenient for getting started,
@@ -85,7 +85,7 @@ yarn run dev:orthanc
 #### Configuration: Learn More
 
 > For more configuration fun, check out the
-> [Essentials Configuration](./configuration.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`. That script
@@ -131,7 +131,7 @@ window.config = {
 ```
 
 To learn more about how you can configure the OHIF Viewer, check out our
-[Configuration Guide](./configuration.md).
+[Configuration Guide](./index.md).
 
 ## Open Source DICOM Image Archives
 
diff --git a/docs/latest/deployment/index.md b/docs/latest/deployment/index.md
index c4b1cc88c..5e2a7a528 100644
--- a/docs/latest/deployment/index.md
+++ b/docs/latest/deployment/index.md
@@ -10,9 +10,9 @@ your Viewer will display).
 ## Overview
 
 Our goal is to make deployment as simple and painless as possible; however,
-there is an inherent amount of complexity in customizing, optimizing, and
-deploying web applications. If you find yourself a little lost, please don't
-hesitate to [reach out for help](/help.md)
+there is an inherent amount of complexity in configuring and deploying web
+applications. If you find yourself a little lost, please don't hesitate to
+[reach out for help](/help.md)
 
 ## Deployment Scenarios
 
@@ -96,12 +96,12 @@ support it yet, but it is gaining wider adoption.
 If you have an existing archive and intend to host the OHIF Viewer at the same
 domain name as your archive, then connecting the two is as simple as following
 the steps layed out in our
-[Configuration Essentials Guide](./../essentials/configuration.md).
+[Configuration Essentials Guide](./../configuring/index.md).
 
 #### What if I don't have an imaging archive?
 
 We provide some guidance on configuring a local image archive in our
-[Data Source Essentials](./../essentials/data-source.md) guide. Hosting an
+[Data Source Essentials](./../configuring/data-source.md) guide. Hosting an
 archive remotely is a little trickier. You can check out some of our
 [advanced recipes](#recipes) for modeled setups that may work for you.
 
@@ -142,7 +142,7 @@ The OHIF Viewer can be configured to work with authorization servers that
 support one or more of the OpenID-Connect authorization flows. The Viewer finds
 it's OpenID-Connect settings on the `oidc` configuration key. You can set these
 values following the instructions laid out in the
-[Configuration Essentials Guide](./../essentials/configuration.md).
+[Configuration Essentials Guide](./../configuring/index.md).
 
 _Example OpenID-Connect Settings:_
 
diff --git a/docs/latest/deployment/recipes/build-for-production.md b/docs/latest/deployment/recipes/build-for-production.md
index 394e5a71e..5328a7963 100644
--- a/docs/latest/deployment/recipes/build-for-production.md
+++ b/docs/latest/deployment/recipes/build-for-production.md
@@ -1,7 +1,8 @@
 # Build for Production
 
-> If you've already followed the ["Getting Started" Guide](/getting-started.md),
-> you can skip ahead to [Configuration](#configuration)
+> If you've already followed the
+> ["Getting Started" Guide](/development/getting-started.md), you can skip ahead
+> to [Configuration](#configuration)
 
 ## Overview
 
@@ -72,7 +73,7 @@ and registered extension's features, are configured using this file.
 
 The easiest way to apply your own configuration is to modify the `default.js`
 file. For more advanced cofiguration options, check out our
-[configuration essentials guide](/essentials/configuration.md).
+[configuration essentials guide](/configuring/index.md).
 
 ## Next Steps
 
diff --git a/docs/latest/continous-integration.md b/docs/latest/development/continous-integration.md
similarity index 100%
rename from docs/latest/continous-integration.md
rename to docs/latest/development/continous-integration.md
diff --git a/docs/latest/contributing/index.md b/docs/latest/development/contributing.md
similarity index 98%
rename from docs/latest/contributing/index.md
rename to docs/latest/development/contributing.md
index dac5c0dae..bd78e3513 100644
--- a/docs/latest/contributing/index.md
+++ b/docs/latest/development/contributing.md
@@ -7,7 +7,7 @@ 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](/getting-started.md)
+- [Getting Started](/development/getting-started.md)
 - [Architecture](/architecture/index.md)
 
 Pull requests that are:
diff --git a/docs/latest/getting-started.md b/docs/latest/development/getting-started.md
similarity index 100%
rename from docs/latest/getting-started.md
rename to docs/latest/development/getting-started.md
diff --git a/docs/latest/contributing/testing.md b/docs/latest/development/testing.md
similarity index 100%
rename from docs/latest/contributing/testing.md
rename to docs/latest/development/testing.md
diff --git a/docs/latest/browser-support.md b/docs/latest/faq/browser-support.md
similarity index 100%
rename from docs/latest/browser-support.md
rename to docs/latest/faq/browser-support.md
diff --git a/docs/latest/frequently-asked-questions.md b/docs/latest/faq/index.md
similarity index 92%
rename from docs/latest/frequently-asked-questions.md
rename to docs/latest/faq/index.md
index f47c6b0f7..7f8c9e670 100644
--- a/docs/latest/frequently-asked-questions.md
+++ b/docs/latest/faq/index.md
@@ -19,10 +19,10 @@ Follow the steps outlined in the [Bug Report Template][bug-report-template].
 At the moment we are in the process of defining our roadmap and will do our best
 to communicate this to the community. If your requested feature is on the
 roadmap, then it will most likely be built at some point. If it is not, you are
-welcome to build it yourself and [contribute it](contributing/index.md). If you
-have resources and would like to fund the development of a feature, please
-[contact us](http://www.ohif.org) or work with community members that offer
-[consulting services][commercial-support].
+welcome to build it yourself and [contribute it](development/contributing.md).
+If you have resources and would like to fund the development of a feature,
+please [contact us](http://www.ohif.org) or work with community members that
+offer [consulting services][commercial-support].
 
 ### Who should I contact about Academic Collaborations?
 
diff --git a/docs/latest/essentials/installation.md b/docs/latest/faq/pwa-vs-packaged.md
similarity index 99%
rename from docs/latest/essentials/installation.md
rename to docs/latest/faq/pwa-vs-packaged.md
index 94807e931..b8ed50923 100644
--- a/docs/latest/essentials/installation.md
+++ b/docs/latest/faq/pwa-vs-packaged.md
@@ -1,4 +1,4 @@
-# Installation
+# PWA vs Packaged
 
 It's important to know that the OHIF Viewer project provides two different build
 processes:
diff --git a/docs/latest/scope-of-project.md b/docs/latest/faq/scope-of-project.md
similarity index 100%
rename from docs/latest/scope-of-project.md
rename to docs/latest/faq/scope-of-project.md
diff --git a/docs/latest/our-process.md b/docs/latest/our-process.md
index 2f16d1f63..596d9fc58 100644
--- a/docs/latest/our-process.md
+++ b/docs/latest/our-process.md
@@ -105,7 +105,7 @@ quality and test coverage must not changed by a significant margin. For some
 repositories, visual screenshot-based tests are also included, and video
 recordings of end-to-end tests are stored for later review.
 
-[You can read more about our continous integration efforts here](/continous-integration.md)
+[You can read more about our continous integration efforts here](/development/continous-integration.md)
 
 ## Releases
 
diff --git a/docs/latest/hotkeys/index.md b/docs/latest/viewer/hotkeys.md
similarity index 100%
rename from docs/latest/hotkeys/index.md
rename to docs/latest/viewer/hotkeys.md
diff --git a/platform/i18n/README.md b/platform/i18n/README.md
index d2b5bb710..080fac5be 100644
--- a/platform/i18n/README.md
+++ b/platform/i18n/README.md
@@ -1,4 +1,4 @@
 # @ohif/i18n
 
 More information available at
-[OHIF Docs](https://docs.ohif.org/essentials/translating.html).
+[OHIF Docs](https://docs.ohif.org/viewer/internationalization.html).
diff --git a/platform/ui/src/__docs__/translating.mdx b/platform/ui/src/__docs__/translating.mdx
index 0fe4f9bab..194ad0c80 100644
--- a/platform/ui/src/__docs__/translating.mdx
+++ b/platform/ui/src/__docs__/translating.mdx
@@ -34,7 +34,7 @@ export default withTranslation('MyNameSpace')(MyComponent);
 ## Namespaces
 
 For further information about namespaces and how they work, please visit
-[OHIF Namespaces docs](https://docs.ohif.org/essentials/translating.html#namespaces).
+[OHIF Namespaces docs](https://docs.ohif.org/viewer/internationalization.html#namespaces).
 
 ### How to get right the Namespace of a `@ohif/ui` component?
 
@@ -71,12 +71,12 @@ export default withTranslation('OuterSpace')(TheComponent);
 
 ## Extending and Overriding languages
 
-[How to Extend languages with @ohif/i18n](https://docs.ohif.org/essentials/translating.html#extending-languages-in-ohifi18n)
+[How to Extend languages with @ohif/i18n](https://docs.ohif.org/viewer/internationalization.html#extending-languages-in-ohifi18n)
 
 ## Changing the language
 
 The language choosing method is the same implemented in
-[OHIF Viewers](https://docs.ohif.org/essentials/translating.html#changing-the-language)
+[OHIF Viewers](https://docs.ohif.org/viewer/internationalization.html#changing-the-language)
 
 > You can also change the language of the components displayed in this
 > documentation by choosing an option in the
@@ -84,4 +84,4 @@ The language choosing method is the same implemented in
 
 ## Debugging translations
 
-[How to Debug @ohif/i18n](https://docs.ohif.org/essentials/translating.html#debugging-translations)
+[How to Debug @ohif/i18n](https://docs.ohif.org/viewer/internationalization.html#debugging-translations)
diff --git a/platform/viewer/README.md b/platform/viewer/README.md
index 56a7c2a6f..e47a9f9ab 100644
--- a/platform/viewer/README.md
+++ b/platform/viewer/README.md
@@ -194,7 +194,7 @@ Links:
 [react-url]: https://reactjs.org/
 [pwa-url]: https://developers.google.com/web/progressive-web-apps/
 [ohif-viewer-url]: https://www.npmjs.com/package/ohif-viewer
-[configuration-url]: https://docs.ohif.org/essentials/configuration.html
+[configuration-url]: https://docs.ohif.org/configuring/
 [extensions-url]: https://docs.ohif.org/extensions
 <!-- Misc. -->
 [react-viewer]: https://github.com/OHIF/Viewers/tree/react