From d96ca1b43ec58b792a9a38970422742d2456fb58 Mon Sep 17 00:00:00 2001 From: anaxceron Date: Mon, 14 Nov 2022 16:28:50 -0500 Subject: [PATCH 1/3] Secure Cred Enabled setting; minor edits Signed-off-by: anaxceron --- docs/user-guide/ze-install.md | 94 +++++++++++++++++++++++------------ 1 file changed, 61 insertions(+), 33 deletions(-) diff --git a/docs/user-guide/ze-install.md b/docs/user-guide/ze-install.md index 1f01651e14..f8ee4b34b3 100644 --- a/docs/user-guide/ze-install.md +++ b/docs/user-guide/ze-install.md @@ -3,11 +3,13 @@ codecov slack -The Zowe Explorer extension for Visual Studio Code (VS Code) modernizes the way developers and system administrators interact with z/OS mainframes, and lets you interact with data sets, USS files and jobs. Install the extension directly to [VSCode](https://code.visualstudio.com/) to enable the extension within the GUI. Working with data sets and USS files from VSCode can be more convenient than using 3270 emulators, and complements your Zowe CLI experience. The extension provides the following benefits: +The Zowe Explorer extension for Visual Studio Code (VS Code) modernizes the way developers and system administrators interact with z/OS mainframes, and lets you interact with data sets, USS files, and jobs. + +Install the extension directly to [VSCode](https://code.visualstudio.com/) to enable the extension within the GUI. Working with data sets and USS files from VSCode can be more convenient than using 3270 emulators, and complements your Zowe CLI experience. The extension provides the following benefits: * Enables you to create, modify, rename, copy, and upload data sets directly to a z/OS mainframe. * Enables you to create, modify, rename, and upload USS files directly to a z/OS mainframe. -* Provides a more streamlined way to access data sets, USS files and jobs. +* Provides a more streamlined way to access data sets, USS files, and jobs. * Lets you create, edit, and delete Zowe CLI `zosmf` compatible profiles. * Lets you use the Secure Credential Store plug-in to store your credentials securely in the settings. @@ -19,30 +21,30 @@ Ensure that you meet the following prerequisites before you use the extension: * Get access to z/OSMF. * Install [Node.js](https://nodejs.org/en/download/) v8.0 or later. -* Install [VSCode](https://code.visualstudio.com/). +* Install [Visual Studio Code](https://code.visualstudio.com/). * Configure TSO/E address space services, z/OS data set, file REST interface, and z/OS jobs REST interface. For more information, see [z/OS Requirements](https://docs.zowe.org/stable/user-guide/systemrequirements-zosmf#z-os-requirements). -* Create one Zowe CLI `zosmf` profile so that the extension can communicate with the mainframe. +* Create a Zowe CLI `zosmf` profile so that the extension can communicate with the mainframe. ### Profile notes: - - You can use your existing Zowe CLI `zosmf` profiles that are created with the Zowe CLI v.2.0.0 or later. + - Use existing Zowe CLI `zosmf` profiles created with Zowe CLI v.2.0.0 or later. - - Zowe CLI `zosmf` profiles that are created in Zowe Explorer can be interchangeably used in the Zowe CLI. + - Zowe CLI `zosmf` profiles that are created in Zowe Explorer can be interchangeably used in Zowe CLI. - - *Optionally*, you can continue using Zowe CLI V1 profiles with Zowe Explorer. For more information, see ***instert link here***. + - *Optionally*, you can continue using Zowe CLI V1 profiles with Zowe Explorer. For more information, see [Working with Zowe Explorer profiles](https://docs.zowe.org/stable/user-guide/ze-profiles#working-with-zowe-explorer-profiles). -## Installing +## Installing Zowe Explorer Use the following steps to install Zowe Explorer: 1. Address [the software requirements](#software-requirements). -2. Open VSCode, and navigate to the **Extensions** tab on the left-hand side of the UI. -3. Type **Zowe Explorer** in the search field. +2. Open Visual Studio Code, and navigate to the **Extensions** tab on the **Activity Bar**. +3. Type `Zowe Explorer` in the **Search** field. - Zowe Explorer appears in the list of extensions in the left-hand panel. + Zowe Explorer appears in the list of extensions in the **Side Bar**. 4. Click the green **Install** button to install the extension. -5. Restart VSCode. +5. Restart Visual Studio Code. The extension is now installed and available for use. @@ -54,40 +56,66 @@ You can also watch the following videos to learn how to get started with Zowe Ex -## Configuration +## Configuring Zowe Explorer -Configure Zowe Explorer in the settings file of the extension. To access the extension settings, navigate to **Manage (the gear icon)** > **Settings**, then select **Extensions** > **Zowe Explorer Settings**. For example, you can modify the following settings: +Configure Zowe Explorer in the settings file of the extension. -* **Data set creation settings:** You can change the default creation settings for various data set types. +To access the extension settings, follow these steps: -**Follow these steps:** +1. Click the **Settings** icon at the bottom of the **Activity Bar**. +2. Select the **Settings** option. +3. Open the **Extension** option listed in the **Commonly Used** menu. +4. Select **Zowe Explorer** to access its settings. +5. Scroll the list to find the setting that needs modification. -1. Click the **Edit in settings.json** button under the Data Set, USS or JOBS settings that you want to edit. -2. Edit the settings as needed. -3. Save the settings. +### Modifying creation settings for data sets, USS files, and jobs -Configure Zowe settings +Follow these steps: -* **Set the Temporary Folder Location:** You can change the default folder location where temporary files are stored. +1. In Zowe Explorer settings, scroll to a data set, USS file, or job setting type. +2. Click the setting's corresponding **Edit in settings.json** link. - **Follow these steps:** + This opens the `settings.json` file in an **Editor** tab. - 1. Click the **Edit in settings.json** button under the Data Set, USS or JOBS settings that you want to edit. - 2. Modify the following definition: +3. Edit the settings in the file as needed. +4. Save the file to keep changes. - ```json - "Zowe-Temp-Folder-Location": { - "folderPath": "/path/to/directory" - } - ``` + ![Configure Zowe settings](../images/ze/ZE-Configuration.gif) - where **/path/to/directory** is the folder location that you specify. - - 3. Save the settings. +### Modifying temporary file location settings + +Change the default folder location where temporary files are stored with the following steps: + + 1. Navigate to Zowe Explorer settings. + 2. Under the data set, USS, or jobs settings that you want to edit, click the **Edit in settings.json** link. + 3. Modify the following definition in the file: + + ```json + "Zowe-Temp-Folder-Location": { + "folderPath": "/path/to/directory" + } + ``` + + Replace **/path/to/directory** with the new folder location. + + + 3. Save the file to keep the change. + +### Modifying the `Secure Credentials Enabled` setting + +When environment conditions do not support Visual Studio Code security handling, change the `Secure Credentials Enabled` setting with the following steps: + + 1. Navigate to Zowe Explorer settings. + 2. Scroll to **Security: Secure Credentials Enabled**. + 3. Deselect the checkbox to disable secure credentials. + + When disabled, if the `autoStore` setting in the `zowe.config.json` file is set to *true*, z/OS credentials are stored as text in the file. + + If the `autoStore` setting is set to *false*, you are prompted for the missing credentials in Visual Studio Code. These are stored and used for the duration of the session. ## Relevant Information -In this section you can find useful links and other relevant to Zowe Explorer information that can improve your experience with the extension. +In this section you can find useful links and other information relevant to Zowe Explorer that can improve your experience with the extension. * For information about how to develop for Eclipse Theia, see [Theia README](https://github.com/zowe/vscode-extension-for-zowe/blob/main/docs/README-Theia.md). * For information about how to create a VSCode extension for Zowe Explorer, see [VSCode extensions for Zowe Explorer](https://github.com/zowe/vscode-extension-for-zowe/blob/main/docs/README-Extending.md). From 3724864f4f92745a109ae7d72d73bbafbd70c8cd Mon Sep 17 00:00:00 2001 From: anaxceron Date: Wed, 16 Nov 2022 11:43:00 -0500 Subject: [PATCH 2/3] Removed last bullet from first bullet list Signed-off-by: anaxceron --- docs/user-guide/ze-install.md | 33 +++++++++++++++++---------------- 1 file changed, 17 insertions(+), 16 deletions(-) diff --git a/docs/user-guide/ze-install.md b/docs/user-guide/ze-install.md index f8ee4b34b3..4fd74eb9bd 100644 --- a/docs/user-guide/ze-install.md +++ b/docs/user-guide/ze-install.md @@ -7,11 +7,10 @@ The Zowe Explorer extension for Visual Studio Code (VS Code) modernizes the way Install the extension directly to [VSCode](https://code.visualstudio.com/) to enable the extension within the GUI. Working with data sets and USS files from VSCode can be more convenient than using 3270 emulators, and complements your Zowe CLI experience. The extension provides the following benefits: -* Enables you to create, modify, rename, copy, and upload data sets directly to a z/OS mainframe. -* Enables you to create, modify, rename, and upload USS files directly to a z/OS mainframe. -* Provides a more streamlined way to access data sets, USS files, and jobs. -* Lets you create, edit, and delete Zowe CLI `zosmf` compatible profiles. -* Lets you use the Secure Credential Store plug-in to store your credentials securely in the settings. +- Enables you to create, modify, rename, copy, and upload data sets directly to a z/OS mainframe. +- Enables you to create, modify, rename, and upload USS files directly to a z/OS mainframe. +- Provides a more streamlined way to access data sets, USS files, and jobs. +- Lets you create, edit, and delete Zowe CLI `zosmf` compatible profiles. **Note:** Zowe Explorer is a subcomponent of [Zowe](https://zowe.org/home/). The extension demonstrates the potential for plug-ins powered by Zowe. @@ -19,19 +18,19 @@ Install the extension directly to [VSCode](https://code.visualstudio.com/) to en Ensure that you meet the following prerequisites before you use the extension: -* Get access to z/OSMF. -* Install [Node.js](https://nodejs.org/en/download/) v8.0 or later. -* Install [Visual Studio Code](https://code.visualstudio.com/). -* Configure TSO/E address space services, z/OS data set, file REST interface, and z/OS jobs REST interface. For more information, see [z/OS Requirements](https://docs.zowe.org/stable/user-guide/systemrequirements-zosmf#z-os-requirements). -* Create a Zowe CLI `zosmf` profile so that the extension can communicate with the mainframe. +- Get access to z/OSMF. +- Install [Node.js](https://nodejs.org/en/download/) v8.0 or later. +- Install [Visual Studio Code](https://code.visualstudio.com/). +- Configure TSO/E address space services, z/OS data set, file REST interface, and z/OS jobs REST interface. For more information, see [z/OS Requirements](https://docs.zowe.org/stable/user-guide/systemrequirements-zosmf#z-os-requirements). +- Create a Zowe CLI `zosmf` profile so that the extension can communicate with the mainframe. ### Profile notes: - - Use existing Zowe CLI `zosmf` profiles created with Zowe CLI v.2.0.0 or later. +- Use existing Zowe CLI `zosmf` profiles created with Zowe CLI v.2.0.0 or later. - - Zowe CLI `zosmf` profiles that are created in Zowe Explorer can be interchangeably used in Zowe CLI. +- Zowe CLI `zosmf` profiles that are created in Zowe Explorer can be interchangeably used in Zowe CLI. - - *Optionally*, you can continue using Zowe CLI V1 profiles with Zowe Explorer. For more information, see [Working with Zowe Explorer profiles](https://docs.zowe.org/stable/user-guide/ze-profiles#working-with-zowe-explorer-profiles). +- *Optionally*, you can continue using Zowe CLI V1 profiles with Zowe Explorer. For more information, see [Working with Zowe Explorer profiles](https://docs.zowe.org/stable/user-guide/ze-profiles#working-with-zowe-explorer-profiles). ## Installing Zowe Explorer @@ -63,6 +62,7 @@ Configure Zowe Explorer in the settings file of the extension. To access the extension settings, follow these steps: 1. Click the **Settings** icon at the bottom of the **Activity Bar**. + 2. Select the **Settings** option. 3. Open the **Extension** option listed in the **Commonly Used** menu. 4. Select **Zowe Explorer** to access its settings. @@ -117,6 +117,7 @@ When environment conditions do not support Visual Studio Code security handling, In this section you can find useful links and other information relevant to Zowe Explorer that can improve your experience with the extension. -* For information about how to develop for Eclipse Theia, see [Theia README](https://github.com/zowe/vscode-extension-for-zowe/blob/main/docs/README-Theia.md). -* For information about how to create a VSCode extension for Zowe Explorer, see [VSCode extensions for Zowe Explorer](https://github.com/zowe/vscode-extension-for-zowe/blob/main/docs/README-Extending.md). -* Visit the **#zowe-explorer** channel on [Slack](https://openmainframeproject.slack.com/) for questions and general guidance. +- For information about how to develop for Eclipse Theia, see [Theia README](https://github.com/zowe/vscode-extension-for-zowe/blob/main/docs/README-Theia.md). +- For information about how to create a VSCode extension for Zowe Explorer, see [VSCode extensions for Zowe Explorer](https://github.com/zowe/vscode-extension-for-zowe/blob/main/docs/README-Extending.md). + +- Visit the **#zowe-explorer** channel on [Slack](https://openmainframeproject.slack.com/) for questions and general guidance. From 82c1ffda5f61c6ca2d0b42ef8e9bf00943fa3d77 Mon Sep 17 00:00:00 2001 From: anaxceron Date: Thu, 17 Nov 2022 14:42:00 -0500 Subject: [PATCH 3/3] updates per Billie's feedback Signed-off-by: anaxceron --- docs/user-guide/ze-install.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-guide/ze-install.md b/docs/user-guide/ze-install.md index 4fd74eb9bd..63f4d6393a 100644 --- a/docs/user-guide/ze-install.md +++ b/docs/user-guide/ze-install.md @@ -103,7 +103,7 @@ Change the default folder location where temporary files are stored with the fol ### Modifying the `Secure Credentials Enabled` setting -When environment conditions do not support Visual Studio Code security handling, change the `Secure Credentials Enabled` setting with the following steps: +When environment conditions do not support the Zowe CLI built-in Credential Manager, change the `Secure Credentials Enabled` setting with the following steps: 1. Navigate to Zowe Explorer settings. 2. Scroll to **Security: Secure Credentials Enabled**.