From 0c994aad69ef1d44a9047d4e6f533f6ec35f632c Mon Sep 17 00:00:00 2001 From: anaxceron Date: Tue, 23 Jan 2024 16:17:12 -0500 Subject: [PATCH 1/7] adding link for remote usage info; split content Signed-off-by: anaxceron --- docs/user-guide/ze-cics-usage-tips.md | 9 +++++++ docs/user-guide/ze-usage-tips.md | 30 ++++++++++++++++++---- docs/user-guide/ze-usage.md | 36 ++++++--------------------- 3 files changed, 42 insertions(+), 33 deletions(-) create mode 100644 docs/user-guide/ze-cics-usage-tips.md diff --git a/docs/user-guide/ze-cics-usage-tips.md b/docs/user-guide/ze-cics-usage-tips.md new file mode 100644 index 0000000000..79000a0dd9 --- /dev/null +++ b/docs/user-guide/ze-cics-usage-tips.md @@ -0,0 +1,9 @@ +# Usage tips + +The following tips can help you perform tasks more efficiently when working with the CICS extension: + +- All menu action commands available by right-clicking a profile or resource (excluding **Show Attributes**) can be applied to multiple items. To do this, select the multiple nodes of the same type before right-clicking and selecting the command. + +- To select multiple nodes, you can hold Ctrl/Cmd key while clicking resources. Or you can select the first item in a list of nodes then hold Shift and click both the last item to select a consecutive list of nodes. + +- Click the refresh icon at the top of the CICS view to reload the resources in every region. diff --git a/docs/user-guide/ze-usage-tips.md b/docs/user-guide/ze-usage-tips.md index 79000a0dd9..5344a07137 100644 --- a/docs/user-guide/ze-usage-tips.md +++ b/docs/user-guide/ze-usage-tips.md @@ -1,9 +1,29 @@ -# Usage tips +# Usage Tips -The following tips can help you perform tasks more efficiently when working with the CICS extension: +Make the best use of Zowe Explorer with the following tips. -- All menu action commands available by right-clicking a profile or resource (excluding **Show Attributes**) can be applied to multiple items. To do this, select the multiple nodes of the same type before right-clicking and selecting the command. +## Data sets, USS, and jobs persistence settings +You can store any data sets, USS files, or jobs permanently in the **Favorites** tab. Right-click on a data set, USS file, or job and click **Add Favorite**. -- To select multiple nodes, you can hold Ctrl/Cmd key while clicking resources. Or you can select the first item in a list of nodes then hold Shift and click both the last item to select a consecutive list of nodes. +## Identify syntax errors with a syntax highlighter +Zowe Explorer supports a syntax highlighter for data sets. To enhance the experience of using the extension, you can download an extension that highlights syntax. -- Click the refresh icon at the top of the CICS view to reload the resources in every region. +## Configure the detected language of a file or data set + +You can configure Visual Studio Code to use a specific language for a particular file extension type. This prevents the language for a file or data set opened in Zowe Explorer to be detected incorrectly. To set file associations, see [Add a file extension to a language](https://code.visualstudio.com/docs/languages/overview#_add-a-file-extension-to-a-language). + +## Edit a profile +You can edit existing profiles listed in the **Side Bar** by clicking the profile's **Edit** icon (next to the **Search** icon). The feature lets you modify the information inside your profile. + +## Delete a profile +In Zowe V1, you can permanently delete profiles by right-clicking the profile and selecting the **Delete Profile** option. The feature deletes the profile from your `.zowe` folder. In Zowe V2, right-click the profile, and select **Delete Profile** to open the configuration file and manually delete the profile. + +:::tip +Alternatively, you can delete a profile by using the VS Code **Command Palette**. Press `F1` on your keyboard, then select the **Zowe Explorer: Delete a Profile Permanently** option. In Zowe V1, you select the profile to delete. In Zowe V2, the configuration file opens for you to delete the profile manually. +::: + +## Hide a profile +You can hide a profile from the **Side Bar** by right-clicking the profile and selecting the **Hide Profile** option. If necessary, add the profile back by clicking the **+** icon on the **DATA SETS**, **UNIX SYSTEM SERVICES (USS)**, or **JOBS** bar. + +## Open recent members +Zowe Explorer lets you open a list of members you have previously worked on. You can access the list by pressing `Ctrl`+`Alt`+`R` or `Command`+`Alt`+`R`. diff --git a/docs/user-guide/ze-usage.md b/docs/user-guide/ze-usage.md index 16a2ed78a5..5c4a73be6f 100644 --- a/docs/user-guide/ze-usage.md +++ b/docs/user-guide/ze-usage.md @@ -13,44 +13,24 @@ Review this section to familiarize yourself with Zowe Explorer and make the best - [Ubuntu](https://ubuntu.com/) 20.04+ - Windows 10+ -### Integrated development environments: +### Integrated development environments: - [VS Code](https://code.visualstudio.com/) 1.53.2+ - [Eclipse Che](https://www.eclipse.org/che/) - [Red Hat CodeReady Workspaces](https://www.redhat.com/en/technologies/jboss-middleware/codeready-workspaces) - [Theia](https://theia-ide.org/) 1.18+ - **Note:** Zowe Explorer is compatible with Theia 1.18.0 or higher. However, we recommend using a [Theia community release](https://theia-ide.org/releases/) as Zowe Explorer could experience possible unexpected behaviors with the latest Theia releases. + :::note + + Zowe Explorer is compatible with Theia 1.18.0 or higher. However, we recommend using a [Theia community release](https://theia-ide.org/releases/) as Zowe Explorer could experience possible unexpected behaviors with the latest Theia releases. -## Usage Tips + ::: -Make the best use of Zowe Explorer with the following tips: +## Using Zowe Explorer in remove environments -### Data sets, USS, and jobs persistence settings -You can store any data sets, USS files, or jobs permanently in the **Favorites** tab. Right-click on a data set, USS file, or job and click **Add Favorite**. +As of Zowe Version 2.11, Zowe Explorer and the Zowe Explorer API no longer use `node-keytar`, which was used to manage mainframe credentials. This change might cause some users issues when trying to interact with remote environments. -### Identify syntax errors with a syntax highlighter -Zowe Explorer supports a syntax highlighter for data sets. To enhance the experience of using the extension, you can download an extension that highlights syntax. - -### Configure the detected language of a file or data set - -You can configure Visual Studio Code to use a specific language for a particular file extension type. This prevents the language for a file or data set opened in Zowe Explorer to be detected incorrectly. To set file associations, see [Add a file extension to a language](https://code.visualstudio.com/docs/languages/overview#_add-a-file-extension-to-a-language). - -### Edit a profile -You can edit existing profiles listed in the **Side Bar** by clicking the profile's **Edit** icon (next to the **Search** icon). The feature lets you modify the information inside your profile. - -### Delete a profile -In Zowe V1, you can permanently delete profiles by right-clicking the profile and selecting the **Delete Profile** option. The feature deletes the profile from your `.zowe` folder. In Zowe V2, right-click the profile, and select **Delete Profile** to open the configuration file and manually delete the profile. - -:::tip -Alternatively, you can delete a profile by using the VS Code **Command Palette**. Press `F1` on your keyboard, then select the **Zowe Explorer: Delete a Profile Permanently** option. In Zowe V1, you select the profile to delete. In Zowe V2, the configuration file opens for you to delete the profile manually. -::: - -### Hide a profile -You can hide a profile from the **Side Bar** by right-clicking the profile and selecting the **Hide Profile** option. If necessary, add the profile back by clicking the **+** icon on the **DATA SETS**, **UNIX SYSTEM SERVICES (USS)**, or **JOBS** bar. - -### Open recent members -Zowe Explorer lets you open a list of members you have previously worked on. You can access the list by pressing `Ctrl`+`Alt`+`R` or `Command`+`Alt`+`R`. +See [Usage in Remote Environments](https://github.com/zowe/vscode-extension-for-zowe/wiki/Usage-in-Remote-Environments) to learn more about how to resolve credential errors. ## Using a specific version of Zowe Explorer From 3435921e93a22e38db08dbbd71223c9b8a26c717 Mon Sep 17 00:00:00 2001 From: anaxceron Date: Tue, 23 Jan 2024 16:21:22 -0500 Subject: [PATCH 2/7] minor style edit Signed-off-by: anaxceron --- docs/user-guide/ze-usage-tips.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-guide/ze-usage-tips.md b/docs/user-guide/ze-usage-tips.md index 5344a07137..b5bc659ee5 100644 --- a/docs/user-guide/ze-usage-tips.md +++ b/docs/user-guide/ze-usage-tips.md @@ -1,4 +1,4 @@ -# Usage Tips +# Usage tips Make the best use of Zowe Explorer with the following tips. From b7340cd5b90ad6c9f181ca960d7d0200b07e47af Mon Sep 17 00:00:00 2001 From: anaxceron Date: Tue, 23 Jan 2024 16:24:19 -0500 Subject: [PATCH 3/7] fixing note syntax Signed-off-by: anaxceron --- docs/user-guide/ze-usage.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/user-guide/ze-usage.md b/docs/user-guide/ze-usage.md index 5c4a73be6f..30242c702f 100644 --- a/docs/user-guide/ze-usage.md +++ b/docs/user-guide/ze-usage.md @@ -20,11 +20,11 @@ Review this section to familiarize yourself with Zowe Explorer and make the best - [Red Hat CodeReady Workspaces](https://www.redhat.com/en/technologies/jboss-middleware/codeready-workspaces) - [Theia](https://theia-ide.org/) 1.18+ - :::note +:::note - Zowe Explorer is compatible with Theia 1.18.0 or higher. However, we recommend using a [Theia community release](https://theia-ide.org/releases/) as Zowe Explorer could experience possible unexpected behaviors with the latest Theia releases. +Zowe Explorer is compatible with Theia 1.18.0 or higher. However, we recommend using a [Theia community release](https://theia-ide.org/releases/) as Zowe Explorer could experience possible unexpected behaviors with the latest Theia releases. - ::: +::: ## Using Zowe Explorer in remove environments From db2ad894f5ff2ffff643aaf88d3374c17f0845f5 Mon Sep 17 00:00:00 2001 From: anaxceron Date: Tue, 23 Jan 2024 16:26:26 -0500 Subject: [PATCH 4/7] updating sidebar Signed-off-by: anaxceron --- sidebars.js | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/sidebars.js b/sidebars.js index d3533f0aa8..1ecd959d46 100644 --- a/sidebars.js +++ b/sidebars.js @@ -560,6 +560,7 @@ module.exports = { label: "Using Zowe Explorer", link: {type:"doc", id:"user-guide/ze-usage"}, items: [ + "user-guide/ze-usage-tips", "user-guide/ze-working-with-data-sets", "user-guide/ze-working-with-uss-files", "user-guide/ze-working-with-jobs", @@ -576,7 +577,7 @@ module.exports = { "user-guide/ze-create-zowe-explorer-cics-ext-profiles", "user-guide/ze-use-cics-resources", "user-guide/ze-override-tls-certs", - "user-guide/ze-usage-tips", + "user-guide/ze-cics-usage-tips", "user-guide/ze-provide-feedback-contribute", ], }, From 2b1d83b487361e174e93da47f40dd5c7fa6e3daf Mon Sep 17 00:00:00 2001 From: anaxceron Date: Wed, 24 Jan 2024 14:35:37 -0500 Subject: [PATCH 5/7] addressing Scott's feedback Signed-off-by: anaxceron --- docs/user-guide/ze-cics-usage-tips.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/user-guide/ze-cics-usage-tips.md b/docs/user-guide/ze-cics-usage-tips.md index 79000a0dd9..a67ec00b69 100644 --- a/docs/user-guide/ze-cics-usage-tips.md +++ b/docs/user-guide/ze-cics-usage-tips.md @@ -2,8 +2,8 @@ The following tips can help you perform tasks more efficiently when working with the CICS extension: -- All menu action commands available by right-clicking a profile or resource (excluding **Show Attributes**) can be applied to multiple items. To do this, select the multiple nodes of the same type before right-clicking and selecting the command. +- All menu action commands available when right-clicking a profile or resource (excluding **Show Attributes**) can be applied to multiple items. To do this, select the multiple nodes of the same type before right-clicking and selecting the command. -- To select multiple nodes, you can hold Ctrl/Cmd key while clicking resources. Or you can select the first item in a list of nodes then hold Shift and click both the last item to select a consecutive list of nodes. +- To select multiple nodes, you can hold `Ctrl` + `Cmd` key while clicking on the resources. You can also select multiple consecutive nodes by selecting the first item in a list of nodes and then holding the `Shift` key while selecting the last item in the list. - Click the refresh icon at the top of the CICS view to reload the resources in every region. From 79731088b99338c17ce05b2ebe8ce7dd7058b1d7 Mon Sep 17 00:00:00 2001 From: anaxceron Date: Wed, 24 Jan 2024 14:41:47 -0500 Subject: [PATCH 6/7] removing extra space Signed-off-by: anaxceron --- docs/user-guide/ze-usage-tips.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-guide/ze-usage-tips.md b/docs/user-guide/ze-usage-tips.md index b5bc659ee5..8cf4d77918 100644 --- a/docs/user-guide/ze-usage-tips.md +++ b/docs/user-guide/ze-usage-tips.md @@ -19,7 +19,7 @@ You can edit existing profiles listed in the **Side Bar** by clicking the profil In Zowe V1, you can permanently delete profiles by right-clicking the profile and selecting the **Delete Profile** option. The feature deletes the profile from your `.zowe` folder. In Zowe V2, right-click the profile, and select **Delete Profile** to open the configuration file and manually delete the profile. :::tip -Alternatively, you can delete a profile by using the VS Code **Command Palette**. Press `F1` on your keyboard, then select the **Zowe Explorer: Delete a Profile Permanently** option. In Zowe V1, you select the profile to delete. In Zowe V2, the configuration file opens for you to delete the profile manually. +Alternatively, you can delete a profile by using the VS Code **Command Palette**. Press `F1` on your keyboard, then select the **Zowe Explorer: Delete a Profile Permanently** option. In Zowe V1, you select the profile to delete. In Zowe V2, the configuration file opens for you to delete the profile manually. ::: ## Hide a profile From abaef02438dd439afa167f2b223e2e1629fa03c5 Mon Sep 17 00:00:00 2001 From: anaxceron Date: Thu, 25 Jan 2024 11:45:28 -0500 Subject: [PATCH 7/7] address Adam feedback Signed-off-by: anaxceron --- docs/user-guide/ze-cics-usage-tips.md | 2 +- docs/user-guide/ze-usage-tips.md | 2 +- docs/user-guide/ze-usage.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/user-guide/ze-cics-usage-tips.md b/docs/user-guide/ze-cics-usage-tips.md index a67ec00b69..8331a73327 100644 --- a/docs/user-guide/ze-cics-usage-tips.md +++ b/docs/user-guide/ze-cics-usage-tips.md @@ -4,6 +4,6 @@ The following tips can help you perform tasks more efficiently when working with - All menu action commands available when right-clicking a profile or resource (excluding **Show Attributes**) can be applied to multiple items. To do this, select the multiple nodes of the same type before right-clicking and selecting the command. -- To select multiple nodes, you can hold `Ctrl` + `Cmd` key while clicking on the resources. You can also select multiple consecutive nodes by selecting the first item in a list of nodes and then holding the `Shift` key while selecting the last item in the list. +- To select multiple nodes, you can hold `Ctrl` or `Cmd` key while clicking on the resources. You can also select multiple consecutive nodes by selecting the first item in a list of nodes and then holding the `Shift` key while selecting the last item in the list. - Click the refresh icon at the top of the CICS view to reload the resources in every region. diff --git a/docs/user-guide/ze-usage-tips.md b/docs/user-guide/ze-usage-tips.md index 8cf4d77918..49ab53a35e 100644 --- a/docs/user-guide/ze-usage-tips.md +++ b/docs/user-guide/ze-usage-tips.md @@ -26,4 +26,4 @@ Alternatively, you can delete a profile by using the VS Code **Command Palette** You can hide a profile from the **Side Bar** by right-clicking the profile and selecting the **Hide Profile** option. If necessary, add the profile back by clicking the **+** icon on the **DATA SETS**, **UNIX SYSTEM SERVICES (USS)**, or **JOBS** bar. ## Open recent members -Zowe Explorer lets you open a list of members you have previously worked on. You can access the list by pressing `Ctrl`+`Alt`+`R` or `Command`+`Alt`+`R`. +Zowe Explorer lets you open a list of members you have previously worked on. You can access the list by pressing `Ctrl`+`Alt`+`R` or `Command`+`Option`+`R`. diff --git a/docs/user-guide/ze-usage.md b/docs/user-guide/ze-usage.md index 30242c702f..8658342972 100644 --- a/docs/user-guide/ze-usage.md +++ b/docs/user-guide/ze-usage.md @@ -26,7 +26,7 @@ Zowe Explorer is compatible with Theia 1.18.0 or higher. However, we recommend u ::: -## Using Zowe Explorer in remove environments +## Using Zowe Explorer in remote environments As of Zowe Version 2.11, Zowe Explorer and the Zowe Explorer API no longer use `node-keytar`, which was used to manage mainframe credentials. This change might cause some users issues when trying to interact with remote environments.