forked from OHIF/Viewers
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(docs): Added various training videos to support the OHIF CLI too…
…ls (OHIF#3794)
- Loading branch information
1 parent
cf82be2
commit 4aa8156
Showing
7 changed files
with
77 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
sidebar_position: 7 | ||
sidebar_position: 8 | ||
sidebar_label: Continuous Integration | ||
--- | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
sidebar_position: 4 | ||
sidebar_position: 5 | ||
sidebar_label: Contributing | ||
--- | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
sidebar_position: 8 | ||
sidebar_position: 9 | ||
sidebar_label: Local Linking | ||
--- | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
sidebar_position: 5 | ||
sidebar_position: 6 | ||
sidebar_label: Issue & PR Triage Process | ||
--- | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
sidebar_position: 6 | ||
sidebar_position: 7 | ||
sidebar_label: Testing | ||
--- | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
--- | ||
sidebar_position: 4 | ||
sidebar_label: Video Tutorials | ||
--- | ||
|
||
# Video Tutorials | ||
|
||
## Creating, Linking and Publishing OHIF Modes and Extensions | ||
|
||
The [OHIF CLI](./ohif-cli.md) facilitates the creation, linkage and publication | ||
of OHIF modes and extensions. The videos below walk through how to use the CLI for | ||
- creating modes and extensions | ||
- linking local modes and extensions | ||
- publishing modes and extensions to NPM | ||
- adding published modes and extensions to OHIF | ||
- submitting a mode to OHIF | ||
|
||
The videos build on top of one another whereby the mode and extension created | ||
in each of the first two videos are published to NPM and then the published | ||
entities are added to OHIF. | ||
|
||
### Creating and Linking a Mode | ||
|
||
The first video demonstrates the creation and linkage of a mode. | ||
<div style={{padding:"56.25% 0 0 0", position:"relative"}}> | ||
<iframe src="https://player.vimeo.com/video/884891676?badge=0&autopause=0&player_id=0&app_id=58479" frameBorder="0" allow="autoplay; fullscreen; picture-in-picture" allowFullScreen style= {{ position:"absolute",top:0,left:0,width:"100%",height:"100%"}} title="Create and link a mode"></iframe> | ||
</div> | ||
|
||
### Creating and Linking an Extension | ||
|
||
The second video creates and links an extension. The mode from the first | ||
video is modified to reference the extension. | ||
<div style={{padding:"56.25% 0 0 0", position:"relative"}}> | ||
<iframe src="https://player.vimeo.com/video/884891718?badge=0&autopause=0&player_id=0&app_id=58479" frameBorder="0" allow="autoplay; fullscreen; picture-in-picture" allowFullScreen style= {{ position:"absolute",top:0,left:0,width:"100%",height:"100%"}} title="Create and link an extension"></iframe> | ||
</div> | ||
|
||
### Publishing an Extension to NPM | ||
|
||
The third video shows how the extension created in the second video can | ||
be published to NPM. | ||
<div style={{padding:"56.25% 0 0 0", position:"relative"}}> | ||
<iframe src="https://player.vimeo.com/video/884891701?badge=0&autopause=0&player_id=0&app_id=58479" frameBorder="0" allow="autoplay; fullscreen; picture-in-picture" allowFullScreen style= {{ position:"absolute",top:0,left:0,width:"100%",height:"100%"}} title="Publish an extension to NPM"></iframe> | ||
</div> | ||
|
||
### Publishing a Mode to NPM | ||
|
||
The fourth video shows how the mode created in the first video can be | ||
published to NPM. | ||
<div style={{padding:"56.25% 0 0 0", position:"relative"}}> | ||
<iframe src="https://player.vimeo.com/video/884893445?badge=0&autopause=0&player_id=0&app_id=58479" frameBorder="0" allow="autoplay; fullscreen; picture-in-picture" allowFullScreen style= {{ position:"absolute",top:0,left:0,width:"100%",height:"100%"}} title="Publish a mode to NPM"></iframe> | ||
</div> | ||
|
||
### Adding a Mode from NPM | ||
|
||
The fifth video adds the mode and extension published in NPM to OHIF. Note | ||
that since the mode references the extension both are added with one CLI | ||
command. | ||
<div style={{padding:"56.25% 0 0 0", position:"relative"}}> | ||
<iframe src="https://player.vimeo.com/video/884893388?badge=0&autopause=0&player_id=0&app_id=58479" frameBorder="0" allow="autoplay; fullscreen; picture-in-picture" allowFullScreen style= {{ position:"absolute",top:0,left:0,width:"100%",height:"100%"}} title="Add a mode from NPM"></iframe> | ||
</div> | ||
|
||
### Submitting a Mode to OHIF | ||
|
||
The sixth video demonstrates how a mode can be submitted to OHIF to have it | ||
appear in OHIF's mode gallery. | ||
<div style={{padding:"56.25% 0 0 0", position:"relative"}}> | ||
<iframe src="https://player.vimeo.com/video/884893372?badge=0&autopause=0&player_id=0&app_id=58479" frameBorder="0" allow="autoplay; fullscreen; picture-in-picture" allowFullScreen style= {{ position:"absolute",top:0,left:0,width:"100%",height:"100%"}} title="Submit a mode to OHIF"></iframe> | ||
</div> |