diff --git a/platform/docs/docs/development/continuous-integration.md b/platform/docs/docs/development/continuous-integration.md index 72acbbcbdb1..48ad4c4d097 100644 --- a/platform/docs/docs/development/continuous-integration.md +++ b/platform/docs/docs/development/continuous-integration.md @@ -1,5 +1,5 @@ --- -sidebar_position: 7 +sidebar_position: 8 sidebar_label: Continuous Integration --- diff --git a/platform/docs/docs/development/contributing.md b/platform/docs/docs/development/contributing.md index 763be20dd08..62c59341d88 100644 --- a/platform/docs/docs/development/contributing.md +++ b/platform/docs/docs/development/contributing.md @@ -1,5 +1,5 @@ --- -sidebar_position: 4 +sidebar_position: 5 sidebar_label: Contributing --- diff --git a/platform/docs/docs/development/link.md b/platform/docs/docs/development/link.md index 733ae5d0f2b..c06fa24e92b 100644 --- a/platform/docs/docs/development/link.md +++ b/platform/docs/docs/development/link.md @@ -1,5 +1,5 @@ --- -sidebar_position: 8 +sidebar_position: 9 sidebar_label: Local Linking --- diff --git a/platform/docs/docs/development/ohif-cli.md b/platform/docs/docs/development/ohif-cli.md index 0cd7ebc6aad..038f331a962 100644 --- a/platform/docs/docs/development/ohif-cli.md +++ b/platform/docs/docs/development/ohif-cli.md @@ -306,3 +306,7 @@ The ohif-cli will add the path to the external dependencies to the webpack confi so that you can install them in your project and use them in your custom extensions and modes. To achieve this ohif-cli will update the webpack.pwa.js file in the platform/app directory. + +## Video tutorials +See the [Video Tutorials](./video-tutorials.md) for videos of some the above +commands in action. diff --git a/platform/docs/docs/development/our-process.md b/platform/docs/docs/development/our-process.md index aaac77533d2..a420c9d4905 100644 --- a/platform/docs/docs/development/our-process.md +++ b/platform/docs/docs/development/our-process.md @@ -1,5 +1,5 @@ --- -sidebar_position: 5 +sidebar_position: 6 sidebar_label: Issue & PR Triage Process --- diff --git a/platform/docs/docs/development/testing.md b/platform/docs/docs/development/testing.md index c7c846aaa3d..23f2397553f 100644 --- a/platform/docs/docs/development/testing.md +++ b/platform/docs/docs/development/testing.md @@ -1,5 +1,5 @@ --- -sidebar_position: 6 +sidebar_position: 7 sidebar_label: Testing --- diff --git a/platform/docs/docs/development/video-tutorials.md b/platform/docs/docs/development/video-tutorials.md new file mode 100644 index 00000000000..482967e26fd --- /dev/null +++ b/platform/docs/docs/development/video-tutorials.md @@ -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. +
+ +
+ +### 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. +
+ +
+ +### Publishing an Extension to NPM + +The third video shows how the extension created in the second video can +be published to NPM. +
+ +
+ +### Publishing a Mode to NPM + +The fourth video shows how the mode created in the first video can be +published to NPM. +
+ +
+ +### 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. +
+ +
+ +### 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. +
+ +