From d83beb7c62c1d5be19c54e08d23883f112147fe1 Mon Sep 17 00:00:00 2001 From: Joe Boccanfuso <109477394+jbocce@users.noreply.github.com> Date: Fri, 17 Nov 2023 20:08:38 -0500 Subject: [PATCH] feat(docs): Added various training videos to support the OHIF CLI tools (#3794) --- .../development/continuous-integration.md | 2 +- .../docs/docs/development/contributing.md | 2 +- platform/docs/docs/development/link.md | 2 +- platform/docs/docs/development/ohif-cli.md | 4 ++ platform/docs/docs/development/our-process.md | 2 +- platform/docs/docs/development/testing.md | 2 +- .../docs/docs/development/video-tutorials.md | 68 +++++++++++++++++++ 7 files changed, 77 insertions(+), 5 deletions(-) create mode 100644 platform/docs/docs/development/video-tutorials.md diff --git a/platform/docs/docs/development/continuous-integration.md b/platform/docs/docs/development/continuous-integration.md index 72acbbcbd..48ad4c4d0 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 763be20dd..62c59341d 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 733ae5d0f..c06fa24e9 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 0cd7ebc6a..038f331a9 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 aaac77533..a420c9d49 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 c7c846aaa..23f239755 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 000000000..482967e26 --- /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. +