Skip to content

Commit 12b84c5

Browse files
authored
Merge pull request #329 from openmainframeproject/adjust-prereq-instructions
Adjust prerequisite content in the installation section
2 parents e257fd1 + ea9fcbd commit 12b84c5

File tree

6 files changed

+39
-90
lines changed

6 files changed

+39
-90
lines changed

COBOL Programming Course #1 - Getting Started/COBOL Programming Course #1 - Getting Started.md

Lines changed: 35 additions & 86 deletions
Original file line numberDiff line numberDiff line change
@@ -619,11 +619,8 @@ As both a user and programmatic interface, command-line interfaces offer signifi
619619

620620
# Installation of VSCode and extensions
621621

622-
This chapter covers all aspects of download and installation of Visual Studio (VS) Code and any prerequisites that are needed. It includes:
622+
This chapter covers all aspects of download and installation of Visual Studio (VS) Code and any extensions that are needed. It includes:
623623

624-
- **Install prerequisites**
625-
- **Install node.js**
626-
- **Install Java SDK**
627624
- **Install VSCode**
628625

629626
- **Install VSCode extensions**
@@ -633,81 +630,6 @@ This chapter covers all aspects of download and installation of Visual Studio (V
633630

634631
- **Summary**
635632

636-
## Install prerequisites
637-
638-
This section will cover the necessary steps and information to download and install the prerequisites needed for the subsequent labs within this book. This software is needed for one or more of the applications we will be utilizing in our labs throughout the book. The prerequisites include:
639-
640-
- Install node.js
641-
642-
- Install Java SDK
643-
644-
### Install node.js
645-
646-
1. Check for node.js installation and verify that the version number is v18 or higher.
647-
648-
Open your workstation's version of the command prompt (called Terminal on Mac OS X). Once the command prompt is open, use the command in Example 1. to check if your workstation currently has a version of node.js installed.
649-
650-
```
651-
C:\Users\User> node -v
652-
653-
V20.15.1
654-
```
655-
*Example 1. Node.js version*
656-
657-
If you do not see a version number after you submit the command, you do not have node.js installed, or if it shows a version less than v18, you should continue following these instructions. If you do see a version number and it is v18 or higher, you can move on to the section Install Java SDK.
658-
659-
2. Ensure you are using a supported LTS version of Node.js. You can verify your version or find supported versions at [`https://nodejs.org/en/about/previous-releases`](https://nodejs.org/en/about/previous-releases)
660-
661-
Updating node.js to the appropriate version is a relatively simple process because the installer takes care of most of the "heavy lifting". All you will need to do is visit the Node.js download site, provided below and follow the download and installation instructions for your specific workstation platform. Do this same process if you do not already have node.js installed.
662-
663-
[`https://nodejs.org/en/download/`](https://nodejs.org/en/download/)
664-
665-
This process will install the latest versions of Node.js and the node package manager (npm) and overwrite any older version files in your system. This removes the step of needing to manually uninstall the previous versions beforehand.
666-
667-
3. Once completed, verify the installation and proper version number, as shown previously in Example 1.
668-
669-
**Note**: The version numbers in our examples are provided purely for reference and may not reflect the latest versions of the software.
670-
671-
### Install Java SDK
672-
673-
1. Check for Java installation and verify that the version number is v17 or higher.
674-
675-
Open your workstation’s version of the command prompt, if not already open. Once the command prompt is open, use the command in Example 2. to check if your workstation currently has a version of Java installed. Java SDK 17 is the preferred version for these labs, however, any versions higher than that will suffice.
676-
677-
```
678-
C:\Users\User> java -version
679-
680-
java version "18.0.2.1"
681-
682-
Java(TM) SE Runtime Environment (build 18.0.2.1+1-1)
683-
684-
Java HotSpot(TM) 64-Bit Server VM (build 18.0.2.1+1-1, mixed mode)
685-
```
686-
*Example 2. Java version*
687-
688-
If you do not see a version number after you submit the command, you do not have Java installed or if it shows a version less than v17, you should continue following these instructions. The display format of the version number for Java is slightly different than what is displayed for node.js. The given example is showing Java SDK version 18. If you do see a version number and it is v17 or higher, you can move on to the section Install VSCode.
689-
690-
2. If your version of Java displayed is less than v17, you need to uninstall the current version on your workstation and reinstall the correct version. Follow the link below to uninstall instructions that represent your workstation operating system (OS).
691-
692-
-Linux:
693-
694-
[`https://www.java.com/en/download/help/linux_uninstall.xml` ](https://www.java.com/en/download/help/linux_uninstall.xml)
695-
696-
-Mac:
697-
698-
[`https://www.java.com/en/download/help/mac_uninstall_java.xml` ](https://www.java.com/en/download/help/mac_uninstall_java.xml)
699-
700-
-Windows:
701-
702-
[`https://www.java.com/en/download/help/uninstall_java.xml` ](https://www.java.com/en/download/help/uninstall_java.xml)
703-
704-
705-
3. Once Java is uninstalled from your workstation, you can click the Java JDK 17 download link below and follow the installation instructions for your specific OS.
706-
707-
[`https://www.oracle.com/java/technologies/downloads/` ](https://www.oracle.com/java/technologies/downloads/)
708-
709-
4. Verify the installation and proper version number as shown in Example 2.
710-
711633
## Install VSCode
712634

713635
If you do not already have VSCode installed on your workstation, please do so now by following the download and installation instructions at the link below:
@@ -722,13 +644,15 @@ If you do not already have VSCode installed on your workstation, please do so no
722644

723645
## Install VSCode extensions
724646

725-
This section introduces two VSCode extensions, Zowe Explorer and IBM Z Open Editor listed in Figure 2. , and instructions on how to install them.
647+
This section introduces Zowe Explorer, IBM Z Open Editor, and the Code4z extension pack listed in Figure 2., and instructions on how to install them. Note that you may choose to use either IBM Z Open Editor or the Code4z extension pack.
726648

727649
![](Images/image026-a.png)
728650

729651
![](Images/image026-b.png)
730652

731-
*Figure 2. VSCode required extensions*
653+
![](Images/image026-c.png)
654+
655+
*Figure 2. VSCode extensions*
732656

733657
### Zowe Explorer
734658

@@ -754,27 +678,27 @@ IBM Z Open Editor brings COBOL and PL/I language support to Microsoft VSCode. I
754678

755679
#### Install IBM Z Open Editor
756680

681+
Prior to installing the extension, please review the prerequisites at https://marketplace.visualstudio.com/items?itemName=IBM.zopeneditor#prerequisites
682+
757683
Open VSCode and in the left side tool menu select **Extensions**. From there, in the "Search Extensions in Marketplace" search field, type `IBM Z Open Editor`. Search results will begin populating, select **" IBM Z Open Editor "** and click **install**, depicted in Figure 4.
758684

759685
![](Images/image032.png)
760686

761687
*Figure 4. Install IBM Z Open Editor in VSCode*
762688

763-
**Note**: There may be some limitations with IBM Z Open Editor if running a 32-bit Java version on Windows.
764-
765689
### Code4z
766690

767691
Code4z is an all-in-one, open-source mainframe extension package for developers working with z/OS applications, suitable for all levels of mainframe experience, even beginners. Mainframe application developers can use the Code4z package for a modern, familiar, and seamless experience, which helps to overcome some developers' reservations or concerns about the traditional mainframe user experience. To find out more about Code4z, please visit [https://github.com/BroadcomMFD/code4z](https://github.com/BroadcomMFD/code4z).
768692

769693
#### Install Code4z
770694

771-
Open VSCode and in the left side tool menu select **Extensions**. From there, in the "Search Extensions in Marketplace" search field, type `Code4z`. Search results will begin populating, select **" Code4z "** and click **install**.
695+
Open VSCode and in the left side tool menu select **Extensions**. From there, in the "Search Extensions in Marketplace" search field, type `Code4z`. Search results will begin populating, select **"Code4z"** and click **install**.
772696

773697
The extension pack contains a number of extensions that can be leveraged when working with the mainframe, including the COBOL Language Support extension which provides similar functionality to the Z Open Editor extension. Therefore, ensure only one of these extensions is enabled. Extensions can be disabled within VS Code by locating the extension in the Extensions menu, clicking the settings gear, and selecting `Disable`. Other extensions included in the Code4z pack will work with either COBOL Language Support or Z Open Editor.
774698

775699
## Summary
776700

777-
In this chapter, you have been introduced to VSCode and some of the extension tools available to it. We have walked through the process of installing the pre-requisite software, Node.js and Java SDK, as well as VSCode, Zowe Explorer, IBM Z Open Editor, and Code4z. You have also been briefly introduced to the utility of these extensions in VSCode. In the subsequent chapters, we will delve deeper into how and when to use them and get some practice through lab assignments.
701+
In this chapter, you have been introduced to VSCode and some of the extension tools available to it. We have walked through the process of installing VSCode, Zowe Explorer, IBM Z Open Editor, and Code4z. You have also been briefly introduced to the utility of these extensions in VSCode. In the subsequent chapters, we will delve deeper into how and when to use them and get some practice through lab assignments.
778702

779703
\newpage
780704

@@ -796,7 +720,32 @@ This chapter covers all aspects of the download and installation of Zowe CLI and
796720

797721
## Install prerequisites - Node.js
798722

799-
Before installing Zowe CLI, please ensure an LTS version of Node v18.0 or higher is installed. Please refer back to the section titled "Install Node.js" if you have not already completed it. Please also verify that you have a version of Node Package Manager (npm) that is compatible with your version of Node.js. For a list of compatible versions, see [https://nodejs.org/en/download/releases/](https://nodejs.org/en/download/releases/). npm is included with the Node.js installation. Issue the command `npm --version` to view the version of npm that is installed.
723+
Before installing Zowe CLI, please ensure a supported LTS (Long Term Support) version of Node.js is installed and that you have a version of npm (Node Package Manager) that is compatible with your version of Node.js. You can view the list of supported versions of Node and their associated npm version at [`https://nodejs.org/en/about/previous-releases`](https://nodejs.org/en/about/previous-releases)
724+
725+
You can follow these steps to confirm the prerequisites are met:
726+
727+
Open your workstation's version of the command prompt (called Terminal on Mac OS X). Once the command prompt is open, use the command in Example 1. to check if your workstation currently has a version of node.js installed.
728+
729+
```
730+
C:\Users\User> node -v
731+
732+
V22.12.0
733+
```
734+
*Example 1. Node.js version*
735+
736+
If you do not see a version number after you submit the command, you do not have node.js installed, or if it shows an unsupported version, then you need to install a recent LTS version.
737+
738+
Updating node.js to the appropriate version is a relatively simple process because the installer takes care of most of the "heavy lifting". All you will need to do is visit the Node.js download site, provided below, and follow the download and installation instructions for your specific workstation platform.
739+
740+
[`https://nodejs.org/en/download/`](https://nodejs.org/en/download/)
741+
742+
This process will install the latest versions of Node.js and the node package manager (npm) and overwrite any older version files in your system. This removes the step of needing to manually uninstall the previous versions beforehand.
743+
744+
Once completed, verify the installation and proper version number, as shown previously in Example 1.
745+
746+
**Note**: The version numbers in our examples are provided purely for reference and may not reflect the latest versions of the software.
747+
748+
To confirm you have the correct version of npm installed, you can similarly issue `npm --version` and see if it matches the correct Node.js version at [`https://nodejs.org/en/about/previous-releases`](https://nodejs.org/en/about/previous-releases).
800749

801750
## Install Zowe CLI
802751
There are two recommended methods for installing the Zowe CLI. If you have access to the public npm registry from your workstation, we recommend using that installation method as pulling updates is seamless. If you do not have access to this registry, we recommend downloading the package from zowe.org and installing it from the bundled package.

COBOL Programming Course #1 - Getting Started/Front_Matter.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
\begin{center}
22
\vspace*{25pt}
3-
\includegraphics{Images/COBOL-Programming-Course.png}
3+
\includegraphics[width=\textwidth]{Images/COBOL-Programming-Course.png}
44
\hypertarget{cobol-programming-course-1}{%
55
\section*{
66
\\[35pt]
54.2 KB
Loading

COBOL Programming Course #2 - Learning COBOL/Front_Matter.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
\begin{center}
22
\vspace*{25pt}
3-
\includegraphics{Images/COBOL-Programming-Course.png}
3+
\includegraphics[width=\textwidth]{Images/COBOL-Programming-Course.png}
44
\hypertarget{cobol-programming-course-2}{%
55
\section*{
66
\\[35pt]

COBOL Programming Course #3 - Advanced Topics/Front_Matter.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
\begin{center}
22
\vspace*{25pt}
3-
\includegraphics{Images/COBOL-Programming-Course.png}
3+
\includegraphics[width=\textwidth]{Images/COBOL-Programming-Course.png}
44
\hypertarget{cobol-programming-course-3}{%
55
\section*{
66
\\[35pt]

COBOL Programming Course #4 - Testing/Front_Matter.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
\begin{center}
22
\vspace*{25pt}
3-
\includegraphics{Images/COBOL-Programming-Course.png}
3+
\includegraphics[width=\textwidth]{Images/COBOL-Programming-Course.png}
44
\hypertarget{cobol-programming-course-4}{%
55
\section*{
66
\\[35pt]

0 commit comments

Comments
 (0)