docs: shift "getting started" outside of essentials

This commit is contained in:
dannyrb 2019-12-06 22:48:57 -05:00
parent 6ea16eccd9
commit 6873c4f065
7 changed files with 13 additions and 18 deletions

View File

@ -38,7 +38,7 @@ 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](./essentials/getting-started.md). [Getting Started Guide](./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.](./contributing/index.md)
- Feeling lost? Read our [help page](./help.md). - Feeling lost? Read our [help page](./help.md).

View File

@ -1,8 +1,8 @@
# OHIF Viewers # OHIF Viewers
- [Our Process](our-process.md) - [Our Process](our-process.md)
- [Getting Started](getting-started.md)
- Essentials - Essentials
- [Getting Started](essentials/getting-started.md)
- [Installation](essentials/installation.md) - [Installation](essentials/installation.md)
- [Data Source](essentials/data-source.md) - [Data Source](essentials/data-source.md)
- [Configuration](essentials/configuration.md) - [Configuration](essentials/configuration.md)

View File

@ -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:
- [Essentials: Getting Started](/essentials/getting-started.md) - [Getting Started](/getting-started.md)
- [Architecture](/architecture/index.md) - [Architecture](/architecture/index.md)
Pull requests that are: Pull requests that are:

View File

@ -1,8 +1,7 @@
# Build for Production # Build for Production
> If you've already followed the > If you've already followed the ["Getting Started" Guide](/getting-started.md),
> ["Getting Started" Guide](/essentials/getting-started.md), you can skip ahead > you can skip ahead to [Configuration](#configuration)
> to [Configuration](#configuration)
## Overview ## Overview

View File

@ -1,8 +1,9 @@
# Data Source # Data Source
After following the steps outlined in [Getting Started](./getting-started.md), After following the steps outlined in
you'll notice that the OHIF Viewer has data for several studies and their [Getting Started](./../getting-started.md), you'll notice that the OHIF Viewer
images. You didn't add this data, so where is it coming from? 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 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,

View File

@ -75,7 +75,7 @@ You should see the following output:
### Building for Production ### Building for Production
> More comprehensive guides for building and publishing can be found in our > More comprehensive guides for building and publishing can be found in our
> [deployment docs](./../deployment/index.md) > [deployment docs](./deployment/index.md)
```bash ```bash
# Build static assets to host a PWA # Build static assets to host a PWA
@ -85,12 +85,6 @@ yarn run build
yarn run build:package yarn run build:package
``` ```
## Next Steps
Take a look at the sidebar. Depending on how you intend to use The OHIF Viewer,
different topics may be more pertinent than others. At a minimum, reading "The
Essentials" and the deployment recipes should be a good starting point.
## Troubleshooting ## Troubleshooting
- If you receive a _"No Studies Found"_ message and do not see your studies, try - If you receive a _"No Studies Found"_ message and do not see your studies, try
@ -98,7 +92,8 @@ Essentials" and the deployment recipes should be a good starting point.
- If you see a 'Loading' message which never resolves, check your browser - If you see a 'Loading' message which never resolves, check your browser
JavaScript console inside the Developer Tools to identify any errors. JavaScript console inside the Developer Tools to identify any errors.
- If you see any errors in your server console, check the - If you see any errors in your server console, check the
[Troubleshooting](./troubleshooting.md) page for more in depth advice. [Troubleshooting](./essentials/troubleshooting.md) page for more in depth
advice.
<!-- <!--
Links Links

View File

@ -89,7 +89,7 @@ yarn start
For more advanced local development scenarios, like using your own locally For more advanced local development scenarios, like using your own locally
hosted PACS and test data, hosted PACS and test data,
[check out our Essential: Getting Started](https://docs.ohif.org/essentials/getting-started.html) [check out our Essential: Getting Started](https://docs.ohif.org/getting-started.html)
guide. guide.
### E2E Tests ### E2E Tests