diff --git a/docs/appendix/zowe-glossary.md b/docs/appendix/zowe-glossary.md index 200131e7f4..8c897915f8 100644 --- a/docs/appendix/zowe-glossary.md +++ b/docs/appendix/zowe-glossary.md @@ -51,11 +51,11 @@ Provides a command-line interface that lets you interact with the mainframe remo Includes all the Zowe projects, or components, that are installed on the user's PC. Also known as *Zowe client-side projects* or *Zowe client-side components*. -Examples include Zowe CLI, Zowe Explorer for Visual Studio Code, Zowe Explorer for IntelliJ, and Zowe Client SDKs. +Examples include Zowe CLI, Zowe Explorer for Visual Studio Code, Zowe Explorer for IntelliJ IDEA, and Zowe Client SDKs. ### Zowe Client SDKs -Allow extenders to build applications on top of existing programmatic APIs such as z/OSMF. Currently supported client SDKs include Node.js (core), Kotlin/z/OSMF, Python, Swift, and Java. +Allow extenders to build applications on top of existing programmatic APIs such as z/OSMF. Currently supported client SDKs include Node.js (core), Kotlin, Python, Swift, and Java. ### Zowe Explorer @@ -173,9 +173,9 @@ Provides re-usable and industry-compliant JSON-formatted RMF/SMF data records so The set of programs (for example, `zwe` command) and utilities (for example, JCL, scripts) which manage the Zowe server configuration and components. The infrastructure standardizes the packaging of components and controls how they are started, stopped, and how configuration is provided to them. -#### Zowe IntelliJ Plug-in +#### Zowe Explorer plug-in for IntelliJ IDEA -Uses the IntelliJ IDE to provide the ability to work with z/OS data sets and USS files, and to explore and manage JES jobs. +Uses the IntelliJ IDEA platform IDEs to provide the ability to work with z/OS data sets, USS files, to explore and manage JES jobs and to work with TSO Console. #### Zowe Launcher diff --git a/docs/contribute/roadmap-contribute.md b/docs/contribute/roadmap-contribute.md index fdce094b8b..dcbbcbf6fb 100644 --- a/docs/contribute/roadmap-contribute.md +++ b/docs/contribute/roadmap-contribute.md @@ -52,7 +52,7 @@ Check out the contribution guidelines for different components and squads to lea - [Zowe Application Framework](https://github.com/zowe/zlux) - [Zowe Explorer](https://github.com/zowe/zowe-explorer-vscode/blob/master/CONTRIBUTING.md) - [Zowe Client SDKs](https://github.com/zowe/zowe-cli/blob/master/docs/SDKGuidelines.md) - - [Zowe IntelliJ plug-in](https://github.com/zowe/zowe-explorer-intellij/blob/main/CONTRIBUTING.md) + - [Zowe Explorer plug-in for IntelliJ IDEA](https://github.com/zowe/zowe-explorer-intellij/blob/main/CONTRIBUTING.md) - [Zowe Docs](./contributing) ## Promote Zowe diff --git a/docs/extend/extend-sdks.md b/docs/extend/extend-sdks.md index d8c414a15b..65017fb5d7 100644 --- a/docs/extend/extend-sdks.md +++ b/docs/extend/extend-sdks.md @@ -8,6 +8,7 @@ The functionality is currently limited to the interfaces provided by IBM z/OSMF. For detailed contribution guidelines, see the following documents: - [Node.js SDK guidelines](https://github.com/zowe/zowe-cli/blob/master/docs/SDKGuidelines.md) +- [Kotlin SDK guidelines](https://github.com/zowe/zowe-explorer-intellij/blob/main/CONTRIBUTING.md) - **Coming soon! Python SDK guidelines** ## Community resources @@ -16,4 +17,3 @@ For detailed contribution guidelines, see the following documents: - You can join one of the [Zowe CLI squad meetings](https://lists.openmainframeproject.org/g/zowe-dev/calendar) to discuss Zowe SDKs issues and contibute to Zowe SDKs. - Read a series of [blogs about Zowe](https://medium.com/zowe) on Medium to explore use cases, best practices, and more. - Look for discussion on Zowe topics on the [Open Mainframe Project Community Forums](https://community.openmainframeproject.org/c/zowe). - diff --git a/docs/getting-started/install-zowe-sdks.md b/docs/getting-started/install-zowe-sdks.md index 4e9b85f005..120b53e2ef 100644 --- a/docs/getting-started/install-zowe-sdks.md +++ b/docs/getting-started/install-zowe-sdks.md @@ -20,7 +20,7 @@ The following SDKs are available. For detailed SDK documentation, see the following: - [Zowe Client Java SDK](https://github.com/Zowe-Java-SDK) -- [Zowe Client Kotlin SDK](https://for-mainframe.github.io/r2z/) +- [Zowe Client Kotlin SDK](https://zowe.github.io/zowe-client-kotlin-sdk/) - [Zowe Client Node.js SDK](https://docs.zowe.org/stable/typedoc/index.html) - [Zowe Client Python SDK](https://zowe-client-python-sdk.readthedocs.io/en/latest/) *technical preview* - [Zowe SDK Sample Scripts](https://github.com/zowe/zowe-sdk-sample-scripts/) @@ -55,38 +55,7 @@ implementation group: 'org.zowe.client.java.sdk', name: 'zowe-client-java-sdk', Requires Java Runtime Environment (JRE) 17. -To install this library in your project, use a build tool such as Maven, Gradle, or Ant. Get the necessary artifacts from the [Kotlin SDK repository](https://zowe.jfrog.io/artifactory/libs-release/org/zowe/sdk/zowe-kotlin-sdk/). - -If you add the Kotlin SDK as a dependency to your project, Maven or Gradle automatically downloads any additional dependencies needed to use the SDK. - - -:::note - -You must download the `JAR` file and install it into your local repository using Maven or Gradle. - -::: - -For a Maven project, add the SDK as a dependency by updating the `pom.xml` file: - -``` - - org.zowe.sdk - zowe-kotlin-sdk - {version} - -``` - -For a Gradle project, add the SDK as a dependency by updating the `build.gradle.kts` file: - -``` -implementation("org.zowe.sdk:zowe-kotlin-sdk:$version") -``` - -To use: - -``` -import org.zowe.kotlinsdk -``` +For detailed information about how to install the library, refer to [the official installation guide for Zowe Client Kotlin SDK](https://zowe.github.io/zowe-client-kotlin-sdk/#installation) ### Node.js diff --git a/docs/getting-started/overview.md b/docs/getting-started/overview.md index 05869b52b7..656355feac 100644 --- a/docs/getting-started/overview.md +++ b/docs/getting-started/overview.md @@ -214,6 +214,7 @@ The Zowe Client SDKs consist of programmatic APIs that you can use to build clie - Zowe Node.js Client SDK - Zowe Java Client SDK +- Zowe Kotlin Client SDK - Zowe Python Client SDK For more information, see [Using the Zowe SDKs](../user-guide/sdks-using.md). @@ -268,21 +269,21 @@ ZEBRA Provides re-usable and industry compliant JSON formatted RMF/SMF data reco For more information, see the [ZEBRA documentation](https://github.com/zowe/zebra/tree/main/Documentation). -### Zowe IntelliJ Plug-in +### Zowe Explorer plug-in for IntelliJ IDEA -Zowe IntelliJ plug-in for Intellij-based IDEs is a smart and interactive mainframe code editing tool that allows you to browse, edit, and create data on z/OS via z/OSMF REST API. +Zowe Explorer plug-in for IntelliJ IDEA is a smart and interactive mainframe code editing tool that allows you to browse, edit, and create data on z/OS via z/OSMF REST API. -Zowe IntelliJ plug-in helps you to: -- Start working with z/OS easily with no complex configurations. -- Organize datasets on z/OS, files on USS into working sets. -- Allocate datasets, create members, files and directories with different permissions. -- Perform operations like renaming, copying and moving data in a modern way. -- Edit datasets, files and members. Smart auto-save keeps your content both in the editor and on the mainframe in-sync. -- Create multiple connections to different z/OS systems. -- Perform all available operations with jobs. -- Highlight all IntelliJ supported languages automatically and recognize them once opened from the mainframe. +The plug-in helps to: +- Start working with z/OS easily with no complex configurations +- Organize datasets on z/OS, files on USS into working sets +- Allocate datasets, create members, files and directories with different permissions +- Perform operations like renaming, copying and moving data in a modern way +- Edit datasets, files and members. Smart auto-save keeps your content both in the editor and on the mainframe in-sync +- Create multiple connections to different z/OS systems +- Perform all available operations with jobs +- Work with TSO Console directly in the IDE -For more information, see [Using Zowe IntelliJ plug-in](../user-guide/intellij-using.md). +To see more about it, you can start with [Zowe Explorer plug-in for IntelliJ IDEA use cases](../user-guide/intellij-use-cases.md). ## Zowe Bill of Materials diff --git a/docs/getting-started/zowe_faq.md b/docs/getting-started/zowe_faq.md index b3603e3dfd..38860c2d06 100644 --- a/docs/getting-started/zowe_faq.md +++ b/docs/getting-started/zowe_faq.md @@ -34,7 +34,7 @@ Zowe technology can be used by a variety of mainframe IT and non-IT professional -Zowe consists of several components. The primary languages for API Mediation Layer are Java and JavaScript. Zowe CLI, Explorer for VSCode and Desktop are written in TypeScript. Explorer for IntelliJ is written in Kotlin, ZSS is written in C, while the cross memory server is written in metal C. +Zowe consists of several components. The primary languages for API Mediation Layer are Java and JavaScript. Zowe CLI, Explorer for VSCode and Desktop are written in TypeScript. Zowe Explorer plug-in for IntelliJ IDEA is written in Kotlin, ZSS is written in C, while the cross memory server is written in metal C. @@ -499,19 +499,19 @@ As a developer, you may contribute to Zowe Explorer in the following ways: -## Zowe IntelliJ plug-in FAQ +## Zowe Explorer plug-in for IntelliJ IDEA FAQ -### Why might I use Zowe IntelliJ plug-in versus a traditional ISPF interface to perform mainframe tasks? +### Why might I use the plug-in versus a traditional ISPF interface to perform mainframe tasks?
-Zowe IntelliJ plug-in allows you to access and work with data sets, members and jobs directly from your IntelliJ-based IDE. +Zowe Explorer plug-in for IntelliJ IDEA allows you to access and work with data sets, members and jobs directly from your IntelliJ-based IDE, such as IntelliJ IDEA, PyCharm, Android Studio, etc.
-### How can I get started with Zowe IntelliJ plug-in? +### How can I get started with Zowe Explorer plug-in for IntelliJ IDEA?
@@ -521,42 +521,32 @@ Install the plug-in in your IntelliJ-based IDE directly from marketplace or down
-### Where can I use Zowe IntelliJ plug-in? +### Where can I use Zowe Explorer plug-in for IntelliJ IDEA?
-You can use it in any IntelliJ-based IDE. +You can use it in any IntelliJ-based IDE, such as IntelliJ IDEA, PyCharm, Android Studio, etc.
-### How do I get help with using Zowe IntelliJ plug-in? +### How do I get help with using Zowe Explorer plug-in for IntelliJ IDEA?
-You can read detailed user guide and find any information you need [here](https://plugins.jetbrains.com/plugin/18688-zowe-explorer/user-guide). Also, you can ask any questions in the Zowe Slack channel [#zowe-explorer-intellij](https://openmainframeproject.slack.com/archives/C020BGPSU0M). +You can start with [use cases](../user-guide/intellij-use-cases.md) section to learn about use cases and to learn how to install and use the plug-in. Also, you can ask any questions in our [Zowe Slack channel (#zowe-explorer-intellij)](https://openmainframeproject.slack.com/archives/C020BGPSU0M).
-### How can I create, edit and delete z/OSMF connection? +### How can I contribute to Zowe Explorer plug-in for IntelliJ IDEA?
-To create a connection, expand plug-in panel on an IDE sidebar (on the right side of your screen) and press the "wrench" pictogram, or go to **File** -> **Settings** (CTRL+ALT+S), select **Zowe Explorer (Zowe IntelliJ plugin)** and then switch to the **z/OSMF connection** tab. Press the “+” button and fill inn all necessary fields. - -
- -### How can I contribute to Zowe IntelliJ plug-in? - -
- - - -If you have something to introduce but there is no related issue in the project repo, then you can either create the issue by yourself or contact us to help you with it. See more information in the [CONTRIBUTION.md](https://github.com/zowe/zowe-explorer-intellij/blob/main/CONTRIBUTING.md) file. +If you have ideas on how to improve the plug-in, or have an issue/bug fix in mind, visit the [contribution guide](https://github.com/zowe/zowe-explorer-intellij/blob/main/CONTRIBUTING.md). Also, you can ask for help in our [Zowe Slack channel (#zowe-explorer-intellij)](https://openmainframeproject.slack.com/archives/C020BGPSU0M).
diff --git a/docs/images/intellij/actions_download_artifact.png b/docs/images/intellij/actions_download_artifact.png new file mode 100644 index 0000000000..bf531808ab Binary files /dev/null and b/docs/images/intellij/actions_download_artifact.png differ diff --git a/docs/images/intellij/actions_select_build.png b/docs/images/intellij/actions_select_build.png new file mode 100644 index 0000000000..3eaa68a3f8 Binary files /dev/null and b/docs/images/intellij/actions_select_build.png differ diff --git a/docs/images/intellij/actions_select_workflow.png b/docs/images/intellij/actions_select_workflow.png new file mode 100644 index 0000000000..fb9b5f7d63 Binary files /dev/null and b/docs/images/intellij/actions_select_workflow.png differ diff --git a/docs/images/intellij/connection_create.gif b/docs/images/intellij/connection_create.gif index 2ce0944f5d..d0d3f4a972 100644 Binary files a/docs/images/intellij/connection_create.gif and b/docs/images/intellij/connection_create.gif differ diff --git a/docs/images/intellij/connection_zowe_config_v2.gif b/docs/images/intellij/connection_zowe_config_v2.gif deleted file mode 100644 index 999a7445e5..0000000000 Binary files a/docs/images/intellij/connection_zowe_config_v2.gif and /dev/null differ diff --git a/docs/images/intellij/copy_cut_member_copy.png b/docs/images/intellij/copy_cut_member_copy.png new file mode 100644 index 0000000000..324e80469a Binary files /dev/null and b/docs/images/intellij/copy_cut_member_copy.png differ diff --git a/docs/images/intellij/copy_cut_member_copy_dialog.png b/docs/images/intellij/copy_cut_member_copy_dialog.png new file mode 100644 index 0000000000..91ccea06f9 Binary files /dev/null and b/docs/images/intellij/copy_cut_member_copy_dialog.png differ diff --git a/docs/images/intellij/copy_cut_member_copy_result.png b/docs/images/intellij/copy_cut_member_copy_result.png new file mode 100644 index 0000000000..42ab971e12 Binary files /dev/null and b/docs/images/intellij/copy_cut_member_copy_result.png differ diff --git a/docs/images/intellij/copy_cut_member_copy_select_paste.png b/docs/images/intellij/copy_cut_member_copy_select_paste.png new file mode 100644 index 0000000000..1d484a1b31 Binary files /dev/null and b/docs/images/intellij/copy_cut_member_copy_select_paste.png differ diff --git a/docs/images/intellij/copy_cut_member_cut.png b/docs/images/intellij/copy_cut_member_cut.png new file mode 100644 index 0000000000..6321619672 Binary files /dev/null and b/docs/images/intellij/copy_cut_member_cut.png differ diff --git a/docs/images/intellij/copy_cut_member_cut_dialog.png b/docs/images/intellij/copy_cut_member_cut_dialog.png new file mode 100644 index 0000000000..dcdef7913c Binary files /dev/null and b/docs/images/intellij/copy_cut_member_cut_dialog.png differ diff --git a/docs/images/intellij/copy_cut_member_cut_moving_confirmation.png b/docs/images/intellij/copy_cut_member_cut_moving_confirmation.png new file mode 100644 index 0000000000..76264f5fee Binary files /dev/null and b/docs/images/intellij/copy_cut_member_cut_moving_confirmation.png differ diff --git a/docs/images/intellij/copy_cut_member_cut_result_source.png b/docs/images/intellij/copy_cut_member_cut_result_source.png new file mode 100644 index 0000000000..b3fabea85f Binary files /dev/null and b/docs/images/intellij/copy_cut_member_cut_result_source.png differ diff --git a/docs/images/intellij/copy_cut_member_cut_select_paste.png b/docs/images/intellij/copy_cut_member_cut_select_paste.png new file mode 100644 index 0000000000..f1a8e2f4be Binary files /dev/null and b/docs/images/intellij/copy_cut_member_cut_select_paste.png differ diff --git a/docs/images/intellij/copy_cut_member_to_uss_copy_dialog.png b/docs/images/intellij/copy_cut_member_to_uss_copy_dialog.png new file mode 100644 index 0000000000..f1db0ecdae Binary files /dev/null and b/docs/images/intellij/copy_cut_member_to_uss_copy_dialog.png differ diff --git a/docs/images/intellij/copy_cut_member_to_uss_copy_result.png b/docs/images/intellij/copy_cut_member_to_uss_copy_result.png new file mode 100644 index 0000000000..729b5044b0 Binary files /dev/null and b/docs/images/intellij/copy_cut_member_to_uss_copy_result.png differ diff --git a/docs/images/intellij/copy_cut_pds_to_uss_cross_copy.png b/docs/images/intellij/copy_cut_pds_to_uss_cross_copy.png new file mode 100644 index 0000000000..9e5060b46e Binary files /dev/null and b/docs/images/intellij/copy_cut_pds_to_uss_cross_copy.png differ diff --git a/docs/images/intellij/copy_cut_pds_to_uss_cross_copy_dialog.png b/docs/images/intellij/copy_cut_pds_to_uss_cross_copy_dialog.png new file mode 100644 index 0000000000..905148130e Binary files /dev/null and b/docs/images/intellij/copy_cut_pds_to_uss_cross_copy_dialog.png differ diff --git a/docs/images/intellij/copy_cut_pds_to_uss_cross_copy_paste.png b/docs/images/intellij/copy_cut_pds_to_uss_cross_copy_paste.png new file mode 100644 index 0000000000..c0cac766b1 Binary files /dev/null and b/docs/images/intellij/copy_cut_pds_to_uss_cross_copy_paste.png differ diff --git a/docs/images/intellij/copy_cut_pds_to_uss_cross_copy_result.png b/docs/images/intellij/copy_cut_pds_to_uss_cross_copy_result.png new file mode 100644 index 0000000000..07e1334649 Binary files /dev/null and b/docs/images/intellij/copy_cut_pds_to_uss_cross_copy_result.png differ diff --git a/docs/images/intellij/copy_cut_pds_to_uss_cut.png b/docs/images/intellij/copy_cut_pds_to_uss_cut.png new file mode 100644 index 0000000000..8018c7e0bf Binary files /dev/null and b/docs/images/intellij/copy_cut_pds_to_uss_cut.png differ diff --git a/docs/images/intellij/copy_cut_pds_to_uss_cut_paste.png b/docs/images/intellij/copy_cut_pds_to_uss_cut_paste.png new file mode 100644 index 0000000000..39e7c995ef Binary files /dev/null and b/docs/images/intellij/copy_cut_pds_to_uss_cut_paste.png differ diff --git a/docs/images/intellij/copy_cut_pds_to_uss_cut_result.png b/docs/images/intellij/copy_cut_pds_to_uss_cut_result.png new file mode 100644 index 0000000000..336a4776ff Binary files /dev/null and b/docs/images/intellij/copy_cut_pds_to_uss_cut_result.png differ diff --git a/docs/images/intellij/copy_cut_pds_to_uss_moving_dialog.png b/docs/images/intellij/copy_cut_pds_to_uss_moving_dialog.png new file mode 100644 index 0000000000..cb4973c54b Binary files /dev/null and b/docs/images/intellij/copy_cut_pds_to_uss_moving_dialog.png differ diff --git a/docs/images/intellij/copy_cut_ps_to_pds_copy.png b/docs/images/intellij/copy_cut_ps_to_pds_copy.png new file mode 100644 index 0000000000..f1461fbef1 Binary files /dev/null and b/docs/images/intellij/copy_cut_ps_to_pds_copy.png differ diff --git a/docs/images/intellij/copy_cut_ps_to_pds_copy_conflicts.png b/docs/images/intellij/copy_cut_ps_to_pds_copy_conflicts.png new file mode 100644 index 0000000000..15491181ff Binary files /dev/null and b/docs/images/intellij/copy_cut_ps_to_pds_copy_conflicts.png differ diff --git a/docs/images/intellij/copy_cut_ps_to_pds_copy_dialog.png b/docs/images/intellij/copy_cut_ps_to_pds_copy_dialog.png new file mode 100644 index 0000000000..880fd44c6d Binary files /dev/null and b/docs/images/intellij/copy_cut_ps_to_pds_copy_dialog.png differ diff --git a/docs/images/intellij/copy_cut_ps_to_pds_copy_result.png b/docs/images/intellij/copy_cut_ps_to_pds_copy_result.png new file mode 100644 index 0000000000..68bf2f662f Binary files /dev/null and b/docs/images/intellij/copy_cut_ps_to_pds_copy_result.png differ diff --git a/docs/images/intellij/copy_cut_uss_to_pds_cut.png b/docs/images/intellij/copy_cut_uss_to_pds_cut.png new file mode 100644 index 0000000000..8701ef2de2 Binary files /dev/null and b/docs/images/intellij/copy_cut_uss_to_pds_cut.png differ diff --git a/docs/images/intellij/copy_cut_uss_to_pds_cut_content_before.png b/docs/images/intellij/copy_cut_uss_to_pds_cut_content_before.png new file mode 100644 index 0000000000..c50cc946f5 Binary files /dev/null and b/docs/images/intellij/copy_cut_uss_to_pds_cut_content_before.png differ diff --git a/docs/images/intellij/copy_cut_uss_to_pds_cut_paste.png b/docs/images/intellij/copy_cut_uss_to_pds_cut_paste.png new file mode 100644 index 0000000000..cb7962a590 Binary files /dev/null and b/docs/images/intellij/copy_cut_uss_to_pds_cut_paste.png differ diff --git a/docs/images/intellij/copy_cut_uss_to_pds_cut_placing_warning.png b/docs/images/intellij/copy_cut_uss_to_pds_cut_placing_warning.png new file mode 100644 index 0000000000..d4f0bd1f87 Binary files /dev/null and b/docs/images/intellij/copy_cut_uss_to_pds_cut_placing_warning.png differ diff --git a/docs/images/intellij/copy_cut_uss_to_pds_cut_result.png b/docs/images/intellij/copy_cut_uss_to_pds_cut_result.png new file mode 100644 index 0000000000..65fd5560d0 Binary files /dev/null and b/docs/images/intellij/copy_cut_uss_to_pds_cut_result.png differ diff --git a/docs/images/intellij/copy_cut_uss_to_pds_moving_dialog.png b/docs/images/intellij/copy_cut_uss_to_pds_moving_dialog.png new file mode 100644 index 0000000000..235e62cc36 Binary files /dev/null and b/docs/images/intellij/copy_cut_uss_to_pds_moving_dialog.png differ diff --git a/docs/images/intellij/copy_cut_uss_to_uss_copy_select_paste.png b/docs/images/intellij/copy_cut_uss_to_uss_copy_select_paste.png new file mode 100644 index 0000000000..ff35dccdaa Binary files /dev/null and b/docs/images/intellij/copy_cut_uss_to_uss_copy_select_paste.png differ diff --git a/docs/images/intellij/copy_cut_uss_to_uss_cut.png b/docs/images/intellij/copy_cut_uss_to_uss_cut.png new file mode 100644 index 0000000000..ee9dfae668 Binary files /dev/null and b/docs/images/intellij/copy_cut_uss_to_uss_cut.png differ diff --git a/docs/images/intellij/copy_cut_uss_to_uss_cut_result.png b/docs/images/intellij/copy_cut_uss_to_uss_cut_result.png new file mode 100644 index 0000000000..3b970b3e81 Binary files /dev/null and b/docs/images/intellij/copy_cut_uss_to_uss_cut_result.png differ diff --git a/docs/images/intellij/copy_cut_uss_to_uss_cut_select_paste.png b/docs/images/intellij/copy_cut_uss_to_uss_cut_select_paste.png new file mode 100644 index 0000000000..a811ef2936 Binary files /dev/null and b/docs/images/intellij/copy_cut_uss_to_uss_cut_select_paste.png differ diff --git a/docs/images/intellij/copy_cut_uss_to_uss_moving_dialog.png b/docs/images/intellij/copy_cut_uss_to_uss_moving_dialog.png new file mode 100644 index 0000000000..2e8a64b9bc Binary files /dev/null and b/docs/images/intellij/copy_cut_uss_to_uss_moving_dialog.png differ diff --git a/docs/images/intellij/copy_mem_to_uss.gif b/docs/images/intellij/copy_mem_to_uss.gif deleted file mode 100644 index 6fbfd5ff88..0000000000 Binary files a/docs/images/intellij/copy_mem_to_uss.gif and /dev/null differ diff --git a/docs/images/intellij/create_connection_plus.png b/docs/images/intellij/create_connection_plus.png new file mode 100644 index 0000000000..840180d026 Binary files /dev/null and b/docs/images/intellij/create_connection_plus.png differ diff --git a/docs/images/intellij/create_connection_settings.png b/docs/images/intellij/create_connection_settings.png new file mode 100644 index 0000000000..9cb325af0f Binary files /dev/null and b/docs/images/intellij/create_connection_settings.png differ diff --git a/docs/images/intellij/create_connection_zowe_config_file.gif b/docs/images/intellij/create_connection_zowe_config_file.gif new file mode 100644 index 0000000000..3b0d6dbb1a Binary files /dev/null and b/docs/images/intellij/create_connection_zowe_config_file.gif differ diff --git a/docs/images/intellij/create_connection_zowe_config_plus.gif b/docs/images/intellij/create_connection_zowe_config_plus.gif new file mode 100644 index 0000000000..587ddca3d2 Binary files /dev/null and b/docs/images/intellij/create_connection_zowe_config_plus.gif differ diff --git a/docs/images/intellij/create_plugins_connection_or_zowe_config.png b/docs/images/intellij/create_plugins_connection_or_zowe_config.png new file mode 100644 index 0000000000..0a035a61af Binary files /dev/null and b/docs/images/intellij/create_plugins_connection_or_zowe_config.png differ diff --git a/docs/images/intellij/cross_system_copy.gif b/docs/images/intellij/cross_system_copy.gif deleted file mode 100644 index 156b4233ed..0000000000 Binary files a/docs/images/intellij/cross_system_copy.gif and /dev/null differ diff --git a/docs/images/intellij/datasets_sort.png b/docs/images/intellij/datasets_sort.png new file mode 100644 index 0000000000..8e11b57e76 Binary files /dev/null and b/docs/images/intellij/datasets_sort.png differ diff --git a/docs/images/intellij/datasets_sort_result.png b/docs/images/intellij/datasets_sort_result.png new file mode 100644 index 0000000000..857bbdfe79 Binary files /dev/null and b/docs/images/intellij/datasets_sort_result.png differ diff --git a/docs/images/intellij/download_intellij.png b/docs/images/intellij/download_intellij.png new file mode 100644 index 0000000000..c4bb2094c3 Binary files /dev/null and b/docs/images/intellij/download_intellij.png differ diff --git a/docs/images/intellij/download_plugin_marketplace.png b/docs/images/intellij/download_plugin_marketplace.png new file mode 100644 index 0000000000..67e3fa3343 Binary files /dev/null and b/docs/images/intellij/download_plugin_marketplace.png differ diff --git a/docs/images/intellij/download_plugin_releases.png b/docs/images/intellij/download_plugin_releases.png new file mode 100644 index 0000000000..469c24d4a4 Binary files /dev/null and b/docs/images/intellij/download_plugin_releases.png differ diff --git a/docs/images/intellij/download_uss_copy.png b/docs/images/intellij/download_uss_copy.png new file mode 100644 index 0000000000..b0a45906fd Binary files /dev/null and b/docs/images/intellij/download_uss_copy.png differ diff --git a/docs/images/intellij/download_uss_copy_final_dialog.png b/docs/images/intellij/download_uss_copy_final_dialog.png new file mode 100644 index 0000000000..9e3ddc6597 Binary files /dev/null and b/docs/images/intellij/download_uss_copy_final_dialog.png differ diff --git a/docs/images/intellij/download_uss_copy_name_conflicts.png b/docs/images/intellij/download_uss_copy_name_conflicts.png new file mode 100644 index 0000000000..f0a0ca03a1 Binary files /dev/null and b/docs/images/intellij/download_uss_copy_name_conflicts.png differ diff --git a/docs/images/intellij/download_uss_copy_paste.png b/docs/images/intellij/download_uss_copy_paste.png new file mode 100644 index 0000000000..083dca4bd4 Binary files /dev/null and b/docs/images/intellij/download_uss_copy_paste.png differ diff --git a/docs/images/intellij/download_uss_copy_result.png b/docs/images/intellij/download_uss_copy_result.png new file mode 100644 index 0000000000..d65071f499 Binary files /dev/null and b/docs/images/intellij/download_uss_copy_result.png differ diff --git a/docs/images/intellij/download_uss_copy_security_warning.png b/docs/images/intellij/download_uss_copy_security_warning.png new file mode 100644 index 0000000000..fbe90227b9 Binary files /dev/null and b/docs/images/intellij/download_uss_copy_security_warning.png differ diff --git a/docs/images/intellij/download_uss_copy_single_conflict.png b/docs/images/intellij/download_uss_copy_single_conflict.png new file mode 100644 index 0000000000..a94c4b7244 Binary files /dev/null and b/docs/images/intellij/download_uss_copy_single_conflict.png differ diff --git a/docs/images/intellij/get_plugin.png b/docs/images/intellij/get_plugin.png new file mode 100644 index 0000000000..92a415066b Binary files /dev/null and b/docs/images/intellij/get_plugin.png differ diff --git a/docs/images/intellij/install_from_bin_from_disk.png b/docs/images/intellij/install_from_bin_from_disk.png new file mode 100644 index 0000000000..236f3e6bce Binary files /dev/null and b/docs/images/intellij/install_from_bin_from_disk.png differ diff --git a/docs/images/intellij/install_from_bin_restart.png b/docs/images/intellij/install_from_bin_restart.png new file mode 100644 index 0000000000..55e43c3757 Binary files /dev/null and b/docs/images/intellij/install_from_bin_restart.png differ diff --git a/docs/images/intellij/install_from_bin_search_for_zip.png b/docs/images/intellij/install_from_bin_search_for_zip.png new file mode 100644 index 0000000000..9df91c8b38 Binary files /dev/null and b/docs/images/intellij/install_from_bin_search_for_zip.png differ diff --git a/docs/images/intellij/install_in_intellij_after_install.png b/docs/images/intellij/install_in_intellij_after_install.png new file mode 100644 index 0000000000..a5747d96e2 Binary files /dev/null and b/docs/images/intellij/install_in_intellij_after_install.png differ diff --git a/docs/images/intellij/install_in_intellij_corner_change.png b/docs/images/intellij/install_in_intellij_corner_change.png new file mode 100644 index 0000000000..fad743bb00 Binary files /dev/null and b/docs/images/intellij/install_in_intellij_corner_change.png differ diff --git a/docs/images/intellij/install_in_intellij_marketplace.png b/docs/images/intellij/install_in_intellij_marketplace.png new file mode 100644 index 0000000000..5c30f5da81 Binary files /dev/null and b/docs/images/intellij/install_in_intellij_marketplace.png differ diff --git a/docs/images/intellij/install_in_intellij_plugins.png b/docs/images/intellij/install_in_intellij_plugins.png new file mode 100644 index 0000000000..facba91f00 Binary files /dev/null and b/docs/images/intellij/install_in_intellij_plugins.png differ diff --git a/docs/images/intellij/install_in_intellij_restart.png b/docs/images/intellij/install_in_intellij_restart.png new file mode 100644 index 0000000000..c7d8190aec Binary files /dev/null and b/docs/images/intellij/install_in_intellij_restart.png differ diff --git a/docs/images/intellij/install_in_intellij_search_and_install.png b/docs/images/intellij/install_in_intellij_search_and_install.png new file mode 100644 index 0000000000..8f0d0a0f4c Binary files /dev/null and b/docs/images/intellij/install_in_intellij_search_and_install.png differ diff --git a/docs/images/intellij/intellij-install.gif b/docs/images/intellij/intellij-install.gif deleted file mode 100644 index 10c06fb377..0000000000 Binary files a/docs/images/intellij/intellij-install.gif and /dev/null differ diff --git a/docs/images/intellij/intellij_open_uss_file.png b/docs/images/intellij/intellij_open_uss_file.png new file mode 100644 index 0000000000..0b32036819 Binary files /dev/null and b/docs/images/intellij/intellij_open_uss_file.png differ diff --git a/docs/images/intellij/jes_jcl_edit.png b/docs/images/intellij/jes_jcl_edit.png new file mode 100644 index 0000000000..f0a923106b Binary files /dev/null and b/docs/images/intellij/jes_jcl_edit.png differ diff --git a/docs/images/intellij/jes_jcl_edit_after_refresh.png b/docs/images/intellij/jes_jcl_edit_after_refresh.png new file mode 100644 index 0000000000..569a63f0b8 Binary files /dev/null and b/docs/images/intellij/jes_jcl_edit_after_refresh.png differ diff --git a/docs/images/intellij/jes_jcl_edit_console.png b/docs/images/intellij/jes_jcl_edit_console.png new file mode 100644 index 0000000000..e12ea9e9ba Binary files /dev/null and b/docs/images/intellij/jes_jcl_edit_console.png differ diff --git a/docs/images/intellij/jes_jcl_edit_refresh.png b/docs/images/intellij/jes_jcl_edit_refresh.png new file mode 100644 index 0000000000..29e267c385 Binary files /dev/null and b/docs/images/intellij/jes_jcl_edit_refresh.png differ diff --git a/docs/images/intellij/jes_jcl_edit_run_button.png b/docs/images/intellij/jes_jcl_edit_run_button.png new file mode 100644 index 0000000000..34134795f7 Binary files /dev/null and b/docs/images/intellij/jes_jcl_edit_run_button.png differ diff --git a/docs/images/intellij/jes_purge_click_purge.png b/docs/images/intellij/jes_purge_click_purge.png new file mode 100644 index 0000000000..ac0a9b30db Binary files /dev/null and b/docs/images/intellij/jes_purge_click_purge.png differ diff --git a/docs/images/intellij/jes_purge_dialog.png b/docs/images/intellij/jes_purge_dialog.png new file mode 100644 index 0000000000..41986de1e6 Binary files /dev/null and b/docs/images/intellij/jes_purge_dialog.png differ diff --git a/docs/images/intellij/jes_purge_job_create_filter.png b/docs/images/intellij/jes_purge_job_create_filter.png new file mode 100644 index 0000000000..499faf1924 Binary files /dev/null and b/docs/images/intellij/jes_purge_job_create_filter.png differ diff --git a/docs/images/intellij/jes_purge_job_filter_dialog.png b/docs/images/intellij/jes_purge_job_filter_dialog.png new file mode 100644 index 0000000000..1e5956cd88 Binary files /dev/null and b/docs/images/intellij/jes_purge_job_filter_dialog.png differ diff --git a/docs/images/intellij/jes_purge_success_notification.png b/docs/images/intellij/jes_purge_success_notification.png new file mode 100644 index 0000000000..23cc7cdba8 Binary files /dev/null and b/docs/images/intellij/jes_purge_success_notification.png differ diff --git a/docs/images/intellij/jes_sort.png b/docs/images/intellij/jes_sort.png new file mode 100644 index 0000000000..f14fbd4724 Binary files /dev/null and b/docs/images/intellij/jes_sort.png differ diff --git a/docs/images/intellij/jes_sort_sorted.png b/docs/images/intellij/jes_sort_sorted.png new file mode 100644 index 0000000000..4877f9db80 Binary files /dev/null and b/docs/images/intellij/jes_sort_sorted.png differ diff --git a/docs/images/intellij/jes_spool_console.png b/docs/images/intellij/jes_spool_console.png new file mode 100644 index 0000000000..6b0091b4fe Binary files /dev/null and b/docs/images/intellij/jes_spool_console.png differ diff --git a/docs/images/intellij/jes_spool_console_shown.png b/docs/images/intellij/jes_spool_console_shown.png new file mode 100644 index 0000000000..56dab8b1d9 Binary files /dev/null and b/docs/images/intellij/jes_spool_console_shown.png differ diff --git a/docs/images/intellij/jes_spool_view.png b/docs/images/intellij/jes_spool_view.png new file mode 100644 index 0000000000..220a12ec28 Binary files /dev/null and b/docs/images/intellij/jes_spool_view.png differ diff --git a/docs/images/intellij/jes_spool_view_editor.png b/docs/images/intellij/jes_spool_view_editor.png new file mode 100644 index 0000000000..e85b47b21d Binary files /dev/null and b/docs/images/intellij/jes_spool_view_editor.png differ diff --git a/docs/images/intellij/jes_spool_view_reveal.png b/docs/images/intellij/jes_spool_view_reveal.png new file mode 100644 index 0000000000..07c7f56706 Binary files /dev/null and b/docs/images/intellij/jes_spool_view_reveal.png differ diff --git a/docs/images/intellij/jes_status.png b/docs/images/intellij/jes_status.png new file mode 100644 index 0000000000..93eb89afb5 Binary files /dev/null and b/docs/images/intellij/jes_status.png differ diff --git a/docs/images/intellij/move_mem_to_ds.gif b/docs/images/intellij/move_mem_to_ds.gif deleted file mode 100644 index 5814436b3d..0000000000 Binary files a/docs/images/intellij/move_mem_to_ds.gif and /dev/null differ diff --git a/docs/images/intellij/move_uss_folder_to_uss_folder.gif b/docs/images/intellij/move_uss_folder_to_uss_folder.gif deleted file mode 100644 index cfe62346bf..0000000000 Binary files a/docs/images/intellij/move_uss_folder_to_uss_folder.gif and /dev/null differ diff --git a/docs/images/intellij/move_uss_to_pds.gif b/docs/images/intellij/move_uss_to_pds.gif deleted file mode 100644 index 0633c186f8..0000000000 Binary files a/docs/images/intellij/move_uss_to_pds.gif and /dev/null differ diff --git a/docs/images/intellij/pds_copy_move_ds.gif b/docs/images/intellij/pds_copy_move_ds.gif deleted file mode 100644 index 26d42b7d3c..0000000000 Binary files a/docs/images/intellij/pds_copy_move_ds.gif and /dev/null differ diff --git a/docs/images/intellij/pds_move_zos_to_uss.gif b/docs/images/intellij/pds_move_zos_to_uss.gif deleted file mode 100644 index 6cfedd82fd..0000000000 Binary files a/docs/images/intellij/pds_move_zos_to_uss.gif and /dev/null differ diff --git a/docs/images/intellij/plugin_all_configurations.png b/docs/images/intellij/plugin_all_configurations.png new file mode 100644 index 0000000000..4c3cd38e26 Binary files /dev/null and b/docs/images/intellij/plugin_all_configurations.png differ diff --git a/docs/images/intellij/plugin_create_dataset.png b/docs/images/intellij/plugin_create_dataset.png new file mode 100644 index 0000000000..831b9100d0 Binary files /dev/null and b/docs/images/intellij/plugin_create_dataset.png differ diff --git a/docs/images/intellij/plugin_create_dataset_fields.png b/docs/images/intellij/plugin_create_dataset_fields.png new file mode 100644 index 0000000000..072797d042 Binary files /dev/null and b/docs/images/intellij/plugin_create_dataset_fields.png differ diff --git a/docs/images/intellij/plugin_create_dataset_ok.png b/docs/images/intellij/plugin_create_dataset_ok.png new file mode 100644 index 0000000000..5d71cfcd35 Binary files /dev/null and b/docs/images/intellij/plugin_create_dataset_ok.png differ diff --git a/docs/images/intellij/plugin_create_mask_or_skip.png b/docs/images/intellij/plugin_create_mask_or_skip.png new file mode 100644 index 0000000000..6e4721fc62 Binary files /dev/null and b/docs/images/intellij/plugin_create_mask_or_skip.png differ diff --git a/docs/images/intellij/plugin_dataset_presets.png b/docs/images/intellij/plugin_dataset_presets.png new file mode 100644 index 0000000000..ce73928c44 Binary files /dev/null and b/docs/images/intellij/plugin_dataset_presets.png differ diff --git a/docs/images/intellij/plugin_open_settings.png b/docs/images/intellij/plugin_open_settings.png new file mode 100644 index 0000000000..7088ae4f0c Binary files /dev/null and b/docs/images/intellij/plugin_open_settings.png differ diff --git a/docs/images/intellij/plugin_other_settings.png b/docs/images/intellij/plugin_other_settings.png new file mode 100644 index 0000000000..baded2dec6 Binary files /dev/null and b/docs/images/intellij/plugin_other_settings.png differ diff --git a/docs/images/intellij/plugin_save_before_close.png b/docs/images/intellij/plugin_save_before_close.png new file mode 100644 index 0000000000..1f017dfd30 Binary files /dev/null and b/docs/images/intellij/plugin_save_before_close.png differ diff --git a/docs/images/intellij/plugin_sync_button.png b/docs/images/intellij/plugin_sync_button.png new file mode 100644 index 0000000000..db9bd7d4a7 Binary files /dev/null and b/docs/images/intellij/plugin_sync_button.png differ diff --git a/docs/images/intellij/select_compatibility_and_channel.png b/docs/images/intellij/select_compatibility_and_channel.png new file mode 100644 index 0000000000..7c5c32556d Binary files /dev/null and b/docs/images/intellij/select_compatibility_and_channel.png differ diff --git a/docs/images/intellij/tso_cli.gif b/docs/images/intellij/tso_cli.gif deleted file mode 100644 index c7171ca53c..0000000000 Binary files a/docs/images/intellij/tso_cli.gif and /dev/null differ diff --git a/docs/images/intellij/tso_console_create.png b/docs/images/intellij/tso_console_create.png new file mode 100644 index 0000000000..1daa4c9aa7 Binary files /dev/null and b/docs/images/intellij/tso_console_create.png differ diff --git a/docs/images/intellij/tso_console_created_console.png b/docs/images/intellij/tso_console_created_console.png new file mode 100644 index 0000000000..1c8c6268af Binary files /dev/null and b/docs/images/intellij/tso_console_created_console.png differ diff --git a/docs/images/intellij/tso_console_dialog.png b/docs/images/intellij/tso_console_dialog.png new file mode 100644 index 0000000000..1525860666 Binary files /dev/null and b/docs/images/intellij/tso_console_dialog.png differ diff --git a/docs/images/intellij/tso_sessions_add.png b/docs/images/intellij/tso_sessions_add.png new file mode 100644 index 0000000000..15fb226403 Binary files /dev/null and b/docs/images/intellij/tso_sessions_add.png differ diff --git a/docs/images/intellij/tso_sessions_add_dialog.png b/docs/images/intellij/tso_sessions_add_dialog.png new file mode 100644 index 0000000000..ffe0ab737f Binary files /dev/null and b/docs/images/intellij/tso_sessions_add_dialog.png differ diff --git a/docs/images/intellij/tso_sessions_created.png b/docs/images/intellij/tso_sessions_created.png new file mode 100644 index 0000000000..71e8006fd6 Binary files /dev/null and b/docs/images/intellij/tso_sessions_created.png differ diff --git a/docs/images/intellij/tso_sessions_go_to_sessions.png b/docs/images/intellij/tso_sessions_go_to_sessions.png new file mode 100644 index 0000000000..7873e766da Binary files /dev/null and b/docs/images/intellij/tso_sessions_go_to_sessions.png differ diff --git a/docs/images/intellij/tso_sessions_wrench.png b/docs/images/intellij/tso_sessions_wrench.png new file mode 100644 index 0000000000..f5173631b6 Binary files /dev/null and b/docs/images/intellij/tso_sessions_wrench.png differ diff --git a/docs/images/intellij/upload_file_to_pds_copy.png b/docs/images/intellij/upload_file_to_pds_copy.png new file mode 100644 index 0000000000..637f6747cb Binary files /dev/null and b/docs/images/intellij/upload_file_to_pds_copy.png differ diff --git a/docs/images/intellij/upload_file_to_pds_copy_dialog.png b/docs/images/intellij/upload_file_to_pds_copy_dialog.png new file mode 100644 index 0000000000..fa1970f16c Binary files /dev/null and b/docs/images/intellij/upload_file_to_pds_copy_dialog.png differ diff --git a/docs/images/intellij/upload_file_to_pds_copy_member_truncation.png b/docs/images/intellij/upload_file_to_pds_copy_member_truncation.png new file mode 100644 index 0000000000..c9eb8b1281 Binary files /dev/null and b/docs/images/intellij/upload_file_to_pds_copy_member_truncation.png differ diff --git a/docs/images/intellij/upload_file_to_pds_copy_paste.png b/docs/images/intellij/upload_file_to_pds_copy_paste.png new file mode 100644 index 0000000000..0bba9a2a97 Binary files /dev/null and b/docs/images/intellij/upload_file_to_pds_copy_paste.png differ diff --git a/docs/images/intellij/upload_file_to_pds_copy_result.png b/docs/images/intellij/upload_file_to_pds_copy_result.png new file mode 100644 index 0000000000..61dc37c715 Binary files /dev/null and b/docs/images/intellij/upload_file_to_pds_copy_result.png differ diff --git a/docs/images/intellij/uss_click_properties.png b/docs/images/intellij/uss_click_properties.png new file mode 100644 index 0000000000..cbd70c1830 Binary files /dev/null and b/docs/images/intellij/uss_click_properties.png differ diff --git a/docs/images/intellij/uss_encoding_dialog.png b/docs/images/intellij/uss_encoding_dialog.png new file mode 100644 index 0000000000..bc92d23e74 Binary files /dev/null and b/docs/images/intellij/uss_encoding_dialog.png differ diff --git a/docs/images/intellij/uss_encoding_select_option.png b/docs/images/intellij/uss_encoding_select_option.png new file mode 100644 index 0000000000..ac0bdc918c Binary files /dev/null and b/docs/images/intellij/uss_encoding_select_option.png differ diff --git a/docs/images/intellij/uss_encoding_warning_dialog.png b/docs/images/intellij/uss_encoding_warning_dialog.png new file mode 100644 index 0000000000..453900ad42 Binary files /dev/null and b/docs/images/intellij/uss_encoding_warning_dialog.png differ diff --git a/docs/images/intellij/uss_properties_change_owner_perms.png b/docs/images/intellij/uss_properties_change_owner_perms.png new file mode 100644 index 0000000000..7ec4383c90 Binary files /dev/null and b/docs/images/intellij/uss_properties_change_owner_perms.png differ diff --git a/docs/images/intellij/uss_properties_change_owner_perms_ok.png b/docs/images/intellij/uss_properties_change_owner_perms_ok.png new file mode 100644 index 0000000000..2666ab3239 Binary files /dev/null and b/docs/images/intellij/uss_properties_change_owner_perms_ok.png differ diff --git a/docs/images/intellij/uss_properties_change_owner_perms_select.png b/docs/images/intellij/uss_properties_change_owner_perms_select.png new file mode 100644 index 0000000000..6b80e9fdc2 Binary files /dev/null and b/docs/images/intellij/uss_properties_change_owner_perms_select.png differ diff --git a/docs/images/intellij/uss_properties_possible_changes.png b/docs/images/intellij/uss_properties_possible_changes.png new file mode 100644 index 0000000000..5f7c490d37 Binary files /dev/null and b/docs/images/intellij/uss_properties_possible_changes.png differ diff --git a/docs/images/intellij/uss_props_general_tab.png b/docs/images/intellij/uss_props_general_tab.png new file mode 100644 index 0000000000..175dc06985 Binary files /dev/null and b/docs/images/intellij/uss_props_general_tab.png differ diff --git a/docs/images/intellij/uss_sort.png b/docs/images/intellij/uss_sort.png new file mode 100644 index 0000000000..63fd7c2190 Binary files /dev/null and b/docs/images/intellij/uss_sort.png differ diff --git a/docs/images/intellij/uss_sort_result.png b/docs/images/intellij/uss_sort_result.png new file mode 100644 index 0000000000..0efca33b57 Binary files /dev/null and b/docs/images/intellij/uss_sort_result.png differ diff --git a/docs/images/intellij/work_with_jes_jobs.gif b/docs/images/intellij/work_with_jes_jobs.gif deleted file mode 100644 index 74aa2f535a..0000000000 Binary files a/docs/images/intellij/work_with_jes_jobs.gif and /dev/null differ diff --git a/docs/images/troubleshoot/intellij/intellij-find-plugin.png b/docs/images/troubleshoot/intellij/intellij-find-plugin.png new file mode 100644 index 0000000000..7724b4354c Binary files /dev/null and b/docs/images/troubleshoot/intellij/intellij-find-plugin.png differ diff --git a/docs/images/troubleshoot/intellij/intellij-go-to-plugins.png b/docs/images/troubleshoot/intellij/intellij-go-to-plugins.png new file mode 100644 index 0000000000..6aaee8b312 Binary files /dev/null and b/docs/images/troubleshoot/intellij/intellij-go-to-plugins.png differ diff --git a/docs/images/troubleshoot/intellij/intellij-troubleshoot-about.png b/docs/images/troubleshoot/intellij/intellij-troubleshoot-about.png new file mode 100644 index 0000000000..bccadf7661 Binary files /dev/null and b/docs/images/troubleshoot/intellij/intellij-troubleshoot-about.png differ diff --git a/docs/images/troubleshoot/intellij/intellij-troubleshoot-about_dialog.png b/docs/images/troubleshoot/intellij/intellij-troubleshoot-about_dialog.png new file mode 100644 index 0000000000..7bad12896b Binary files /dev/null and b/docs/images/troubleshoot/intellij/intellij-troubleshoot-about_dialog.png differ diff --git a/docs/troubleshoot/troubleshoot-check-your-zowe-version.md b/docs/troubleshoot/troubleshoot-check-your-zowe-version.md index c1bdb2b8b5..cd9c52015f 100644 --- a/docs/troubleshoot/troubleshoot-check-your-zowe-version.md +++ b/docs/troubleshoot/troubleshoot-check-your-zowe-version.md @@ -99,14 +99,6 @@ Find the version number of your Zowe release in the `manifest.json` file. An **Editor** tab displays the Zowe Explorer extension's marketplace details. The version number is located next to the Zowe Explorer extension's name. -### Zowe IntelliJ Plug-in +### Zowe Explorer plug-in for IntelliJ IDEA -1. Open the **File** menu and click **Settings**. - - The **Settings** window opens. -2. Click **Plugins**, then click **Installed** tab. - - A list of the installed extensions displays. -3. Search for, and select, `Zowe Explorer`. - - The Zowe Explorer marketplace details display on the right side of the window. The version number is located adjacent to the Zowe Explorer name. +See the [guide](./troubleshoot-intellij) for instructions. diff --git a/docs/troubleshoot/troubleshoot-intellij.md b/docs/troubleshoot/troubleshoot-intellij.md index 59f7107f2a..11ee63b389 100644 --- a/docs/troubleshoot/troubleshoot-intellij.md +++ b/docs/troubleshoot/troubleshoot-intellij.md @@ -1,10 +1,39 @@ -# Troubleshooting Zowe IntelliJ plug-in +# Troubleshooting Zowe Explorer plug-in for IntelliJ IDEA -As a Zowe IntelliJ plug-in user, you may encounter problems with how the plug-in functions. +As a Zowe Explorer plug-in for IntelliJ IDEA user, you may encounter problems both with the plug-in and the IntelliJ IDEA platform. Our support is open for any type of issues, related to this client-side component. See the next sections as an example of how to react on these problems. -Before reaching out for support, +## Troubleshooting IntelliJ IDEA platform issues -1. Is there already a GitHub issue (open or closed) that covers the problem? Check [Zowe IntelliJ plug-in Issues](https://github.com/zowe/zowe-explorer-intellij/issues). -2. Try searching using the Zowe Docs search bar. +Sometimes there could be inconveniences in how your IDE works. Before trying to fix any problem: +1. Go to **Help** > **About** -When necessary, you can use [the Slack channel](https://openmainframeproject.slack.com/archives/C020BGPSU0M) to reach the Zowe IntelliJ squad for assistance. +![Open About](../images/troubleshoot/intellij/intellij-troubleshoot-about.png) + +2. Click **Copy and Close** button and save this information somewhere for later + +![About dialog](../images/troubleshoot/intellij/intellij-troubleshoot-about_dialog.png) + +After that, there are a few steps that could be possibly done to fix the issue: +- **If the issue details are clear and IDE says, which component it is** - copy all the related information and send it to the component's developer +- **If the issue is unclear** - try to reload IDE / your computer. If the problem persists, try to reinstall the IDE or install the newest one supported LTS version of the IDE you are using +- **Ask for help or search for the related issue** - there is [an issue tracker](https://youtrack.jetbrains.com/issues/IDEA), related to the IntelliJ IDEA issues. Try to find something related or create a new one + +## Troubleshooting the plug-in + +If you have an issue with the plug-in: +1. Click the **gear** button, select **Plugins...** + +![Select plugins](../images/troubleshoot/intellij/intellij-go-to-plugins.png) + +2. Go to **Installed** tab, locate the plug-in, save **the exact version number** + +![Locate the plugin](../images/troubleshoot/intellij/intellij-find-plugin.png) + +After these actions, you have some options to try: +- **If the problem occurs for the plug-in in editor** - try to close the file you are editing, refresh the path and open it again +- **If the problem occurs with displaying a mask or a filter** - try to hit refresh on a working set or try to recreate a connection and a working set +- **If the problem occurs for some other issues related to Files Explorer or JES Explorer** - try to recreate a new connection, and a new working set for it +- **If the problem occurs for TSO Console** - try to reopen the session, try to recreate a session entirely +- **Other non-related issues, e.g. if the problem occurs for encoding or permissions or "Internal IDE error" notification appears constantly** - copy all the necessary information about the IDE you use and the plug-in's version, [create a new issue](https://github.com/zowe/zowe-explorer-intellij/issues) listing all the necessary information (like the steps to recreate the issue) as well as the versions, or search for the related issue in the repository and put a thumb-up for it, so we know that it should have a higher priority + +If you want a direct consulting, don't hesitate to visit our [Slack channel](https://openmainframeproject.slack.com/archives/C020BGPSU0M) and leave a message. Our team is always willing to help with any issues related to the platform or the plug-in, no matter the size of an issue or a question. diff --git a/docs/troubleshoot/troubleshooting.md b/docs/troubleshoot/troubleshooting.md index 06cbebd114..c68c8995cb 100644 --- a/docs/troubleshoot/troubleshooting.md +++ b/docs/troubleshoot/troubleshooting.md @@ -46,7 +46,7 @@ You can also find error messages and codes, must-gathers, and information about - [Troubleshooting Zowe CLI](./cli/troubleshoot-cli.md) - [Troubleshooting Zowe Explorer](./ze/troubleshoot-ze.md) - [Troubleshooting Zowe Chat](./zowe-chat-troubleshoot/troubleshooting.md) -- [Troubleshooting Zowe IntelliJ plug-in](troubleshoot-intellij.md) +- [Troubleshooting Zowe Explorer plug-in for IntelliJ IDEA](troubleshoot-intellij.md) ## Verifying a Zowe release's integrity diff --git a/docs/user-guide/cli-cicsplugin.md b/docs/user-guide/cli-cicsplugin.md index 2b4d481596..19194e79f8 100644 --- a/docs/user-guide/cli-cicsplugin.md +++ b/docs/user-guide/cli-cicsplugin.md @@ -72,7 +72,7 @@ Alternatively, you can create a CICS profile manually by adding a section that c 2. Browse to the directory `C:\Users\\.zowe`. -3. Open the `zowe.config.json` configuration file using a text editor or IDE, such as Visual Studio Code or IntelliJ. +3. Open the `zowe.config.json` configuration file using a text editor or IDE, such as Visual Studio Code or IntelliJ IDEA. :::note diff --git a/docs/user-guide/cli-db2plugin.md b/docs/user-guide/cli-db2plugin.md index e29a8d6837..1e8c66fdb9 100644 --- a/docs/user-guide/cli-db2plugin.md +++ b/docs/user-guide/cli-db2plugin.md @@ -202,7 +202,7 @@ Alternatively, you can create a Db2 profile manually by adding a section that co 2. Browse to the directory `C:\Users\\.zowe`. -3. Open the `zowe.config.json` configuration file using a text editor or IDE, such as Visual Studio Code or IntelliJ. +3. Open the `zowe.config.json` configuration file using a text editor or IDE, such as Visual Studio Code or IntelliJ IDEA. :::note diff --git a/docs/user-guide/cli-ftpplugin.md b/docs/user-guide/cli-ftpplugin.md index a09aa51771..8f4e4821ce 100644 --- a/docs/user-guide/cli-ftpplugin.md +++ b/docs/user-guide/cli-ftpplugin.md @@ -78,7 +78,7 @@ Alternatively, you can create an FTP profile manually by adding a section that c 2. Browse to the directory `C:\Users\\.zowe`. -3. Open the `zowe.config.json` configuration file using a text editor or IDE, such as Visual Studio Code or IntelliJ. +3. Open the `zowe.config.json` configuration file using a text editor or IDE, such as Visual Studio Code or IntelliJ IDEA. :::note diff --git a/docs/user-guide/cli-install-configure-zosmf.md b/docs/user-guide/cli-install-configure-zosmf.md index d3d954ee7c..7b9909ee50 100644 --- a/docs/user-guide/cli-install-configure-zosmf.md +++ b/docs/user-guide/cli-install-configure-zosmf.md @@ -5,7 +5,7 @@ For client-side components to communicate with the mainframe, z/OSMF requires co :::info Required role: systems programmer ::: -Complete the following IBM z/OSMF configuration tasks for the implementation of [Zowe CLI](../user-guide/user-roadmap-zowe-cli.md), [Zowe Explorer for Visual Studio Code](../getting-started/user-roadmap-zowe-explorer.md), or the [Zowe IntelliJ Plug-in](../user-guide/intellij-install.md). +Complete the following IBM z/OSMF configuration tasks for the implementation of [Zowe CLI](../user-guide/user-roadmap-zowe-cli.md), [Zowe Explorer for Visual Studio Code](../getting-started/user-roadmap-zowe-explorer.md), or the [Zowe Explorer plug-in for IntelliJ IDEA](../user-guide/intellij-configure.md). :::note diff --git a/docs/user-guide/cli-mqplugin.md b/docs/user-guide/cli-mqplugin.md index 5f554cf4c9..744b034b9d 100644 --- a/docs/user-guide/cli-mqplugin.md +++ b/docs/user-guide/cli-mqplugin.md @@ -71,7 +71,7 @@ Alternatively, you can create an MQ profile manually by adding a section that co 2. Browse to the directory `C:\Users\\.zowe`. -3. Open the `zowe.config.json` configuration file using a text editor or IDE, such as Visual Studio Code or IntelliJ. +3. Open the `zowe.config.json` configuration file using a text editor or IDE, such as Visual Studio Code or IntelliJ IDEA. :::note diff --git a/docs/user-guide/intellij-configure.md b/docs/user-guide/intellij-configure.md index bdc321195d..8ee7f0cb44 100644 --- a/docs/user-guide/intellij-configure.md +++ b/docs/user-guide/intellij-configure.md @@ -1,44 +1,52 @@ -# Configuring Zowe IntelliJ plug-in +# Configuring the plug-in -After you install the Zowe Intellij plug-in, you must create a z/OSMF connection to your mainframe and some working sets. +After you install the Zowe Explorer plug-in for Intellij IDEA, you must create a z/OSMF connection to your mainframe and some working sets. :::note -z/OS v2.1 or later is required z/OSMF configuration. The plug-in is in active development state. +z/OS v2.3 or later is required with a REST API z/OSMF configured properly. To use it, you need the user ID to be connected to the IZUUSER RACF group. Contact your RACF administrator to complete the setup process. ::: ## Creating z/OSMF connection There are two ways to create a z/OSMF connection: -- using the in-built plug-in feature -- using Zowe Config v2 +- using the in-built plug-in's connection configurations **(1)** +- using Zowe Team Config v2 **(2)** -### Creating the connection using the plug-in feature +![Create plug-in's connection or Zowe Config](../images/intellij/create_plugins_connection_or_zowe_config.png) -You can create a z/OSMF connection to your mainframe either by manually specifying all the needed information through the Settings tab, or by clicking the "+" sign. The z/OSMF port should be specified at the end of the address. +### Creating the connection using the plug-in's connection configurations + +You can create a connection to a z/OSMF REST API either by manually specifying all the needed information through the "Settings" tab **(1)**, or by clicking the "+" sign **(2)**. + +![Create a connection through "Settings"](../images/intellij/create_connection_settings.png)     ![Create a connection using "+" button](../images/intellij/create_connection_plus.png) To create the connection: -1. In Zowe Explorer click **+** button +1. In the Zowe Explorer click **+** button 2. Select **Connection** -3. Type in all the necessary information -4. Wait until the connection is tested +3. Type in all the necessary information in the dialog +4. Wait until the connection test is finished and all the necessary information is fetched ![Configure IntelliJ z/OSMF connection](../images/intellij/connection_create.gif) ### Creating the connection using Zowe Config v2 -*Prerequisite: Zowe CLI installed ([click here for the guide](https://docs.zowe.org/stable/user-guide/cli-installcli))* +To create the z/OSMF connection with Zowe Config v2 there are two ways. + +The first scenario - adding already existing Zowe Config v2 from a local opened project +1. Open the project with the **zowe.config.json** +2. *Zowe config file detected* notification should appear, click **Add Zowe Connection** +3. Wait until the connection is tested + +![Configure IntelliJ z/OSMF connection using Zowe Config v2](../images/intellij/create_connection_zowe_config_file.gif) -To create the z/OSMF connection with Zowe Config v2: -1. In command line, issue: `zowe config init` -2. Enter all the required information -3. After that, *Zowe config file detected* notification should appear, click **Add Zowe Connection** -4. If the connection test is failed, click **Add Anyway** -5. In Zowe Config change all the wrong parameters to the correct ones -6. Click appeared *Reload* button in the editor -7. Wait until the connection is tested +The second scenario - creating a new Zowe Config v2 from scratch: +1. In the Zowe Explorer click **+** button +2. Select **Zowe Team Configuration** +3. Fill in all the necessary information in the dialog +4. Wait until the connection test is finished and all the necessary information is fetched -![Configure IntelliJ z/OSMF connection using Zowe Config v2](../images/intellij/connection_zowe_config_v2.gif) +![Configure Zowe Team v2 from scratch](../images/intellij/create_connection_zowe_config_plus.gif) After the configuration is made, you will be able to use all the features of the plug-in. diff --git a/docs/user-guide/intellij-copy-cut.md b/docs/user-guide/intellij-copy-cut.md new file mode 100644 index 0000000000..ffcf49f82a --- /dev/null +++ b/docs/user-guide/intellij-copy-cut.md @@ -0,0 +1,327 @@ +# Copying and moving data using the plug-in + +The essential feature of the plug-in is to provide the ability to copy and move content between different entities and systems. The plug-in provides functionalities to copy and move any kind of information possible (also in terms of security). + +## Copy and move: the same system + +There are different options to copy and move z/OS datasets and members between each other, as well as USS files. It is possible to move and copy files and datasets either through keyboard shortcut buttons and context menu, or using **Drag & Drop**. + +### Copy and move: a dataset member copy and move examples + +:::important note +Make sure the parameters of the target dataset allow you to paste a new member. Sometimes there is an error occures during paste operation to the dataset due to the directory blocks value being not enough to fit the member. +::: + +To copy member from one dataset to another: +1. Right click on the member to be copied, select **Copy** + +![Copy cut: member copy](../images/intellij/copy_cut_member_copy.png) + +2. Right click on the target PDS / PDS/E dataset, select **Paste** + +![Copy cut: member copy select paste](../images/intellij/copy_cut_member_copy_select_paste.png) + +3. A dialog about the copy operation appears. It is also possible to cancel the operation until it is finished + +![Copy cut: member copying dialog](../images/intellij/copy_cut_member_copy_dialog.png) + +4. After the operation is completed, the dataset will be automatically refreshed and the member will appear in the list of the dataset members + +![Copy cut: member copy result](../images/intellij/copy_cut_member_copy_result.png) + +To move a member from one dataset to another: +1. Right click on the member to be moved, select **Cut** + +![Copy cut: member cut](../images/intellij/copy_cut_member_cut.png) + +2. Right click on the target PDS / PDS/E dataset, select **Paste** + +![Copy cut: member cut select paste](../images/intellij/copy_cut_member_cut_select_paste.png) + +:::note +You can use a **Drag & Drop** feature to accomplish the same action +::: + +3. A confirmation dialog for the member to be moved will appear, select **Yes** + +![Copy cut: member cut confirmation dialog](../images/intellij/copy_cut_member_cut_moving_confirmation.png) + +4. A dialog about the move operation appears. It is also possible to cancel the operation until it is finished + +![Copy cut: member moving dialog](../images/intellij/copy_cut_member_cut_dialog.png) + +5. After the operation is completed, the dataset will be automatically refreshed and the member will appear in the list of the dataset members + +![Copy cut: member cut result](../images/intellij/copy_cut_member_copy_result.png) + +The member will disappear from the source dataset. + +![Copy cut: member cut result source](../images/intellij/copy_cut_member_cut_result_source.png) + +### Copy and move: a PS dataset to a PDS member copy example + +The plug-in allows to copy and move PS datasets to PDS / PDSE datasets. The dataset will become a member of the target dataset. The name of the member will be trimmed to the last element of the source HLQ. If there are already a member with the same name as the newly pasted one has, the name will be changed to the same dataset member's name with the last character(s) replaced with the next available number to form a non-conflicting name of the member. + +:::important note +Make sure the parameters of the target dataset allow you to paste a new member. Sometimes there is an error occures during paste operation to the dataset due to the directory blocks value being not enough to fit the member. +::: + +To copy a sequential dataset to a partitioned dataset: +1. Right click on the PS to be copied, select **Copy** + +![Copy cut: PS to PDS copy right click](../images/intellij/copy_cut_ps_to_pds_copy.png) + +2. Right click on the target PDS / PDS/E dataset, select **Paste** + +![Copy cut: PS to PDS copy select paste](../images/intellij/copy_cut_member_copy_select_paste.png) + +3. If there is a conflicting name member in the dataset exists, the plug-in will suggest a new name to apply to the member to appear in the dataset members list. Click **Ok** to agree to use the new name + +![Copy cut: PS to PDS copy conflicts](../images/intellij/copy_cut_ps_to_pds_copy_conflicts.png) + +4. A dialog about the copy operation appears. It is also possible to cancel the operation until it is finished + +![Copy cut: PS to PDS copying dialog](../images/intellij/copy_cut_ps_to_pds_copy_dialog.png) + +5. After the operation is completed, the dataset will be automatically refreshed and the member will appear in the list of the dataset members + +![Copy cut: PS to PDS copy result](../images/intellij/copy_cut_ps_to_pds_copy_result.png) + +### Copy and move: a USS file to a USS folder move example + +To move USS file or folder to another USS folder: +1. Right click on the folder or the file to be moved, select **Cut** + +![Copy cut: USS file to USS folder cut](../images/intellij/copy_cut_uss_to_uss_cut.png) + +2. Right click on the target USS folder, select **Paste** + +![Copy cut: USS file to USS folder cut select paste](../images/intellij/copy_cut_uss_to_uss_cut_select_paste.png) + +:::note +You can use a **Drag & Drop** feature to accomplish the same action +::: + +3. A confirmation dialog for the file to be moved will appear, select **Yes** + +![Copy cut: USS file to USS folder cut confirmation dialog](../images/intellij/copy_cut_member_cut_moving_confirmation.png) + +4. A dialog about the move operation appears. It is also possible to cancel the operation until it is finished + +![Copy cut: USS file to USS folder moving dialog](../images/intellij/copy_cut_uss_to_uss_moving_dialog.png) + +5. After the operation is completed, the path will be automatically refreshed and the file will appear in the refreshed list. Also the file will disappear from the source path + +![Copy cut: USS file to USS folder cut result](../images/intellij/copy_cut_uss_to_uss_cut_result.png) + +### Copy and move: a PDS / PDS/E member to a USS folder copy example + +There is also a functionality provided by the plug-in to copy and move PS, PDS / PDS/E datasets and members to a USS path. + +To copy a PDS / PDS/E member to a USS folder: +1. Right click on the member to be copied, select **Copy** + +![Copy cut: member to USS copy](../images/intellij/copy_cut_member_copy.png) + +2. Right click on the target USS folder, select **Paste** + +![Copy cut: member to USS copy select paste](../images/intellij/copy_cut_uss_to_uss_copy_select_paste.png) + +3. A dialog about the copy operation appears. It is also possible to cancel the operation until it is finished + +![Copy cut: member to USS copying dialog](../images/intellij/copy_cut_member_to_uss_copy_dialog.png) + +4. After the operation is completed, the USS path will be automatically refreshed and the newly pasted USS file will appear + +![Copy cut: member to USS copy result](../images/intellij/copy_cut_member_to_uss_copy_result.png) + +### Copy and move: a PDS / PDS/E dataset to a USS folder move example + +While moving or copying a partitioned dataset to the USS path, it will be converted to a USS folder with USS files. + +To move a PDS / PDS/E dataset to a USS path: +1. Right click on the PDS to be copied, select **Cut** + +![Copy cut: PDS to USS cut](../images/intellij/copy_cut_pds_to_uss_cut.png) + +2. Right click on the target USS folder, select **Paste** + +![Copy cut: PDS to USS cut paste](../images/intellij/copy_cut_pds_to_uss_cut_paste.png) + +:::note +You can use a **Drag & Drop** feature to accomplish the same action +::: + +3. A confirmation dialog for the file to be moved will appear, select **Yes** + +![Copy cut: PDS to USS cut confirmation dialog](../images/intellij/copy_cut_member_cut_moving_confirmation.png) + +4. A dialog about the move operation appears. It is also possible to cancel the operation until it is finished + +![Copy cut: PDS to USS moving dialog](../images/intellij/copy_cut_pds_to_uss_moving_dialog.png) + +5. After the operation is completed, the path will be automatically refreshed and the folder will appear in the refreshed list. Also the dataset will disappear from the z/OS part + +![Copy cut: PDS to USS cut result](../images/intellij/copy_cut_pds_to_uss_cut_result.png) + +### Copy and move: a USS file to a PDS / PDS/E dataset move example + +Also, it is possible to copy and move a USS file to a PDS / PDS/E dataset. The file will become a PDS member. + +:::important note +The contents of the source files and datasets will stay the same, until you try to copy/move a file from USS to a z/OS partitioned dataset. If the file lines are longer than the specified for the PDS / PDS/E logical record length, the plug-in will cut the rest of the line, exceeding the LRECL, for each of the exceeding lines. +::: + +To move a USS file to a PDS / PDS/E dataset: +1. Right click on the file to be copied, select **Cut** + +![Copy cut: USS to PDS cut](../images/intellij/copy_cut_uss_to_pds_cut.png) + +2. Right click on the target PDS / PDS/E dataset, select **Paste** + +![Copy cut: USS to PDS cut paste](../images/intellij/copy_cut_uss_to_pds_cut_paste.png) + +:::note +You can use a **Drag & Drop** feature to accomplish the same action +::: + +3. A confirmation dialog for the file to be moved will appear, select **Yes** + +![Copy cut: USS to PDS cut confirmation dialog](../images/intellij/copy_cut_member_cut_moving_confirmation.png) + +4. Also, the warning dialog about placing a USS file under a PDS / PDS/E dataset will appear. It will describe the actual result of this operation. Click **Ok** + +![Copy cut: USS to PDS cut placing warning](../images/intellij/copy_cut_uss_to_pds_cut_placing_warning.png) + +5. A dialog about the move operation appears. It is also possible to cancel the operation until it is finished + +![Copy cut: USS to PDS moving dialog](../images/intellij/copy_cut_uss_to_pds_moving_dialog.png) + +6. After the operation is completed, the dataset will be automatically refreshed and the list of the members will be refreshed with the new member in the list present. Also the file will disappear from the USS path + +![Copy cut: USS to PDS cut result](../images/intellij/copy_cut_uss_to_pds_cut_result.png) + +:::note +You could notice the new member name. It is formed from the first 8 alphanumeric characters of the source file. Also, when there are member name conflicts, there is a resolution mechanism implemented in the plug-in. The new name will be formed as the change of the conflicting name, adding the next available number to the new name of the new member. +::: + +## Cross-system copy and move + +The plug-in provides a functionality to move and copy z/OS Datasets and USS files between different systems. E.g.: a user has two systems with different IPs. So, it is possible to copy or move files and datasets either from the first IP to the second, or vice versa. The rules of copying and moving that are described previously, are the same for this action. + +### Copy and move: a PDS / PDS/E dataset to a USS path cross-system copy example + +To copy a PDS / PDS/E dataset to a USS path in a different system: +1. Right click on the dataset to be copied, select **Copy** + +![Copy cut: PDS to USS cross-system copy](../images/intellij/copy_cut_pds_to_uss_cross_copy.png) + +2. Right click on the target system's USS path, select **Paste** + +![Copy cut: PDS to USS cross-system copy select paste](../images/intellij/copy_cut_pds_to_uss_cross_copy_paste.png) + +3. A dialog about the copy operation appears. It is also possible to cancel the operation until it is finished + +![Copy cut: PDS to USS cross-system copy dialog](../images/intellij/copy_cut_pds_to_uss_cross_copy_dialog.png) + +4. After the operation is completed, the USS path will be automatically refreshed and the path will be refreshed with the new USS folder in the list present + +![Copy cut: PDS to USS cross-system copy result](../images/intellij/copy_cut_pds_to_uss_cross_copy_result.png) + +## Downloading USS files and folders and z/OS Datasets and members + +There is a feature to download USS files and folders, as well as z/OS Datasets and members. Both **Copy** and **Cut** functionalities are available for the downloading feature. + +### Download feature: a USS file download as a copy operation + +To copy a USS file to a local machine: +1. Right click on the z/OS system's USS file, select **Copy** + +![Download: USS file copy](../images/intellij/download_uss_copy.png) + +2. Right click in the local project's explorer view, select **Paste** + +![Download: USS file copy paste](../images/intellij/download_uss_copy_paste.png) + +3. If there are conflicts in the names of the entities being copied, the plug-in will ask for the option to select: + - **Skip the conflicting file(s) (1)** - will skip the entities copying + - **Replace the file(s) in the destination (2)** - will replace the entities in the destination with the being copied ones + - **Decide for each file (3)** - will ask separately for each entity being copied + +For the example purposes, select **Decide for each file (3)** + +![Download: USS file copy decide](../images/intellij/download_uss_copy_name_conflicts.png) + +4. The next dialog window will appear, asking what to do with the conflicting file: + - **Skip (1)** - will skip the entity copying + - **Overwrite (2)** - will overwrite the entity with the same name in the destination + - **Use new name (3)** - will create a new entity as a copy of the entity being copied with a new name, provided by the plug-in + +For the example purposes, select **Use new name(3)** + +![Download: USS file copy decide single](../images/intellij/download_uss_copy_single_conflict.png) + +5. The final warning dialog will appear, notifying that the operation may be against the security rules in your company. Select **Yes** + +:::warning do it on your own risk! +Do not proceed with the operation if your organization does not allow you to distribute information from your mainframe. It may contain sensitive data that is not meant to be distributed outside a mainframe. +::: + +![Download: USS file copy security warning](../images/intellij/download_uss_copy_security_warning.png) + +6. A dialog about the copy operation appears. It is also possible to cancel the operation until it is finished + +![Download: USS file copy final dialog](../images/intellij/download_uss_copy_final_dialog.png) + +7. After the operation is completed, the file will appear in your local project's tree + +![Download: USS file copy result](../images/intellij/download_uss_copy_result.png) + +## Uploading files to a USS subsystem and z/OS Datasets + +It is also possible with the plug-in to upload files to a USS path and z/OS Dataset as a member + +### Upload feature: a file to a PDS / PDS/E member upload as a copy operation + +:::important note +Make sure the parameters of the target dataset allow you to paste a new member. Sometimes there is an error occures during paste operation to the dataset due to the directory blocks value being not enough to fit the member. +::: + +:::important note +The contents of the source files and datasets will stay the same, until you try to copy/move a file from USS to a z/OS partitioned dataset. If the file lines are longer than the specified for the PDS / PDS/E logical record length, the plug-in will cut the rest of the line, exceeding the LRECL, for each of the exceeding lines. +::: + +To upload a file as a copy operation from a local machine to a PDS / PDS/E datasets as a member: +1. Right click on a file on the local project's tree, select **Copy** + +![Upload: local file to PDS copy](../images/intellij/upload_file_to_pds_copy.png) + +2. Right click on the destination PDS / PDS/E, select **Paste** + +![Upload: local file to PDS copy paste](../images/intellij/upload_file_to_pds_copy_paste.png) + +3. The truncation warning will appear, click **Ok** + +![Upload: local file to PDS copy truncation warning](../images/intellij/upload_file_to_pds_copy_member_truncation.png) + +4. A dialog about the copy operation appears. It is also possible to cancel the operation until it is finished + +![Upload: local file to PDS copy dialog](../images/intellij/upload_file_to_pds_copy_dialog.png) + +5. After the operation is completed, a new member will appear in the destination PDS / PDS/E + +:::note +Check the content of the member after the operation. It could be truncated due to LRECL of the dataset. +::: + +![Upload: local file to PDS copy result](../images/intellij/upload_file_to_pds_copy_result.png) + +## Current limitations + +There are still some features in development and are not possible to accomplish with the plug-in: +1. **Folder uploading to a USS path** +2. **File uploading to a z/OS mask as a PS dataset** +3. **USS folder copy to a z/OS mask as a PDS / PDS/E dataset** +4. **Folder uploading to a z/OS mask as a PDS / PDS/E dataset** + +If you have some ideas regarding these operations or want to make a change in the existing one, please, [reach out to us](https://openmainframeproject.slack.com/archives/C020BGPSU0M). diff --git a/docs/user-guide/intellij-install-prereqs.md b/docs/user-guide/intellij-install-prereqs.md new file mode 100644 index 0000000000..f7e6107d8e --- /dev/null +++ b/docs/user-guide/intellij-install-prereqs.md @@ -0,0 +1,19 @@ +# Prerequisites + +The plug-in is supported on all of the operating systems with GUI. To use the plug-in, you need to install an IntelliJ IDEA platform's IDE. The platform has a nubmer of IDEs for different purposes. E.g. if you have Java/Kotlin developers, there is an IntelliJ IDEA IDE, for Python developers, there is a PyCharm IDE, for web developers, there is a WebStorm IDE, etc. + +There are two **Community** versions of the IDEs: **IntelliJ IDEA Community** and **PyCharm Community**. It means that these IDEs are open-source and free of charge. The plug-in is supported on any IntelliJ IDEA IDE, it is enough to have the **Community** version of any of the IDEs to work with the plug-in. + +:::note +Most of the other IntelliJ IDEA IDEs are available under the *Ultimate* version. It means that they are available to use after purchasing them. They have a 30-day trial if you want to try them before the purchase. +::: + +To install the **IntelliJ IDEA Community**: +1. Proceed to the [official JetBrains download page](https://www.jetbrains.com/idea/download) +2. Scroll down to the **Community** version of the IDE, select the binary to download + +![Download IntelliJ](../images/intellij/download_intellij.png) + +3. After the binary is downloaded, walk through the installation wizard and install the IDE + +After these steps, you will be ready to proceed with the plug-in installation. diff --git a/docs/user-guide/intellij-install.md b/docs/user-guide/intellij-install.md index 06bd30d3a9..053566482a 100644 --- a/docs/user-guide/intellij-install.md +++ b/docs/user-guide/intellij-install.md @@ -1,15 +1,125 @@ -# Zowe IntelliJ plug-in -## Installing +# Installing the plug-in -You can install the plug-in in your Intellij-based IDE directly from the marketplace or download it from https://plugins.jetbrains.com/plugin/18688-zowe-explorer +There are two ways to install the plug-in: +1. **(Preferred)** Install the plug-in directly inside IntelliJ IDEA +2. Download and install binaries either from [JetBrains Marketplace page](https://plugins.jetbrains.com/plugin/18688-zowe-explorer) or from our [GitHub repository](https://github.com/zowe/zowe-explorer-intellij) + +## Installing inside IntelliJ IDEA To install the plug-in from IntelliJ: -1. Go to **File -> Settings...** (`Ctrl`+`Alt`+`S` for short). -2. Select **Plugins** and then **Marketplace** on top of the window. +1. At the right top corner click the gear button and from the dropdown list select the **Plugins** option + +![Select plugins from the dropdown](../images/intellij/install_in_intellij_plugins.png) + +2. Select the **Marketplace** tab on top of the window + +![Select marketplace tab](../images/intellij/install_in_intellij_marketplace.png) + 3. Type **Zowe Explorer** and click **Install**. -4. Wait until the plug-in is installed, then click **OK**. -Contact your RACF administrator so that your user is in the IZUUSER RACF group. +![Search for the plugin and install](../images/intellij/install_in_intellij_search_and_install.png) + +4. Wait until the plug-in is installed, then click **Restart IDE**. IntelliJ IDEA will ask you if you want to restart the IDE to applly all the changes in plugins. Select **Restart**, wait until the IDE is restarted + +![Restart the IDE](../images/intellij/install_in_intellij_restart.png) + +After the IDE is restarted, the plug-in's icon will appear at the right top corner. It means that you are ready to work with it. + +![After installed](../images/intellij/install_in_intellij_after_install.png) + +:::note +Sometimes the plug-in's icon appear at some different place, other than the right top corner. To fix it, right-click on the icon, in the **Move To** dropdown select the **Right Top** option. + +![Change the corner](../images/intellij/install_in_intellij_corner_change.png) + +::: + +## Downloading binaries + +:::warning ALWAYS DOUBLE-CHECK THE BINARIES YOU ARE TRYING TO INSTALL! +We are responsible for the genuine software provided by the zowe community only. If you have any questions regarding the installation or the usage of the plug-in, feel free to contact any person directly related to Zowe +::: + +There are three ways of downloading binaries of the Zowe Explorer plug-in for IntelliJ IDEA: +1. [JetBrains Marketplace page](https://plugins.jetbrains.com/plugin/18688-zowe-explorer) +2. [GitHub Releases](https://github.com/zowe/zowe-explorer-intellij/releases) of our repository +3. [GitHub Actions](https://github.com/zowe/zowe-explorer-intellij/actions) of our repository + +### Downloading binaries from JetBrains Marketplace page + +1. Proceed to the [JetBrains Marketplace page](https://plugins.jetbrains.com/plugin/18688-zowe-explorer) of the plug-in +2. Click **Get** button or select the **Versions** tab + +![Get IntelliJ plug-in](../images/intellij/get_plugin.png) + +3. Select the compatibility option and the channel of the distribution: + - **Stable** - the stable versions of the plug-in + - **EAP** - the *Early Access Program* versions of the plug-in, sometimes are provided for the EAP versions of the IntelliJ IDEA + - **Preview** - the next versions of the plug-in, that contain the bleeding-edge features of the plug-in, which may be unstable + +![Select compatibility and channel](../images/intellij/select_compatibility_and_channel.png) + +4. Select the version of the plug-in you want to download, click **Download** button against it + +![Download plug-in from JetBrains Marketplace](../images/intellij/download_plugin_marketplace.png) + +### Downloading binaries from GitHub Releases + +1. Proceed to the [GitHub Releases](https://github.com/zowe/zowe-explorer-intellij/releases) of the repository +2. Select the release version you want to install and click on the .zip file to download the binary + +:::note +Prefer the "*-signed.zip" over the regular one +::: + +![Download plug-in from GitHub Releases](../images/intellij/download_plugin_releases.png) + +### Downloading binaries from GitHub Actions + +:::note +You need to be logged into a GitHub account to be able to download artifacts +::: + +1. Proceed to the [GitHub Actions](https://github.com/zowe/zowe-explorer-intellij/actions) of the repository +2. Select a build workflow + +![Select a build workflow actions](../images/intellij/actions_select_workflow.png) + +3. Select the build of a branch you want to download + +![Select the build of a branch actions](../images/intellij/actions_select_build.png) + +4. At the bottom of the page, in the *Artifacts* section, select the .zip file with the version build to download + +![Download the build actions](../images/intellij/actions_download_artifact.png) + +## Installing binaries + +After the .zip is downloaded, do the next steps: +1. At the right top corner click the gear button and from the dropdown list select the **Plugins** option + +![Select plugins from the dropdown](../images/intellij/install_in_intellij_plugins.png) + +2. Near the **Installed** tab, click the gear button, from the dropdown select the **Install Plugin from Disk** option + +![Install from disk](../images/intellij/install_from_bin_from_disk.png) + +3. In the **Choose Plugin File** dialog window, search for the .zip you want to install. Select it and click **OK** button + +![Search for .zip](../images/intellij/install_from_bin_search_for_zip.png) + +4. The plug-in will appear in the **Installed** tab, click the **Restart IDE** button, and then the **Restart** button in the dialog window. + +![Restart after install from .zip](../images/intellij/install_from_bin_restart.png) + +After the IDE is restarted, the plug-in's icon will appear at the right top corner. It means that you are ready to work with it. + +![After installed](../images/intellij/install_in_intellij_after_install.png) + +:::note +Sometimes the plug-in's icon appear at some different place, other than the right top corner. To fix it, right-click on the icon, in the **Move To** dropdown select the **Right Top** option. + +![Change the corner](../images/intellij/install_in_intellij_corner_change.png) -![Intall IntelliJ](../images/intellij/intellij-install.gif) +::: diff --git a/docs/user-guide/intellij-jes-explorer.md b/docs/user-guide/intellij-jes-explorer.md new file mode 100644 index 0000000000..b0600b5964 --- /dev/null +++ b/docs/user-guide/intellij-jes-explorer.md @@ -0,0 +1,143 @@ +# Working with JES Explorer + +Using the plug-in, you will be able to: +- view a status of a job, view full log of a job run +- view and edit job's JCL, submit a JCL right after they are edited +- purge a job +- sort jobs + +After you set up a [JES Working Set](./intellij-working-sets.md#jes-working-set) and create a job filter to display jobs, you are all set up to work with JES Explorer. + +## Creating a jobs filter + +To see and manipulate JES jobs, you need to specify a jobs filter to search for jobs. + +To create a jobs filter: +1. Proceed to the **JES Explorer**, right click on a **JES Working Set**, select **New > Jobs Filter** + +![Create a job filter](../images/intellij/jes_purge_job_create_filter.png) + +2. Specify the parameters in the **Create Jobs Filter** dialog: + - **Prefix (1)** - the prefix for a jobs search. Can be specified as a wildcard + - **Owner (2)** - the owner for a jobs search. Can be specified as a wildcard + - **Job ID (3)** - the exact job ID for a job search + +:::note +You can specify either **prefix + owner** or a **job ID** only. A mix of the parameters is not allowed. +::: + +After the parameters are specified, click **OK** + +![Specify parameters for a job filter](../images/intellij/jes_purge_job_filter_dialog.png) + +Now, you are ready to proceed to work with JES jobs. + +## Viewing a job status + +The job status is displayed depending on the actual status of the job with the respective colouring. + +To view a job status: +1. Proceed to the **JES Explorer**, reveal a **JES Working Set** and a **Jobs Filter**. There are different statuses depending on the state of a job: + - ENDED AT: \. RC = CC 0000 - the job is ended successfully, displaying the actual date and time of the job finish + - ENDED AT: \. RC = \ - the job is ended with an error or a warning, displaying the actual date and time of the job finish + - STARTED AT: \ - the job is started but is in progress and not yet completed, displaying the actual date and time of the job start + - PENDING INPUT / QUEUED - the job is not started yet as it is waiting in the queue until the same job already started is finished + +![See job status in JES Explorer](../images/intellij/jes_status.png) + +## Viewing job spool files and job's run logs + +All the spool files available for the jobs could be viewed in the plug-in. + +To view the job spool files: +1. At the **JES Explorer** tab, reveal a JES Working Set and a jobs filter + +![Find a job](../images/intellij/jes_spool_view.png) + +2. Double click on the job or click **>** on the left of it. You will see all the spool files, available for the job + +:::note +If the job is still in progress, it is possible that not all the spool files are available yet. Just wait until the job is finished and refresh the view by right clicking and selecting **Refresh**. +::: + +![Reveal spool files](../images/intellij/jes_spool_view_reveal.png) + +3. Double click on any of the spool files to see the content of it. The lines will be displayed in the editor in a reader mode + +![Spool file in editor](../images/intellij/jes_spool_view_editor.png) + +To view all the spool files merged in one log: +1. Right click on the job in **JES Explorer**, select **View Job** + +![View merged spool files](../images/intellij/jes_spool_console.png) + +2. The merged spool files log will be displayed in the **Zowe Jobs** console view. There are two buttons to manipulate the job in there: + - **Go To Job (1)** - reveals the job in **JES Explorer**. If the job is not yet visible in the JES Explorer, the plug-in provides a dialog to create a filter for the exact job to present + - **Purge Job (2)** - removes the job from JES + +:::note +If the job is completed successfully, the plug-in can hide the successful steps. To show them, right click on the job in the console view and select **Show Successful Steps** and it will show all the spool files of the job as steps. +::: + +![Merged spool files in console](../images/intellij/jes_spool_console_shown.png) + +## View and edit job's JCL code + +The plug-in provides the possibility to view and edit a JCL code of the job in the JES Explorer. The JCL will appear in the IDE's editor. You could change the JCL and submit the job with a new code. + +To view and edit the JCL code of a JES job: +1. Right click on the job in **JES Explorer**, select **Edit JCL** + +![Select edit jcl](../images/intellij/jes_jcl_edit.png) + +2. After the JCL content is fetched, it will be displayed in the IDE's editor. You can change the JCL as much as you want. Also, the editor allows to submit the JCL again. Click the **Submit Job** button + +![Click submit button](../images/intellij/jes_jcl_edit_run_button.png) + +3. When the job is submitted, the console of the job's execution will appear, providing the actual information about the job run + +![Console with the job run](../images/intellij/jes_jcl_edit_console.png) + +4. Also, it is possible to see the status of the job being run. On the appropriate **Job Filter** in the **JES Explorer**, right click and select **Refresh** + +![Refresh job filter after edit and run](../images/intellij/jes_jcl_edit_refresh.png) + +5. After refresh is completed, a new list with jobs will be displayed with the submitted job and its respective status + +![After job filter refreshed](../images/intellij/jes_jcl_edit_after_refresh.png) + +## Purge a job + +To purge a job from a JES: +1. Specify a **Jobs Filter**. After the jobs are fetched, right click on a job to purge, select **Purge** (or press **Delete** button when the job is selected) + +![Click Purge](../images/intellij/jes_purge_click_purge.png) + +2. When the job is being purged, a "purge" dialog will appear until the job is purged + +![Purge dialog](../images/intellij/jes_purge_dialog.png) + +3. After the job is purged, a notification about the job is purged will appear and the **Jobs Filter** will be refreshed + +![Notification about the job purge](../images/intellij/jes_purge_success_notification.png) + +## Sort jobs + +For the improved user experience, there is a feature of the plug-in to sort jobs for a specified jobs filter. + +To sort jobs: +1. Proceed to the **JES Explorer**, reveal a **Jobs Filter**, right click on it, select **Sort**. There are will be options: + - **Job Name (1)** - to sort jobs by their names + - **Job Creation Date (2)** - to sort jobs by their creation date and time. Jobs are sorted by this option by default + - **Job Completion Date (3)** - to sort jobs by their completion date and time + - **Job Status (4)** - to sort jobs by their status. It means that the return code will be analyzed by the status, displayed in the JES Explorer + - **Job Owner (5)** - to sort jobs by their owners + - **Job ID (6)** - to sort jobs by their IDs + +Also, there is a possibility to change the order for the items to be displayed: **Ascending (7)** (by default) or **Descending (8)**. For the example purposes, select **Job Name** + +![Select job name when sorting](../images/intellij/jes_sort.png) + +2. The list will be refreshed with the new sort order + +![Sorted jobs by job name](../images/intellij/jes_sort_sorted.png) diff --git a/docs/user-guide/intellij-settings.md b/docs/user-guide/intellij-settings.md new file mode 100644 index 0000000000..94d9acfad8 --- /dev/null +++ b/docs/user-guide/intellij-settings.md @@ -0,0 +1,41 @@ +# Working with plug-in's settings + +Before you start to use the plug-in, there are some settings that will help you to customize the way you are working with it. To open the plug-in's settings: +1. Open the **Zowe Explorer** tab **(1)**, click the **Settings** button **(2)**. The action will open all the configurations of the plug-in + +![Open plug-in's settings](../images/intellij/plugin_open_settings.png) + +2. After the window of the configuration appears, there are some tabs: +- **Connections (1)** - to manage the connections to z/OS you have. From there, you can add a new connection and delete or edit the old one +- **JES Working Sets (2)** - to manage the JES Working Sets +- **Working Sets (3)** - to manage the Files Working Sets +- **TSO Sessions (4)** - to manage TSO Sessions +- **Settings (5)** - the actual customization options of the plug-in + +Click the **Settings** tab to proceed to the customization options + +![In the settings](../images/intellij/plugin_all_configurations.png) + +3. At the **Settings** tab, there are two available customization options: +- **Batch amount to show per fetch (1)** - the amount of datasets to show under a mask. The option is editable and accepts integer numbers +- **Enable auto-sync with mainframe (2)** - the option to save content of the edited datasets and USS files automatically if selected + +![Other settings](../images/intellij/plugin_other_settings.png) + +## Batch amount to show per fetch + +There could be a huge amount of datasets / files under a specified mask. Sometimes the loading of their list could take a lot of time. To eliminate this problem, the plug-in provides the ability to control the amount of items loading at one time. The option is called **Batch amount to show per fetch**. By default, it is set to **100** entries. It means that when the request to display entities under a mask contains more than the specified number, it will show the first "x" entities with the button to load more of them. You can load the next amount by double-clicking on the **load more** at the bottom of the list. + +![Batch size option](../images/intellij/batch_size.gif) + +## Enable auto-sync with mainframe + +It is possible to synchronize the file or dataset you are editing either manually or automatically. The method of synchronizing is controlled by the **Enable auto-sync with mainframe** option. When it is marked, you don't need to manually synchronize the file / dataset whilst editing it, the plug-in decides by itself, when to synchronize it. In case you want to be sure that you control the process of synchronizing the content with a mainframe, or in case you have some limitations for calls to z/OSMF REST API, or for some other reason, you can disable this option and continue with manual synchronization. The synchronization process starts either by the button in the editor (![Sync button](../images/intellij/plugin_sync_button.png)), appearing if there are any changes in the file, or by pressing simultaneously **Ctrl + Shift + S (Cmd + Shift + S for MacOS)**. + +If the manual synchronization is turned on, and you try to close the file in the editor, the plug-in will ask what to do with the content. Clicking **Yes** will synchronize the content, **No** will delete the local changes: + +![Yes or No before close](../images/intellij/plugin_save_before_close.png) + +Here's how auto-synchronization works: + +![Auto-sync option](../images/intellij/sync_option.gif) diff --git a/docs/user-guide/intellij-tso-cli.md b/docs/user-guide/intellij-tso-cli.md new file mode 100644 index 0000000000..f8ee9ee980 --- /dev/null +++ b/docs/user-guide/intellij-tso-cli.md @@ -0,0 +1,49 @@ +# Working with TSO console + +The plug-in provides a functionality to work with TSO in a console way directly from the IntelliJ IDEA. With this feature it is possible to enter commands and see their results, open multiple sessions to different z/OS instances, as well as the same z/OS instance, issue a PA1 command to the console in case the attention functionality is needed to be triggered. + +To start working with TSO console, you need to set up a [Connection](./intellij-configure.md#creating-zosmf-connection). After that, the **TSO Sessions** functionality will be allowed to work with. + +## Creating a TSO Session + +To create a TSO Session: +1. Open settings with the wrench button + +![Open settings with wrench button](../images/intellij/tso_sessions_wrench.png) + +2. Go to **TSO Sessions** tab + +![Go to TSO Sessions](../images/intellij/tso_sessions_go_to_sessions.png) + +3. At the **TSO Sessions** tab, click on the **+** button + +![Click add TSO Session](../images/intellij/tso_sessions_add.png) + +4. The **Add TSO Session** dialog will appear. You need to specify a name of the TSO Session in order to be able to create it. Also, you can select a connection to be used together with the session parameters. To setup such things as reconnection timeout and reconnection attempts count, use the **Advanced Parameters** section. Also, you can reset the defaults of the parameters by clicking **Reset Default Values** button. After all the parameters are set up, click **OK** button + +![Fill in parameters, click OK](../images/intellij/tso_sessions_add_dialog.png) + +5. After the actions are done, a new **TSO Session** will be added to the list. Click **Apply** and then **OK** buttons to save the new session + +![TSO Session created](../images/intellij/tso_sessions_created.png) + +## Creating a TSO Console + +After a [**TSO Session**](./intellij-tso-cli.md#creating-a-tso-session) is created, it is possible to create a **TSO Console**. + +To create a **TSO Console**: +1. Click **+** button, select **Zowe TSO Console** + +![Creating TSO Console](../images/intellij/tso_console_create.png) + +2. The **Select TSO Session** dialog will appear. Select the appropriate **TSO Session** to use during a TSO console run, click **OK** button + +![Select TSO Session dialog](../images/intellij/tso_console_dialog.png) + +3. When the **TSO Session** is selected, the **TSO Console** will appear. In there you could see the actual information about the session being used, the welcoming message and the prompt, where it is possible to enter TSO commands. Also there are 2 buttons to manipulate the behavior of the console: + - **Reopen Session (1)** - will reopen the current TSO Console session with the same parameters + - **Cancel Command (PA1) (2)** - will send the **PA1** command to the TSO console in order to issue a cancellation of the previous command (it is blocked when there is nothing to cancel) + +![TSO Console appeared](../images/intellij/tso_console_created_console.png) + +From this point, you are ready to use the **TSO Console** diff --git a/docs/user-guide/intellij-use-cases.md b/docs/user-guide/intellij-use-cases.md new file mode 100644 index 0000000000..40ff7b96fe --- /dev/null +++ b/docs/user-guide/intellij-use-cases.md @@ -0,0 +1,16 @@ +# Use cases + +## What can I do using the plug-in? + +The plug-in provides the ability to work with a mainframe through z/OSMF REST API. It has such functionalities as: +- Working with [z/OS Datasets](./intellij-zos-files.md) and [USS Files](./intellij-uss-files.md): you can create new entities, [copy and move](./intellij-copy-cut.md) them, delete, edit right in the IDE, check and change properties +- Working with [JES jobs](./intellij-jes-explorer.md): you can submit a job, see an output of any job, edit and run JCL right through the JES Explorer, see and change the status of a job +- Working with [TSO](./intellij-tso-cli.md): you can submit any TSO command through the plug-in's TSO Command Line Interface in a console way, see the output of TSO commands + +## Who is the plugin intended for? + +The plug-in is suitable for your needs if you meet one or more of the criteria: +- You are a **System Programmer** and use **COBOL** / **JCL** / **PLI/I**: with the plug-in, you can easily change the source code, situated on a mainframe, right in the IDE's editor, without the risk of exposing your data anywhere, as all the content is stored under and displayed from the secure IntelliJ's storage. With a bunch of available plug-ins, it will provide the most of opportunities to work with your programs, written on mainframe-specific languages +- You are a **System Administrator** / **System Operator**: the plug-in's **TSO CLI** provides the way of interacting with a mainframe the same as the other tools do, extending the User Experience to the highest possible peak +- You are a **QA** / **Test Automation** person: it gives as much possibilities to check the actual content of a mainframe as the most modern technologies do, reducing latencies in any interaction with the components of the system +- You are a **Java** / **Kotlin** / **Scala** developer: IntelliJ IDEA provides native support for **JVM languages**, so it is more suitable for these technologies to develop for a mainframe diff --git a/docs/user-guide/intellij-using.md b/docs/user-guide/intellij-using.md deleted file mode 100644 index 04bed44067..0000000000 --- a/docs/user-guide/intellij-using.md +++ /dev/null @@ -1,179 +0,0 @@ -# Using Zowe IntelliJ plug-in - -Learn how to work with the Zowe IntelliJ plug-in, including working with datasets, USS files, and jobs. - -## Settings - -Before you start to use the plug-in, there are some settings available. First one - synchronization option. - -### Auto-sync option - -It is possible to synchronize the file or dataset you are editing either manually or automatically. The method is controlled by **Enable auto-sync with mainframe** option. When it is checked, you don't need to manually synchronize the file/dataset whilst you are editing it, the IntelliJ platform decides by itself, when and how to synchronize it. The plug-in is using this feature and allows users to avoid additional sync action. In case you want to be sure that you control the process of syncing with the mainframe, or in case you have some limitations for calls to z/OSMF, or for some other reason, you can disable this option and continue with manual synchronization either by button, appearing if there are any changes in the file, or by pressing simultaneously **Ctrl + Shift + S (Cmd + Shift + S for MacOS)**. - -![Auto-sync option](../images/intellij/sync_option.gif) - -### Batch size option - -Mainframe z/OS and USS filesystems could have a lot of datasets/files under a specified mask. Sometimes the loading of datasets/files list could take a lot of time if there are a lot of entries. To eliminate this problem, the plug-in provides the ability to control the amount of items loading at one time. It is called **Batch amount to show per fetch** in **Settings**. By default, it is set to **100** entries. When the list contains more than the specified number, you can load next amount of entries, specified in this option, double-clicking by **load more** item in the **File Explorer** view. - -![Batch size option](../images/intellij/batch_size.gif) - -## Working with Files Working Sets - -To work with z/OS datasets or USS files, you need to [set up a Files Working Set](intellij-working-sets.md#files-working-set). The most of the functions are available under context menu in Files Working Set view. - -Using the plug-in, you will be able to: -- create, rename, view, edit, delete PS, PDS, PDS/e datasets, as well as PDS and PDS/e members -- use feature **Allocate Like** to create a dataset with parameters of another dataset -- use feature **Migrate** for datasets -- submit JCL jobs with **Submit Job** -- create, rename, view, edit, delete USS files and folders -- copy, move z/OS datasets and USS files, both inside the filesystem, and between them, as well as between systems with different IP address - -### Working with z/OS PS datasets - -![Work with PS datasets](../images/intellij/create_edit_rename_delete_ps.gif) - -### Working with z/OS PDS datasets - -![Work with PDS datasets](../images/intellij/pds_create_and_props.gif) - -### "Allocate Like" feature - -To issue the **Allocate Like**, click the right mouse button on any of datasets and select **Allocate Like**. - -!["Allocate Like" feature](../images/intellij/allocate_like.gif) - -### "Submit Job" feature - -To issue the **Submit Job**, click the right mouse button on any of PS datasets or PDS members and select **Submit Job**. - -!["Submit Job" feature](../images/intellij/submit_jcl.gif) - -### Working with USS files - -There is a possibility to work with USS filesystem using the plug-in. Plug-in allows users to create files with a specific set of access rules, edit the file, rename, delete them, copy and move. With the existing ones, it is also possible to change the rules. Also the plug-in allows to change encoding of the file to a desired one, so the content of the file is shown correctly. - -About the encoding: there is two different options for encoding change. One is **Reload** option, which allows users to reload the file with the specified encoding. It means that the file won't be converted to that encoding, and the plug-in just opens it with the specified one. The second option is **Convert**. This option converts the file to the specified encoding, changing it contents. It means that the plug-in will try to change the file bytes if it is possible, and then will display the contents with the changed bytes. - -![Work with USS files](../images/intellij/work_with_uss.gif) - -### Copy/move functionality - -There are some options to copy and move z/OS datasets and members, and USS files. - -**Important note**: the contents of the source files and datasets will stay the same, until you try to copy/move a file from USS to a z/OS partitioned dataset. If the file contents are longer than the specified for the PDS logical record length, then firstly the content will be cut to the specified LRECL, and the rest is going to be on the next lines. - -It is possible to move and copy files and datasets either through keyboard shortcut buttons and context menu, or using drag and drop. - -To move a member from one dataset to another: -1. Right click on the member to be moved -2. Select **Cut** -3. On the target dataset click **Paste** -4. ...or just drag and drop it - -![Move member from one PDS to another](../images/intellij/move_mem_to_ds.gif) - -If a sequential dataset is being moved to PDS, the name will be trimmed to the last element in the HLQ. - -To move a sequential dataset to a partitioned dataset: -1. Right click on the PS to be moved -2. Select **Cut** -3. On the target dataset click **Paste** -4. ...or just drag and drop it - -To copy member from one dataset to another: -1. Right click on the member to be copied -2. Select **Copy** -3. On the target dataset click **Paste** - -![Move PS to PDS and copy member from one PDS to another](../images/intellij/pds_copy_move_ds.gif) - -To move USS file or folder to another USS folder: -1. Right click on the folder or the file to be moved; -2. Select **Cut** -3. On the target folder click **Paste** -4. ...or just drag and drop it - -![Move USS file or folder to another USS folder](../images/intellij/move_uss_folder_to_uss_folder.gif) - -To copy PDS member to USS filesystem: -1. Right click on the member to be copied -2. Select **Copy** -3. On the target folder or the USS filesystem mask click **Paste** - -![Copy member to USS](../images/intellij/copy_mem_to_uss.gif) - -While moving or copying a partitioned dataset to the USS filesystem, it will be converted to a USS folder. All the contents will become USS files. - -To move a PDS to USS filesystem: -1. Right click on the PDS to be copied -2. Select **Cut** -3. On the target folder or the USS filesystem mask click **Paste** -4. ...or just drag and drop it - -![Move PDS to USS](../images/intellij/pds_move_zos_to_uss.gif) - -Also, it is possible to copy/move USS file to PDS dataset. The file will become the PDS member. - -**Be aware**: the file name being copied/moved should be no more than 8 symbols. Also, see [the limitations and rules](#copymove-functionality) for the file being copied - -To move USS file to a PDS: -1. Right click on the file to be copied -2. Select **Cut** -3. On the target PDS click **Paste** -4. ...or just drag and drop it - -![Copy member to USS and USS file to PDS](../images/intellij/move_uss_to_pds.gif) - -### Cross-system copy - -The plug-in makes it possible to move and copy z/OS datasets and USS files between different system. E.g.: a user has two systems, the first - z/OS 2.3, the second - z/OS 2.4. So, it is possible to copy or move files and datasets either from z/OS 2.3 to z/OS 2.4, or vice versa. The rules of copying and moving that are described previously, are also applicable to such kind of action. - -To copy/move element from one system to another: -1. Right click on the element to be copied/moved -2. Select **Copy**/**Cut** -3. On the target system's element click **Paste** - -*(Use drag and drop to move elements faster)* - -![Cross-system operations](../images/intellij/cross_system_copy.gif) - -## Working with JES Working Sets - -To operate with your JCL jobs, ensure you [create a JES Working Set](intellij-working-sets.md#jes-working-set) first, which will hold all the filters for the JES Explorer. - -With the plug-in it is possible to view a status of jobs, view full log of a job run, view and edit jobs' JCLs, submit them right after they are edited, purge them. - -To edit JCL of a job and run it just after it is edited: -1. Right click on a job -2. Select **Edit JCL**, the JCL will appear in the editor -3. Change the JCL as you want -4. Click green button **Submit Job** in the edittor - -After the job is started, a console view will appear. In the console view it is possible to see the full execution log of the job. - -To view the execution log of the job again: -1. Right click on the job -2. Select **View Job** - -Also, it is possible to control the job execution through the console view. - -If you don't need the job anymore: -1. Right click on the job -2. Select **Purge Job** *(**Delete** is the keyboard shortcut)* - -![Working with jobs](../images/intellij/work_with_jes_jobs.gif) - -## TSO Command Line Interface - -Starting from the v1.0.0 of the plug-in, there is a feature to send TSO commands directly from the IntelliJ Platform IDE. - -To start using the TSO Command Line Interface: -1. Click **+** in the Zowe Explorer view -2. Select **TSO Console** -3. In the dialog appeared, type in all the necessary parameters *(the default ones are most likely to fit)*, click **OK** - -After that, the TSO Command Line Interface should appear. You can type in TSO commands, as well as run any possible scripts. - -![TSO CLI](../images/intellij/tso_cli.gif) diff --git a/docs/user-guide/intellij-uss-files.md b/docs/user-guide/intellij-uss-files.md new file mode 100644 index 0000000000..d992dff100 --- /dev/null +++ b/docs/user-guide/intellij-uss-files.md @@ -0,0 +1,89 @@ +# Working with USS Files + +Using the plug-in, you will be able to: +- create, rename, view, edit, delete USS files and folders +- submit JCL jobs with **Submit Job** option +- change the encoding a USS file content is displayed or saved in +- manipulate USS files and folders rights +- copy, move USS files and folders, both inside the filesystem, and between them, as well as between systems with different IP address +- sort USS paths + +After you set up a [Files Working Set](./intellij-working-sets.md#files-working-set) and create a mask to display USS paths, it is possible to manipulate USS files and folders. + +## Basic operations + +The plug-in allows users to work with USS part of a mainframe. As the basic operations, you can create files with a specific set of permits, edit files, rename and delete them. Also, you can submit a job from a USS file if it is a JCL. + +![Work with USS files](../images/intellij/work_with_uss.gif) + +## Working with permissions + +The plug-in allows users to edit permissions of the USS files and folders: +1. Right-click on the file in USS explorer, click **Properties** + +![Click USS properties](../images/intellij/uss_click_properties.png) + +2. In the **File Properties** dialog window, select the **Permissions** tab + +![USS Permissions tab](../images/intellij/uss_properties_possible_changes.png) + +3. In there, you will have three options to change when needed: **Owner permissions (1)**, **Group permissions (2)** and **Permissions for all users (3)**. To change any of the options, click one of them + +![USS permissions open drop-down](../images/intellij/uss_properties_change_owner_perms.png) + +4. From the drop-down list, select a new value + +![USS permissions select from drop-down](../images/intellij/uss_properties_change_owner_perms_select.png) + +5. Click the **OK** button for the changes to be applied + +![USS permissions click OK](../images/intellij/uss_properties_change_owner_perms_ok.png) + +## Working with files encoding + +Sometimes it is necessary to display file content in a specific encoding or save it in some different encoding. To do so: +1. Double-click the USS file to open it in the editor + +![Open USS file in editor](../images/intellij/intellij_open_uss_file.png) + +2. In the **File Properties** dialog window, you should be at the **General** tab. Click the **File encoding** button for the drop-down list to appear + +![USS General tab, click file encoding](../images/intellij/uss_props_general_tab.png) + +3. Select the encoding you want the file content to be in + +![USS select new encoding](../images/intellij/uss_encoding_select_option.png) + +4. After the actions, the encoding change dialog will appear. It will ask you to choose between the 2 options: + - **Reload (1)** - changes the file tag, specifying the encoding to show the file in. This action does not actually rewrite the contents of the file and just changes the way it is displayed in the editor + - **Convert (2)** - tries to convert the file to the specified encoding, actually changing the content of the file. This option will also change the file tag, and after that it will try to modify the content, changing the file bytes to the respective ones to try to display the same content with the actually different bytes + +![USS encoding change dialog](../images/intellij/uss_encoding_dialog.png) + +5. Click the option you want to perform on the file. Sometimes it is not possible to correctly reload or convert the file content to the encoding you select. In this case, the *Warning* icon will appear in the button of an action that is not possible to perform correctly. You will be still able to perform the operation, but the additional warning dialog will appear, describing the issue + +:::warning make sure you know what you are doing +The contents after clicking **Reload anyway** or **Convert anyway** could be unpredictable. Do it only in the cases where you are sure nothing will go wrong. +::: + +![USS encoding warning dialog](../images/intellij/uss_encoding_warning_dialog.png) + +After the operation is finished, the content of the file will be reloaded. If you had some characters that were not visible in the default encoding, and you selected the correct encoding, the content will be displayed regarding the option you've selected. + +## Sort a USS path + +There is a functionality of the plug-in to sort USS files and folders. The plug-in allows to sort not only the root path, but any USS path you have in your working tree. + +To sort USS files and folders list: +1. Right click on a USS path, select **Sort**. The list of sorting options will appear: + - **File Name (1)** - to sort USS entities by name + - **File Type (2)** - to sort USS entities by type + - **File Modification Date (3)** - to sort USS entities by modification date. USS path is sorted by this option by default + +Also, there is a possibility to change the order for the items to be displayed: **Ascending (4)** (by default) or **Descending (5)**. For the example purposes, select **File Name** + +![Sort USS files](../images/intellij/uss_sort.png) + +2. The list will be refreshed with the new sort order + +![Sort USS files result](../images/intellij/uss_sort_result.png) diff --git a/docs/user-guide/intellij-working-sets.md b/docs/user-guide/intellij-working-sets.md index bdaf903860..41d47a87a8 100644 --- a/docs/user-guide/intellij-working-sets.md +++ b/docs/user-guide/intellij-working-sets.md @@ -1,13 +1,18 @@ -# Working Sets Concept +# Working with plug-in's Working Sets -We use term "Working Sets" to describe the place to store sets of masks and filters. These items are stored separately for each working set. The working set is more like "profile" and is used to logically aggregate sets for each separate need (both for users and to separate the different items to categories, in case it is needed). +## The concept + +We use term "Working Sets" to describe the place to store sets of masks and filters. These items are stored separately for each working set. The working set is more like a "profile" *(don't confuse with the "Zowe Profile")* and is used to logically aggregate sets for different separate needs (both for users' convenience and to separate the different items to categories, in case it is needed). There are two types of working sets: -- **Files Working Sets** - are used to store z/OS and USS masks -- **JES Working Sets** - are used to store JCL Job filters +- **Files Working Sets** - are to store z/OS and USS masks +- **JES Working Sets** - are to store JES Job filters + +You can create working sets either through **Settings** or by clicking **+** button and selecting **Working Set** / **JES Working Set** from a dropdown in the plug-in's tab. -You can create working sets either through **Settings** or by clicking on **+** button. -*Note: you can create a working set only when a connection is set up.* +:::note +You can create a working set only when a connection is set up. +::: ## Files Working Set @@ -17,23 +22,23 @@ To create Files working set: 1. Press **+** button 2. Select **Working Set** -3. Type in the Working Set name (it should be unique) and select an appropriate connection -4. Add some masks +3. Type the Working Set's name in the **Working Set Name** field (it should be unique) and select the connection under which to create the Working Set +4. Add some masks to the newly created Working Set. It can be both z/OS Dataset masks or USS Files masks 5. Click **OK** ![Configure IntelliJ files working set](../images/intellij/create_files_working_set.gif) ## JES Working Set -This type of working sets is used to operate with your JCL jobs, see their logs, view and edit JCL with further job run. It will hold all the filters for the JES Explorer. +This type of Working Sets is used to operate with your JES Jobs, see their logs, view and edit JCL and later run it. It holds all the filters for the JES Explorer. -To create JES working set: +To create JES Working Set: -1. Select **JES Explorer** tab +1. Select the **JES Explorer** tab 2. Press **+** button 3. Select **JES Working Set** -4. Type in the Working Set name (it should be unique) and select an appropriate connection -5. Add some JCL filters +4. Type the Working Set's name in the **Working Set Name** field (it should be unique) and select the connection under which to create the Working Set +5. Add some **JCL filters** 6. Click **OK** ![Configure IntelliJ JES working set](../images/intellij/create_jes_working_set.gif) diff --git a/docs/user-guide/intellij-zos-files.md b/docs/user-guide/intellij-zos-files.md new file mode 100644 index 0000000000..b2429507a8 --- /dev/null +++ b/docs/user-guide/intellij-zos-files.md @@ -0,0 +1,86 @@ +# Working with z/OS Datasets + +Using the plug-in, it is possible to: +- create, rename, view, edit, delete PS, PDS, PDS/e datasets, as well as PDS and PDS/e members +- use the feature **Allocate Like** to create a dataset with parameters of the other dataset +- use the feature **Migrate** and **Recall** for archived datasets +- submit JCL jobs with **Submit Job** option +- copy, move z/OS Datasets, both inside the filesystem, and between them, as well as between systems with different IP address +- sort datasets + +After you set up a [Files Working Set](./intellij-working-sets.md#files-working-set) and create a mask to display datasets on the z/OS part, it is possible to manipulate PS, PDS and PDS/E datasets + +## Allocating a dataset + +To allocate a dataset: +1. Right-click on any entity, related to z/OS datasets (it could be **Files Working Set**, **z/OS Datasets mask**, any **other dataset or member**) +2. Select **New** -> **Dataset** + +![New -> Dataset](../images/intellij/plugin_create_dataset.png) + +3. Specify the necessary fields. There are some custom options to help with specifying the dataset parameters: + - **Choose preset (1)** - the option provides the most commonly used dataset presets both for PS and PDS options. Selecting on of the presets will automatically setup all the necessary fields to create the selected type of a dataset (the presets are described more later) + - **Dataset name (2)** - the name of the dataset to be created. It automatically provides the template of the dataset name with the user's HLQ as the starting string and **.\** string that is intended to be changed by the user + - **Dataset organization (3)** - the dataset organization to be used. The options are: **PS (Physical Sequential)**, **PO (Partitioned Organization)** and **PO-E (Partitioned Organization - Extended)** + - **Allocation unit hint (4)** - a small UI improvement hint for better understanding the allocation units and their relative values to each other + +All the other parameters are the same as the z/OS provides to allocate a new dataset. In the **Advanced Parameters** section, there are some additional fields to setup if your prefer to set yourself such things as **Volume**, **Device Type**, **Storage class**, etc. + +![Create dataset dialog](../images/intellij/plugin_create_dataset_fields.png) + +If you want to choose a preset, there are 5 options available for now: + - **Custom Dataset (1)** - all the fields are set by the user + - **Sequential Dataset (2)** - the fields are set to allocate a template PS dataset + - **PDS Dataset (3)** - the fields are set to allocate a template PDS dataset + - **PDS with empty member Dataset (4)** - the fields are set to allocate a template PDS dataset with an empty member inside + - **PDS with sample JCL member Dataset (5)** - the fields are set to allocate a template PDS dataset with a member with a template JCL job inside + +![Dataset presets](../images/intellij/plugin_dataset_presets.png) + +4. After specifying all the necessary fields, click **OK** + +![Click OK for allocating a dataset](../images/intellij/plugin_create_dataset_ok.png) + +5. When the dataset is allocated, the plug-in will suggest creating a mask to display the dataset created under. Click **Add mask (1)** to add the mask and **Skip (2)** to skip the mask creation + +![Add mask or skip](../images/intellij/plugin_create_mask_or_skip.png) + +## Working with z/OS PS datasets + +Here you can see a possible scenario of working with PS datasets + +![Work with PS datasets](../images/intellij/create_edit_rename_delete_ps.gif) + +## Working with z/OS PDS / PDS/E datasets + +Here you can see a possible scenario of working with PDS / PDS/E datasets + +![Work with PDS datasets](../images/intellij/pds_create_and_props.gif) + +## "Allocate Like" feature + +To issue the **Allocate Like**, right-click on any of datasets and select **Allocate Like**. + +!["Allocate Like" feature](../images/intellij/allocate_like.gif) + +## "Submit Job" feature + +To issue the **Submit Job**, right-click on any of PS datasets or PDS / PDS/E members and select **Submit Job**. + +!["Submit Job" feature](../images/intellij/submit_jcl.gif) + +## Sort a datasets mask + +To sort z/OS datasets list: +1. Right click on a datasets mask, select **Sort**. The list of sorting options will appear: + - **Dataset Name (1)** - to sort by dataset names + - **Dataset Type (2)** - to sort by dataset types (PS / PO / PO-E) + - **Dataset Modification Date (3)** - to sort by dataset modification date and time. Datasets list is sorted by this option by default + +Also, there is a possibility to change the order for the items to be displayed: **Ascending (4)** (by default) or **Descending (5)**. For the example purposes, select **Dataset Name** + +![Sort datasets by name](../images/intellij/datasets_sort.png) + +2. The list will be refreshed with the new sort order + +![Sort datasets result](../images/intellij/datasets_sort_result.png) diff --git a/docs/user-guide/providing-feedback-and-contributing-client-side.md b/docs/user-guide/providing-feedback-and-contributing-client-side.md index aaa4c415af..b3d04c2c1a 100644 --- a/docs/user-guide/providing-feedback-and-contributing-client-side.md +++ b/docs/user-guide/providing-feedback-and-contributing-client-side.md @@ -37,15 +37,15 @@ To file an issue: - [Zowe Explorer FTP Extension issue list](https://github.com/zowe/zowe-explorer-vscode/issues) - Add the label `zFTP` to indicate the extension. -## Zowe IntelliJ Plug-in +## Zowe Explorer plug-in for IntelliJ IDEA -### Chatting with the Zowe Zowe IntelliJ Plug-in community +### Chatting with the Zowe Explorer plug-in for IntelliJ IDEA community -Chat with the community on [Slack](https://openmainframeproject.slack.com/archives/C020BGPSU0M). +Chat with the community in [Slack](https://openmainframeproject.slack.com/archives/C020BGPSU0M). -### Filing an issue for Zowe Zowe IntelliJ Plug-in +### Filing an issue for Zowe Explorer plug-in for IntelliJ IDEA -Go to the [Zowe IntelliJ Plug-in issue list](https://github.com/zowe/zowe-explorer-intellij/issues) to file an issue. Include all relevant information. +Go to the [Zowe Explorer plug-in for IntelliJ IDEA issue list](https://github.com/zowe/zowe-explorer-intellij/issues) to file an issue. Include all relevant information. ## Zowe Client SDKs diff --git a/docs/user-guide/sdks-using.md b/docs/user-guide/sdks-using.md index dd08eb9b27..09e6e31466 100644 --- a/docs/user-guide/sdks-using.md +++ b/docs/user-guide/sdks-using.md @@ -31,3 +31,10 @@ For Node SDK usage and syntax examples, refer to the following package Readmes: ### Using Python For information about the Python SDK, including usage and syntax examples, see the [Python SDK ReadTheDocs](https://zowe-client-python-sdk.readthedocs.io/en/latest/). + +### Using Kotlin + +For information about Zowe Client Kotlin SDK, including a setup guide and source code documentation, see the [Zowe Client Kotlin SDK docs](https://zowe.github.io/zowe-client-kotlin-sdk/). + +### Using Java +For information about how to use Zowe Client Java SDK, see [this README.md section](https://github.com/zowe/zowe-client-java-sdk/?tab=readme-ov-file#examples). diff --git a/docs/user-guide/zowe-getting-started-tutorial.md b/docs/user-guide/zowe-getting-started-tutorial.md index 200303db99..4c34eab304 100644 --- a/docs/user-guide/zowe-getting-started-tutorial.md +++ b/docs/user-guide/zowe-getting-started-tutorial.md @@ -11,7 +11,7 @@ Learn how to start using Zowe components, applications, and plug-ins. ## Zowe client-side components - [Using Zowe CLI](cli-using-usingcli.md) -- [Using Zowe Explorer for IntelliJ](intellij-using.md) +- [Using Zowe Explorer plug-in for IntelliJ IDEA](intellij-use-cases.md) - [Using Zowe Explorer for Visual Studio Code](ze-usage.md) - [Using Zowe SDKs](sdks-using.md) diff --git a/docs/whats-new/breaking-changes-v3.md b/docs/whats-new/breaking-changes-v3.md index b4c045eb3c..ce07f2ef17 100644 --- a/docs/whats-new/breaking-changes-v3.md +++ b/docs/whats-new/breaking-changes-v3.md @@ -41,11 +41,11 @@ The current API Gateway contains Authentication and Authorization Services. This * V3 pre-release versions are available via [npm](https://www.npmjs.com/package/@zowe/cli?activeTab=readme) under the 'next' tag -## Explorer for Intellij +## Explorer for IntelliJ IDEA ### Important updates -* Explorer for Intellij will be part of the Zowe Core +* Explorer for IntelliJ IDEA will be part of the Zowe Core * Working with USS Files * Working with Data Sets * Working with JES Working Sets diff --git a/docs/whats-new/zowe-announcements.md b/docs/whats-new/zowe-announcements.md index 523f879b6d..f34f702285 100644 --- a/docs/whats-new/zowe-announcements.md +++ b/docs/whats-new/zowe-announcements.md @@ -13,7 +13,7 @@ Zowe publishes technical preview builds for Version 3 for all components involve The latest versions are downloadable from the [Zowe JFrog Artifactory directory](https://zowe.jfrog.io/zowe/libs-release-local/org/zowe/nightly/v3/). The directory contains PAX and SMP/E packages. The server-side includes the **API Mediation Layer**, **Virtual Desktop**, **ZSS**, and **ZIS**. The build is released nightly. -Client-side components are also available. **Zowe CLI** is available from NPM. The version starts with [8.0.0-next](https://www.npmjs.com/package/@zowe/cli/v/8.0.0-next.202404191414). **Explorer for VS Code** is available from [GitHub releases](https://github.com/zowe/zowe-explorer-vscode/releases). **Explorer for Intellij** is available from the [Intellij Marketplace](https://plugins.jetbrains.com/plugin/18688-zowe-explorer) +Client-side components are also available. **Zowe CLI** is available from NPM. The version starts with [8.0.0-next](https://www.npmjs.com/package/@zowe/cli/v/8.0.0-next.202404191414). **Explorer for VS Code** is available from [GitHub releases](https://github.com/zowe/zowe-explorer-vscode/releases). **Explorer for IntelliJ IDEA** is available from the [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/18688-zowe-explorer) ## Future Zowe Version 2.0 releases diff --git a/sidebars.js b/sidebars.js index 28b5f873ed..edb2adf1ba 100644 --- a/sidebars.js +++ b/sidebars.js @@ -11,7 +11,7 @@ module.exports = { "whats-new/release-notes/v3_0_0", "whats-new/release-notes/v2_17_0", "whats-new/release-notes/v2_16_0", - "whats-new/release-notes/v2_15_0", + "whats-new/release-notes/v2_15_0", "whats-new/release-notes/v2_14_0", "whats-new/release-notes/v2_13_0", "whats-new/release-notes/v2_12_0", @@ -213,7 +213,7 @@ module.exports = { label: "Configuring the Zowe cross memory server (ZIS)", link: {type:"doc", id:"user-guide/configure-xmem-server"}, items: [], - }, + }, { type: "category", label: "Configuring high availability (optional)", @@ -224,7 +224,7 @@ module.exports = { "user-guide/configure-caching-service-ha", ] } - ] + ] }, { type: "category", @@ -313,11 +313,11 @@ module.exports = { }, "user-guide/api-mediation/configuration-customizing-the-api-catalog-ui", "user-guide/api-mediation/configuration-at-tls", - "user-guide/api-mediation/configuration-logging", + "user-guide/api-mediation/configuration-logging", ] - } + } ], - }, + }, { type: "category", label: "Installing Zowe client-side components", @@ -329,8 +329,8 @@ module.exports = { label: "Configuring z/OSMF", link: {type:"doc", id:"user-guide/cli-install-configure-zosmf"}, items: [ - "user-guide/cli-install-configure-zosmf-security", - ], + "user-guide/cli-install-configure-zosmf-security", + ], }, { type: "category", @@ -364,12 +364,12 @@ module.exports = { ], }, ], - }, + }, "user-guide/cli-uninstall", - "user-guide/cli-install-verify-your-installation", + "user-guide/cli-install-verify-your-installation", ], }, - + { type: "category", label: "Zowe Explorer installation", @@ -395,9 +395,10 @@ module.exports = { }, { type: "category", - label: "Zowe IntelliJ Plug-in", - link: {type:"doc", id:"user-guide/intellij-install"}, + label: "Zowe Explorer plug-in for IntelliJ IDEA", items: [ + "user-guide/intellij-install-prereqs", + "user-guide/intellij-install", "user-guide/intellij-configure", ], }, @@ -490,7 +491,7 @@ module.exports = { }, ], }, -], +], "use": [ "user-guide/zowe-getting-started-tutorial", { @@ -575,7 +576,7 @@ module.exports = { "user-guide/api-mediation/api-mediation-update-password", "user-guide/api-mediation/api-mediation-smf", ], - }, + }, ], }, { @@ -645,9 +646,9 @@ module.exports = { "user-guide/cli-mqplugin", "user-guide/cli-idfplugin", ], - }, + }, ], - }, + }, { type: "category", label: "Using Zowe Explorer", @@ -687,21 +688,27 @@ module.exports = { }, { type: "category", - label: "Using Zowe IntelliJ Plug-in", - link: {type:"doc", id:"user-guide/intellij-using"}, + label: "Using Zowe Explorer plug-in for IntelliJ IDEA", items: [ + "user-guide/intellij-use-cases", + "user-guide/intellij-settings", "user-guide/intellij-working-sets", + "user-guide/intellij-zos-files", + "user-guide/intellij-uss-files", + "user-guide/intellij-copy-cut", + "user-guide/intellij-jes-explorer", + "user-guide/intellij-tso-cli", ], }, "user-guide/sdks-using", "user-guide/zowe-chat/chat_use_interact_methods", - "user-guide/providing-feedback-and-contributing-client-side", + "user-guide/providing-feedback-and-contributing-client-side", ], }, ], "extending": [ "extend/extend-zowe-overview", - "extend/zowe-conformance-program", + "extend/zowe-conformance-program", { type: "category", label: "Developing server-side components", @@ -750,7 +757,7 @@ module.exports = { "extend/extend-apiml/onboard-micronaut-enabler", "extend/extend-apiml/onboard-nodejs-enabler", "extend/extend-apiml/onboard-static-definition", - "extend/extend-apiml/custom-metadata", + "extend/extend-apiml/custom-metadata", ] }, { @@ -776,7 +783,7 @@ module.exports = { label: "Zowe API Mediation Layer Security", items: [ "extend/extend-apiml/api-medation-sso-integration-extenders", - "extend/extend-apiml/zaas-client", + "extend/extend-apiml/zaas-client", ], }, ], @@ -802,7 +809,7 @@ module.exports = { "extend/extend-desktop/mvd-logutility", "extend/extend-desktop/mvd-conda", ], - }, + }, ], }, { @@ -831,12 +838,12 @@ module.exports = { "extend/extend-cli/cli-creating-plug-in-lifecycle-actions", ], }, - + "extend/extend-ze/ze-extensions", "getting-started/user-roadmap-client-sdk", - "extend/extend-sdks", + "extend/extend-sdks", ], - }, + }, ], "troubleshooting": [ { @@ -928,10 +935,10 @@ module.exports = { "troubleshoot/ze/ze-issues", ], }, - "troubleshoot/troubleshoot-intellij", - "troubleshoot/zowe-chat-troubleshoot/troubleshooting", + "troubleshoot/troubleshoot-intellij", + "troubleshoot/zowe-chat-troubleshoot/troubleshooting", ], - } + } ], "contributing": [ "contribute/roadmap-contribute", @@ -960,7 +967,7 @@ module.exports = { "contribute/contributing", ], "reference": [ - "appendix/server-component-manifest", + "appendix/server-component-manifest", "appendix/zowe-api-reference", { type: "category", @@ -1054,7 +1061,7 @@ module.exports = { ] }, "appendix/zowe-cli-command-reference", - "appendix/zowe-yaml-configuration", + "appendix/zowe-yaml-configuration", { type: "category", label: "ZWE Server Command Reference", @@ -1066,7 +1073,7 @@ module.exports = { } ] }, - "appendix/bill-of-materials", + "appendix/bill-of-materials", { type: "link", label: "Third Party Software Requirements",