docs: shift files around to match summary structure
This commit is contained in:
parent
9a71edda6a
commit
830cb82965
@ -84,7 +84,7 @@ We offer support through
|
|||||||
|
|
||||||
For commercial support, academic collaberations, and answers to common
|
For commercial support, academic collaberations, and answers to common
|
||||||
questions; please read our
|
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
|
## Quick Start Deployment
|
||||||
|
|
||||||
@ -302,7 +302,7 @@ MIT © [OHIF](https://github.com/OHIF)
|
|||||||
[react-url]: https://reactjs.org/
|
[react-url]: https://reactjs.org/
|
||||||
[pwa-url]: https://developers.google.com/web/progressive-web-apps/
|
[pwa-url]: https://developers.google.com/web/progressive-web-apps/
|
||||||
[ohif-viewer-url]: https://www.npmjs.com/package/@ohif/viewer
|
[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/
|
[extensions-url]: https://docs.ohif.org/extensions/
|
||||||
<!-- Platform -->
|
<!-- Platform -->
|
||||||
[platform-core]: platform/core/README.md
|
[platform-core]: platform/core/README.md
|
||||||
|
|||||||
@ -38,9 +38,9 @@ our integration and extension points.
|
|||||||
Check out these helpful links:
|
Check out these helpful links:
|
||||||
|
|
||||||
- Ready to dive into some code? Check out our
|
- 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.
|
- 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).
|
- Feeling lost? Read our [help page](./help.md).
|
||||||
|
|
||||||
<!--
|
<!--
|
||||||
|
|||||||
@ -1,13 +1,14 @@
|
|||||||
# OHIF Viewers
|
# OHIF Viewers
|
||||||
|
|
||||||
- [Our Process](our-process.md)
|
- [Our Process](our-process.md)
|
||||||
- [Getting Started](getting-started.md)
|
- [Quick Start](quick-start.md)
|
||||||
- Essentials
|
- Development
|
||||||
- [Installation](essentials/installation.md)
|
- [Getting Started](development/getting-started.md)
|
||||||
- [Data Source](essentials/data-source.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)
|
- [Configuration](essentials/configuration.md)
|
||||||
- [Contributing](contributing/index.md)
|
|
||||||
- [Continuous Integration](continous-integration.md)
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@ -54,7 +55,8 @@
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
- [FAQ](frequently-asked-questions.md)
|
- [FAQ](faq/index.md)
|
||||||
- [Scope of Project](scope-of-project.md)
|
- [Scope of Project](faq/scope-of-project.md)
|
||||||
- [Browser Support](browser-support.md)
|
- [Browser Support](faq/browser-support.md)
|
||||||
|
- [PWA vs Packaged](faq/pwa-vs-packaged.md)
|
||||||
- [Help](help.md)
|
- [Help](help.md)
|
||||||
|
|||||||
@ -151,7 +151,7 @@ you would need to recreate.
|
|||||||
[viewers-project]: https://github.com/OHIF/Viewers
|
[viewers-project]: https://github.com/OHIF/Viewers
|
||||||
[viewer-npm]: https://www.npmjs.com/package/@ohif/viewer
|
[viewer-npm]: https://www.npmjs.com/package/@ohif/viewer
|
||||||
[pwa]: https://developers.google.com/web/progressive-web-apps/
|
[pwa]: https://developers.google.com/web/progressive-web-apps/
|
||||||
[configuration]: ../essentials/configuration.md
|
[configuration]: ../configuring/index.md
|
||||||
[extensions]: ../extensions/index.md
|
[extensions]: ../extensions/index.md
|
||||||
[core-github]: https://github.com/OHIF/viewers/platform/core
|
[core-github]: https://github.com/OHIF/viewers/platform/core
|
||||||
[ui-github]: https://github.com/OHIF/Viewers/platform/ui
|
[ui-github]: https://github.com/OHIF/Viewers/platform/ui
|
||||||
|
|||||||
@ -2,9 +2,12 @@
|
|||||||
|
|
||||||
> This step assumes you have an imaging archive. If you need assistance setting
|
> 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
|
> 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
|
## Overview
|
||||||
|
|
||||||
@ -18,8 +21,8 @@ and registered extension's features, are configured using this file.
|
|||||||
|
|
||||||
**Embedded Use Note:**
|
**Embedded Use Note:**
|
||||||
|
|
||||||
Alternatively, when using the `commonjs` bundle for embedded use cases, these
|
Alternatively, when using the `umd` bundle for embedded use cases, these same
|
||||||
same values are what you'll pass to `installViewer` method:
|
values are what you'll pass to `installViewer` method:
|
||||||
|
|
||||||
`OHIFStandaloneViewer.installViewer(window.config)`
|
`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_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` |
|
| `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?
|
## How do I configure my project?
|
||||||
|
|
||||||
The simplest way is to update the existing default config:
|
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
|
After updating the configuration, `yarn run build` to generate updated build
|
||||||
output.
|
output.
|
||||||
|
|
||||||
@ -1,9 +1,9 @@
|
|||||||
# Data Source
|
# Data Source
|
||||||
|
|
||||||
After following the steps outlined in
|
After following the steps outlined in
|
||||||
[Getting Started](./../getting-started.md), you'll notice that the OHIF Viewer
|
[Getting Started](./../development/getting-started.md), you'll notice that the
|
||||||
has data for several studies and their images. You didn't add this data, so
|
OHIF Viewer has data for several studies and their images. You didn't add this
|
||||||
where is it coming from?
|
data, so where is it coming from?
|
||||||
|
|
||||||
By default, the viewer is configured to connect to a remote server hosted by the
|
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,
|
nice folks over at [dcmjs.org][dcmjs-org]. While convenient for getting started,
|
||||||
@ -85,7 +85,7 @@ yarn run dev:orthanc
|
|||||||
#### Configuration: Learn More
|
#### Configuration: Learn More
|
||||||
|
|
||||||
> For more configuration fun, check out the
|
> 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`
|
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
|
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
|
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
|
## Open Source DICOM Image Archives
|
||||||
|
|
||||||
@ -10,9 +10,9 @@ your Viewer will display).
|
|||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
Our goal is to make deployment as simple and painless as possible; however,
|
Our goal is to make deployment as simple and painless as possible; however,
|
||||||
there is an inherent amount of complexity in customizing, optimizing, and
|
there is an inherent amount of complexity in configuring and deploying web
|
||||||
deploying web applications. If you find yourself a little lost, please don't
|
applications. If you find yourself a little lost, please don't hesitate to
|
||||||
hesitate to [reach out for help](/help.md)
|
[reach out for help](/help.md)
|
||||||
|
|
||||||
## Deployment Scenarios
|
## 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
|
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
|
domain name as your archive, then connecting the two is as simple as following
|
||||||
the steps layed out in our
|
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?
|
#### What if I don't have an imaging archive?
|
||||||
|
|
||||||
We provide some guidance on configuring a local image archive in our
|
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
|
archive remotely is a little trickier. You can check out some of our
|
||||||
[advanced recipes](#recipes) for modeled setups that may work for you.
|
[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
|
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
|
it's OpenID-Connect settings on the `oidc` configuration key. You can set these
|
||||||
values following the instructions laid out in the
|
values following the instructions laid out in the
|
||||||
[Configuration Essentials Guide](./../essentials/configuration.md).
|
[Configuration Essentials Guide](./../configuring/index.md).
|
||||||
|
|
||||||
_Example OpenID-Connect Settings:_
|
_Example OpenID-Connect Settings:_
|
||||||
|
|
||||||
|
|||||||
@ -1,7 +1,8 @@
|
|||||||
# Build for Production
|
# Build for Production
|
||||||
|
|
||||||
> If you've already followed the ["Getting Started" Guide](/getting-started.md),
|
> If you've already followed the
|
||||||
> you can skip ahead to [Configuration](#configuration)
|
> ["Getting Started" Guide](/development/getting-started.md), you can skip ahead
|
||||||
|
> to [Configuration](#configuration)
|
||||||
|
|
||||||
## Overview
|
## 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`
|
The easiest way to apply your own configuration is to modify the `default.js`
|
||||||
file. For more advanced cofiguration options, check out our
|
file. For more advanced cofiguration options, check out our
|
||||||
[configuration essentials guide](/essentials/configuration.md).
|
[configuration essentials guide](/configuring/index.md).
|
||||||
|
|
||||||
## Next Steps
|
## Next Steps
|
||||||
|
|
||||||
|
|||||||
@ -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
|
should be implemented, please don't hesitate to create a new issue. At a
|
||||||
minimum, you may want to read the following documentation:
|
minimum, you may want to read the following documentation:
|
||||||
|
|
||||||
- [Getting Started](/getting-started.md)
|
- [Getting Started](/development/getting-started.md)
|
||||||
- [Architecture](/architecture/index.md)
|
- [Architecture](/architecture/index.md)
|
||||||
|
|
||||||
Pull requests that are:
|
Pull requests that are:
|
||||||
@ -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
|
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
|
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
|
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
|
welcome to build it yourself and [contribute it](development/contributing.md).
|
||||||
have resources and would like to fund the development of a feature, please
|
If you have resources and would like to fund the development of a feature,
|
||||||
[contact us](http://www.ohif.org) or work with community members that offer
|
please [contact us](http://www.ohif.org) or work with community members that
|
||||||
[consulting services][commercial-support].
|
offer [consulting services][commercial-support].
|
||||||
|
|
||||||
### Who should I contact about Academic Collaborations?
|
### Who should I contact about Academic Collaborations?
|
||||||
|
|
||||||
@ -1,4 +1,4 @@
|
|||||||
# Installation
|
# PWA vs Packaged
|
||||||
|
|
||||||
It's important to know that the OHIF Viewer project provides two different build
|
It's important to know that the OHIF Viewer project provides two different build
|
||||||
processes:
|
processes:
|
||||||
@ -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
|
repositories, visual screenshot-based tests are also included, and video
|
||||||
recordings of end-to-end tests are stored for later review.
|
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
|
## Releases
|
||||||
|
|
||||||
|
|||||||
@ -1,4 +1,4 @@
|
|||||||
# @ohif/i18n
|
# @ohif/i18n
|
||||||
|
|
||||||
More information available at
|
More information available at
|
||||||
[OHIF Docs](https://docs.ohif.org/essentials/translating.html).
|
[OHIF Docs](https://docs.ohif.org/viewer/internationalization.html).
|
||||||
|
|||||||
@ -34,7 +34,7 @@ export default withTranslation('MyNameSpace')(MyComponent);
|
|||||||
## Namespaces
|
## Namespaces
|
||||||
|
|
||||||
For further information about namespaces and how they work, please visit
|
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?
|
### How to get right the Namespace of a `@ohif/ui` component?
|
||||||
|
|
||||||
@ -71,12 +71,12 @@ export default withTranslation('OuterSpace')(TheComponent);
|
|||||||
|
|
||||||
## Extending and Overriding languages
|
## 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
|
## Changing the language
|
||||||
|
|
||||||
The language choosing method is the same implemented in
|
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
|
> You can also change the language of the components displayed in this
|
||||||
> documentation by choosing an option in the
|
> documentation by choosing an option in the
|
||||||
@ -84,4 +84,4 @@ The language choosing method is the same implemented in
|
|||||||
|
|
||||||
## Debugging translations
|
## 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)
|
||||||
|
|||||||
@ -194,7 +194,7 @@ Links:
|
|||||||
[react-url]: https://reactjs.org/
|
[react-url]: https://reactjs.org/
|
||||||
[pwa-url]: https://developers.google.com/web/progressive-web-apps/
|
[pwa-url]: https://developers.google.com/web/progressive-web-apps/
|
||||||
[ohif-viewer-url]: https://www.npmjs.com/package/ohif-viewer
|
[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
|
[extensions-url]: https://docs.ohif.org/extensions
|
||||||
<!-- Misc. -->
|
<!-- Misc. -->
|
||||||
[react-viewer]: https://github.com/OHIF/Viewers/tree/react
|
[react-viewer]: https://github.com/OHIF/Viewers/tree/react
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user