From fe9e7123d769dd6429601aebf3cc89075520cf9a Mon Sep 17 00:00:00 2001 From: Lumenol Date: Thu, 3 Mar 2022 17:28:07 +0100 Subject: [PATCH] fix: fixing errors in documentation (#2728) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Louis-Maxime Crédeville --- platform/docs/docs/README.md | 2 +- .../docs/configuration/dataSources/dicom-json.md | 2 +- platform/docs/docs/configuration/index.md | 2 +- .../docs/docs/configuration/theme-configuration.md | 6 +++--- .../docs/docs/deployment/build-for-production.md | 2 +- platform/docs/docs/deployment/index.md | 6 +++--- .../docs/docs/deployment/nginx--image-archive.md | 8 ++++---- platform/docs/docs/deployment/static-assets.md | 6 +++--- platform/docs/docs/development/architecture.md | 8 ++++---- platform/docs/docs/development/getting-started.md | 2 +- platform/docs/docs/development/our-process.md | 4 ++-- platform/docs/docs/development/testing.md | 4 ++-- platform/docs/docs/faq.md | 4 ++-- platform/docs/docs/platform/browser-support.md | 2 +- platform/docs/docs/platform/extensions/index.md | 6 +++--- .../docs/docs/platform/extensions/installation.md | 4 ++-- .../docs/platform/extensions/modules/commands.md | 2 +- .../docs/platform/extensions/modules/data-source.md | 6 +++--- .../docs/docs/platform/extensions/modules/panel.md | 2 +- .../platform/extensions/modules/sop-class-handler.md | 2 +- .../docs/docs/platform/extensions/modules/toolbar.md | 2 +- .../docs/platform/extensions/modules/viewport.md | 2 +- platform/docs/docs/platform/internationalization.md | 2 +- platform/docs/docs/platform/managers/hotkeys.md | 4 ++-- platform/docs/docs/platform/modes/index.md | 2 +- platform/docs/docs/platform/modes/lifecycle.md | 2 +- platform/docs/docs/platform/modes/routes.md | 4 ++-- platform/docs/docs/platform/scope-of-project.md | 12 ++++++------ .../docs/platform/services/config-point-service.md | 6 +++--- .../platform/services/data/DicomMetadataStore.md | 2 +- .../platform/services/data/HangingProtocolService.md | 6 +++--- platform/docs/docs/platform/services/data/index.md | 4 ++-- platform/docs/docs/platform/services/pubsub.md | 4 ++-- platform/docs/docs/platform/services/ui/index.md | 2 +- platform/docs/docs/release-notes.md | 2 +- platform/docs/docs/resources.md | 4 ++-- .../docs/docs/user-guide/viewer/measurement-panel.md | 2 +- .../docs/user-guide/viewer/measurement-tracking.md | 6 +++--- platform/docs/docs/user-guide/viewer/toolbar.md | 4 ++-- platform/docs/docs/user-guide/viewer/viewport.md | 2 +- 40 files changed, 77 insertions(+), 77 deletions(-) diff --git a/platform/docs/docs/README.md b/platform/docs/docs/README.md index c7b5c7f8c..cd6cfe17b 100644 --- a/platform/docs/docs/README.md +++ b/platform/docs/docs/README.md @@ -76,7 +76,7 @@ https://pubmed.ncbi.nlm.nih.gov/29092955/ **Note:** If you use or find this repository helpful, please take the time to -star this repository on Github. This is an easy way for us to assess adoption +star this repository on Github. This is an easy way for us to assess adoption, and it can help us obtain future funding for the project. ## License diff --git a/platform/docs/docs/configuration/dataSources/dicom-json.md b/platform/docs/docs/configuration/dataSources/dicom-json.md index beb404e85..c6efab62e 100644 --- a/platform/docs/docs/configuration/dataSources/dicom-json.md +++ b/platform/docs/docs/configuration/dataSources/dicom-json.md @@ -129,7 +129,7 @@ downloading the dicom file by opening the url in your browser). ### Local Demo -You can run OHIF with a JSON data source againts you local datasets (given that +You can run OHIF with a JSON data source against you local datasets (given that their JSON metadata is extracted). First you need to put the JSON file and the folder containing the dicom files diff --git a/platform/docs/docs/configuration/index.md b/platform/docs/docs/configuration/index.md index 16e359140..4a3ba6ca0 100644 --- a/platform/docs/docs/configuration/index.md +++ b/platform/docs/docs/configuration/index.md @@ -137,7 +137,7 @@ value of this environment variable a few different ways: - ~[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: +- Using the `cross-env` package in a 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 diff --git a/platform/docs/docs/configuration/theme-configuration.md b/platform/docs/docs/configuration/theme-configuration.md index 384fbe4f7..2c2316bf4 100644 --- a/platform/docs/docs/configuration/theme-configuration.md +++ b/platform/docs/docs/configuration/theme-configuration.md @@ -1,7 +1,7 @@ # Theme Configuration When adding new theme extendible configuration items, please document them here. See [Theme Configuration with Config Point](#configPoint) on how to modify certain types of -configuration values using the config-point defintions. +configuration values using the config-point definitions. ## Hanging Protocols It is possible to customize the available hanging protocols by defining them @@ -258,7 +258,7 @@ list: { } ``` -and and example for reference could be: +and example for reference could be: ```js // Base definition: MGHangingProtocol: // ... full definition of MG HP here @@ -283,5 +283,5 @@ StudyInstancesColumn: { ``` Note how in the last example, the transform itself contains a reference. This is a function that generates a javascript function taking props, where the -props are available directly. Thus, this props would need `study` containing +props are available directly. Thus, these props would need `study` containing the appropriate child objects. diff --git a/platform/docs/docs/deployment/build-for-production.md b/platform/docs/docs/deployment/build-for-production.md index 2df1daa82..b23463237 100644 --- a/platform/docs/docs/deployment/build-for-production.md +++ b/platform/docs/docs/deployment/build-for-production.md @@ -69,7 +69,7 @@ directory. Our build process knows which configuration file to use based on the 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 +file. For more advanced configuration options, check out our [configuration essentials guide](../configuration/index.md). ## Next Steps diff --git a/platform/docs/docs/deployment/index.md b/platform/docs/docs/deployment/index.md index 0b2f8bd69..384aefc77 100644 --- a/platform/docs/docs/deployment/index.md +++ b/platform/docs/docs/deployment/index.md @@ -112,7 +112,7 @@ There are two important steps to making sure this setup works: 1. Your Image Archive needs to be exposed, in some way, to the open web. This can be directly, or through a `reverse proxy`, but the Viewer needs _some - way_ to request it's data. + way_ to request its data. 2. \* Your Image Archive needs to have appropriate CORS (Cross-Origin Resource Sharing) Headers @@ -224,7 +224,7 @@ More info on this JSON format can be found here _CORS Issues (Cross-Origin Resource Sharing)_ -If you host a JSON API or Images on a different domain from the the app itself, +If you host a JSON API or Images on a different domain from the app itself, you will likely have CORS issues. This will also happen when testing from Localhost and reaching out to remote servers. Even if the domain is the same, different ports, subdomains or protocols (https vs http) will also cause CORS @@ -233,7 +233,7 @@ to allow your App server origin. For example: -Lets assume your application is hosted on `https://my-ohif-server.com`. +Let's assume your application is hosted on `https://my-ohif-server.com`. Your JSON API is hosted on `https://my-json-api.aws.com` diff --git a/platform/docs/docs/deployment/nginx--image-archive.md b/platform/docs/docs/deployment/nginx--image-archive.md index b6e2d536d..79f729d2f 100644 --- a/platform/docs/docs/deployment/nginx--image-archive.md +++ b/platform/docs/docs/deployment/nginx--image-archive.md @@ -9,7 +9,7 @@ sidebar_position: 4 At a certain point, you may want others to have access to your instance of the OHIF Viewer and its medical imaging data. This post covers one of many potential -setups that accomplish that. Please note, noticably absent is user account +setups that accomplish that. Please note, noticeably absent is user account control. Do not use this recipe to host sensitive medical data on the open web. Depending @@ -22,12 +22,12 @@ that builds on the lessons learned here. Our two biggest hurdles when hosting our image archive and web client are: -- Risks related to exposing our PACS to the netowrk +- Risks related to exposing our PACS to the network - Cross-Origin Resource Sharing (CORS) requests ### Handling Web Requests -We mittigate our first issue by allowing [Nginx][nginx] to handle incoming web +We mitigate our first issue by allowing [Nginx][nginx] to handle incoming web requests. Nginx is open source software for web serving, reverse proxying, caching, and more. It's designed for maximum performance and stability -- allowing us to more reliably serve content than Orthanc's built-in server can. @@ -199,7 +199,7 @@ Here are some resources, specific to this setup, that may be helpful: - [lua-resty-auto-ssl](https://github.com/GUI/lua-resty-auto-ssl) - [Let's Encrypt + Nginx](https://www.nginx.com/blog/using-free-ssltls-certificates-from-lets-encrypt-with-nginx/) -While we terminate SSL at Nginx, it may be worth using self signed certificates +While we terminate SSL at Nginx, it may be worth using self-signed certificates for communication between services. - [SSL Termination for TCP Upstream Servers](https://docs.nginx.com/nginx/admin-guide/security-controls/terminating-ssl-tcp/) diff --git a/platform/docs/docs/deployment/static-assets.md b/platform/docs/docs/deployment/static-assets.md index e97587efa..767ad6928 100644 --- a/platform/docs/docs/deployment/static-assets.md +++ b/platform/docs/docs/deployment/static-assets.md @@ -16,7 +16,7 @@ less product offerings. While not required, it can simplify things to host your Web Viewer alongside your image archive. Services with more robust product offerings, like `Google Cloud`, `Microsoft's Azure`, and `Amazon Web Services (AWS)`, are able -to accomodate this setup. +to accommodate this setup. _Drag-n-drop_ @@ -111,7 +111,7 @@ Learn more about [surge.sh on their website](https://surge.sh/) > Websites for you and your projects. Hosted directly from your GitHub > repository. Just edit, push, and your changes are live. -This deploy strategy makes more sense if you intend to maintain your project in +This deployment strategy makes more sense if you intend to maintain your project in a GitHub repository. It allows you to specify a `branch` or `folder` as the target for a GitHub Page's website. As you push code changes, the hosted content updates to reflect those changes. @@ -140,7 +140,7 @@ avoid using a proxy or to simplify authentication. If that is the case, check out some of our more advanced `docker` deployments that target these providers from the left-hand sidepanel. -These guides can be a bit longer and a update more frequently. To provide +These guides can be a bit longer and an update more frequently. To provide accurate documentation, we will link to each provider's own recommended steps: ### AWS S3 + Cloudfront diff --git a/platform/docs/docs/development/architecture.md b/platform/docs/docs/development/architecture.md index e39fa2798..4bcebb017 100644 --- a/platform/docs/docs/development/architecture.md +++ b/platform/docs/docs/development/architecture.md @@ -11,7 +11,7 @@ possible use cases and decided to significantly change and improve the architecture. Below, we aim to demystify that complexity by providing insight into how -`OHIF Platform` is architected, and the role each of it's dependent libraries +`OHIF Platform` is architected, and the role each of its dependent libraries plays. ## Overview @@ -46,7 +46,7 @@ you'll see the following: └── README.md ``` -OHIF v3 is comprised of the following components, described in detail in further +OHIF v3 is composed of the following components, described in detail in further sections: - `@ohif/viewer`: The core framework that controls extension registration, mode @@ -62,7 +62,7 @@ sections: ## Extensions -The `extensions` directory contains many packages that provides essential +The `extensions` directory contains many packages that provide essential functionalities such as rendering, study/series browsers, measurement tracking that modes can consume to enable a certain workflow. Extensions have had their behavior changed in `OHIF-v3` and their api is expanded. In summary: @@ -183,7 +183,7 @@ you would need to recreate. This is a great question. Modes are designed to consume extensions, so you should implement your functionality in one of the modules of your new extension, -and let the mode to consume it. This way, in future, if you needed another mode +and let the mode consume it. This way, in the future, if you needed another mode that utilizes the same functionality, you can easily hook the extension to the new mode as well. diff --git a/platform/docs/docs/development/getting-started.md b/platform/docs/docs/development/getting-started.md index 4c2f9f5df..b9b3bc5d5 100644 --- a/platform/docs/docs/development/getting-started.md +++ b/platform/docs/docs/development/getting-started.md @@ -15,7 +15,7 @@ we make to the OHIF Viewer, then follow these steps: - [Fork][fork-a-repo] the [OHIF/Viewers][ohif-viewers-repo] repository - [Create a local clone][clone-a-repo] of your fork - `git clone https://github.com/YOUR-USERNAME/Viewers` -- Add OHIF/Viewers as a [remote repository][add-remote-repo] labled `upstream` +- Add OHIF/Viewers as a [remote repository][add-remote-repo] labeled `upstream` - Navigate to the cloned project's directory - `git remote add upstream https://github.com/OHIF/Viewers.git` diff --git a/platform/docs/docs/development/our-process.md b/platform/docs/docs/development/our-process.md index 8a3f51b7b..1be7be7f9 100644 --- a/platform/docs/docs/development/our-process.md +++ b/platform/docs/docs/development/our-process.md @@ -33,7 +33,7 @@ first contact with would-be adopters and contributors, it's important that we strive for timely responses and satisfactory resolutions. We attempt to accomplish this by: -1. Responding to issues requiring `triage` at least once a week +1. Responding to issue requiring `triage` at least once a week 2. Create new "official issues" from "community issues" 3. Provide clear guidance and next steps (when applicable) 4. Regularly clean up old (stale) issues @@ -97,7 +97,7 @@ appropriate: We rely on GitHub Checks and integrations with third party services to evaluate changes in code quality and test coverage. Tests must pass and User cases must be present (when applicable) before a PR can be merged to master, and code -quality and test coverage must not changed by a significant margin. For some +quality and test coverage must not be 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. diff --git a/platform/docs/docs/development/testing.md b/platform/docs/docs/development/testing.md index cbf50ecfd..71c62037f 100644 --- a/platform/docs/docs/development/testing.md +++ b/platform/docs/docs/development/testing.md @@ -50,7 +50,7 @@ For running the OHIF e2e test you need to run the following steps: Run the tests by clicking on the `Run #number integration tests` . - A new window will open and you will see e2e tests being executed one after + A new window will open, and you will see e2e tests being executed one after each other. ![e2e-cypress-final](../assets/img/e2e-cypress-final.png) @@ -118,7 +118,7 @@ choice for asserting an element's border color. Modern tooling gives us this "for free". It can catch invalid regular expressions, unused variables, and guarantee we're calling methods/functions -with the expected paramater types. +with the expected parameter types. Example Tooling: diff --git a/platform/docs/docs/faq.md b/platform/docs/docs/faq.md index 5c2543407..67b7d30b2 100644 --- a/platform/docs/docs/faq.md +++ b/platform/docs/docs/faq.md @@ -45,7 +45,7 @@ some community members do offer consulting services. You can search our ### Does The OHIF Viewer have [510(k) Clearance][501k-clearance] from the U.S. F.D.A or [CE Marking][ce-marking] from the European Commission? -**NO.** The OHIF Viewer is **NOT** F.D.A. cleared or CE Marked. It is the users +**NO.** The OHIF Viewer is **NOT** F.D.A. cleared or CE Marked. It is the users' responsibility to ensure compliance with applicable rules and regulations. The [License](https://github.com/OHIF/Viewers/blob/master/LICENSE) for the OHIF Platform does not prevent your company or group from seeking F.D.A. clearance @@ -57,7 +57,7 @@ would be interested to hear about your experience. ### Is The OHIF Viewer [HIPAA][hipaa-def] Compliant? **NO.** The OHIF Viewer **DOES NOT** fulfill all of the criteria to become HIPAA -Compliant. It is the users responsibility to ensure compliance with applicable +Compliant. It is the users' responsibility to ensure compliance with applicable rules and regulations. ## Providers for UI services diff --git a/platform/docs/docs/release-notes.md b/platform/docs/docs/release-notes.md index cae9d8411..242221bd7 100644 --- a/platform/docs/docs/release-notes.md +++ b/platform/docs/docs/release-notes.md @@ -11,7 +11,7 @@ sidebar_label: Release Notes ## What's new in `OHIF-v3` `OHIF-v3` is our second try for a React-based viewer, and is the third version -of our medical image web viewers from the start. The summary of changes include: +of our medical image web viewers from the start. The summary of changes includes: - Addition of workflow modes - Often, medical imaging use cases involves lots of specific workflows that diff --git a/platform/docs/docs/resources.md b/platform/docs/docs/resources.md index 198f3de2f..be7b10ed7 100644 --- a/platform/docs/docs/resources.md +++ b/platform/docs/docs/resources.md @@ -13,7 +13,7 @@ and other resources that we have provided to the community in the past: ### [NA-MIC Project Week 36th 2022 - Remote](https://github.com/NA-MIC/ProjectWeek/blob/master/PW36_2022_Virtual/README.md) -The Project Week is a week-long hackathon of hands on activity in which medical +The Project Week is a week-long hackathon of hands-on activity in which medical image computing researchers. OHIF team participated and gave a talk on OHIF and Cornerstone in the 36th Project Week: [[Slides]](https://docs.google.com/presentation/d/1-GtOKmr2cQi-r3OFyseSmgLeurtB3KXUkGMx2pVLh1I/edit?usp=sharing) @@ -23,7 +23,7 @@ Cornerstone in the 36th Project Week: ### [NA-MIC Project Week 35th 2021 - Remote](https://github.com/NA-MIC/ProjectWeek/tree/master/PW35_2021_Virtual) -The Project Week is a week-long hackathon of hands on activity in which medical +The Project Week is a week-long hackathon of hands-on activity in which medical image computing researchers. OHIF team participated in the 35th Project Week in 2021. [[Slides]](https://docs.google.com/presentation/d/1KYNjuiI8lT1foQ4P9TGNV0lBhM6H-5KBs0wkYj4JJbk/edit?usp=sharing) diff --git a/platform/docs/docs/user-guide/viewer/measurement-panel.md b/platform/docs/docs/user-guide/viewer/measurement-panel.md index 821ce276b..b760bf37e 100644 --- a/platform/docs/docs/user-guide/viewer/measurement-panel.md +++ b/platform/docs/docs/user-guide/viewer/measurement-panel.md @@ -7,7 +7,7 @@ sidebar_position: 3 ## Introduction In `Basic Viewer` mode, the right panel is the `Measurement Panel`. The Measurement Panel can be expanded or hidden by clicking on the arrow to the left of `Measurements`. -Select a measurement tool and mark an image to initiate measurement tracking. A pop up will ask if you want to track measurements for the series on which the annotation was drawn. +Select a measurement tool and mark an image to initiate measurement tracking. A pop-up will ask if you want to track measurements for the series on which the annotation was drawn. ![user-measurement-panel-modal](../../assets/img/measurement-panel-prompt.png) diff --git a/platform/docs/docs/user-guide/viewer/measurement-tracking.md b/platform/docs/docs/user-guide/viewer/measurement-tracking.md index d1df1dd8f..a15f7e5df 100644 --- a/platform/docs/docs/user-guide/viewer/measurement-tracking.md +++ b/platform/docs/docs/user-guide/viewer/measurement-tracking.md @@ -31,7 +31,7 @@ In the following, we will discuss each category. ![user-measurement-panel-modal](../../assets/img/tracking-workflow1.png) In summary, when you create an annotation, a prompt will be shown whether to start tracking or not. If you start the tracking, the annotation style will change to a solid line, and annotation details get displayed on the measurement panel. -On the other hand, if you decline the tracking pormpt, the measurement will be considered "temporary," and annotation style remains as a dashed line and not shown on the right panel, and cannot be exported. +On the other hand, if you decline the tracking prompt, the measurement will be considered "temporary," and annotation style remains as a dashed line and not shown on the right panel, and cannot be exported. Below, you can see different icons that appear for a tracked vs. untracked series in @@ -80,7 +80,7 @@ The full workflow for saving measurements to SR and loading SR into the viewer i ![user-measurement-panel-modal](../../assets/img/tracking-workflow3.png) -#### Overview video for loading DICOM SR and making a tracked sereis: +#### Overview video for loading DICOM SR and making a tracked series:
@@ -115,7 +115,7 @@ you cannot edit the DICOM SR measurement.

-#### Overview video for loading DICOM SR inside an already tracked sereis: +#### Overview video for loading DICOM SR inside an already tracked series: diff --git a/platform/docs/docs/user-guide/viewer/toolbar.md b/platform/docs/docs/user-guide/viewer/toolbar.md index 928a3a96d..9f226e0d6 100644 --- a/platform/docs/docs/user-guide/viewer/toolbar.md +++ b/platform/docs/docs/user-guide/viewer/toolbar.md @@ -21,9 +21,9 @@ This section displays all the available tools inside the mode. The basic viewer comes with the following default measurement tools: - Length Tool: Calculates the linear distance between two points in *mm* -- Bidirectional Tool: Creates a measurement of longest diameter (LD) and longest perpendicular diameter (LPD) in *mm* +- Bidirectional Tool: Creates a measurement of the longest diameter (LD) and longest perpendicular diameter (LPD) in *mm* - Annotation: Used to create a qualitative marker with a freetext label -- Ellipse: Measures an ellipical area in *mm2* and Hounsfield Units (HU) +- Ellipse: Measures an elliptical area in *mm2* and Hounsfield Units (HU) When a measurement tool is selected from the toolbar, it becomes the `active` tool. Use the caret to expand the measurement tools and select another tool. diff --git a/platform/docs/docs/user-guide/viewer/viewport.md b/platform/docs/docs/user-guide/viewer/viewport.md index 47175e61c..173728ca1 100644 --- a/platform/docs/docs/user-guide/viewer/viewport.md +++ b/platform/docs/docs/user-guide/viewer/viewport.md @@ -10,7 +10,7 @@ renders series. ![user-viewer-main](../../assets/img/user-viewer-main.png) -By default you can modify: +By default, you can modify: - Zoom: right click dragging up or down - Contrast/brightness: left click dragging up/down to change contrast, and left/right for changing brightness