Merge branch 'master' into fix/v3/webui-misc-docs-2

Signed-off-by: zFernand0 <[email protected]>

.github/workflows/link-checker.yml

@@ -22,7 +22,7 @@ jobs:
       - name: Create symlinks
         run: |
           find docs -name "*.md" -type f | while read f; do
-            ln -s $(basename $f) ${f%.*}
+            ln -s "$(basename "$f")" "${f%.*}"
           done
 
       - name: Restore lychee cache

.github/workflows/pr-comment-trigger.yml

@@ -25,7 +25,7 @@ jobs:
             const body = context.payload.comment.body;
             if (body.startsWith("/labels ")) {
               console.log("Comment body:", body);
-              const repoLabels = (await github.rest.issues.listLabelsForRepo(context.repo)).data.map((label) => label.name);
+              const repoLabels = (await github.rest.issues.listLabelsForRepo({ ...context.repo, per_page: 100 })).data.map((label) => label.name);
               const labelMapping = {};
               for (const label of repoLabels) {
                 if (label.includes(": ")) {

docs/appendix/zowe-yaml-configuration.md

@@ -421,7 +421,7 @@ These configurations can be used under the `components.gateway` section:
   Specifies the global feature toggle. Set the value to `true` to enable OIDC authentication functionality.
 
 - **`apiml.security.oidc.registry`**  
-  Specifies the SAF registry used to group the identities recognized as having an OIDC identity mapping. The registry name is the string used during the creation of the mapping between the distributed and mainframe user identities. For more information, see the [ESM configuration](#esm-configuration).
+  Specifies the SAF registry used to group the identities recognized as having an OIDC identity mapping. The registry name is the string used during the creation of the mapping between the distributed and mainframe user identities. For more information, see the [ESM configuration](../extend/extend-apiml/api-mediation-oidc-authentication.md#esm-configuration-prerequisites).
 
 - **`apiml.security.oidc.jwks.uri`**  
   Specifies the URI obtained from the authorization server's metadata where the Gateway will query for the JWK used to sign and verify the access tokens.
@@ -440,7 +440,7 @@ User authorization is required to use the `IRR.RUSERMAP` resource within the `FA
 
 - **`apiml.security.oidc.identityMapperUrl`**  
   Defines the URL where the Gateway can query the mapping of the distributed user ID to the mainframe user ID. 
-  This property informs the Gateway about the location of this API. ZSS is the default API provider in Zowe, but if you are using Zowe release 2.14 or a later version, we recommend you use the [API ML internal mapper](../../user-guide/authenticating-with-client-certificates.md#enabling-the-internal-api-ml-mapper). You can provide your own API to perform the mapping. In this case, it is necessary to customize this value.
+  This property informs the Gateway about the location of this API. ZSS is the default API provider in Zowe, but if you are using Zowe release 2.14 or a later version, we recommend you use the [API ML internal mapper](../user-guide/api-mediation/configuration-client-certificates.md#configure-internal-api-ml-mapper). You can provide your own API to perform the mapping. In this case, it is necessary to customize this value.
 
   The following URL is the default value for Zowe and ZSS:
 

docs/contribute/guidelines-code/documentation.md

@@ -55,7 +55,7 @@ When writing TypeScript code, comment objects and functions in compliance with [
 
 ### Java
 
-When writing TypeScript code, comment objects and functions in the Javadoc format.
+When writing Java code, comment objects and functions in the Javadoc format.
 
 ### C
 

docs/extend/extend-apiml/api-mediation-versioning.md

@@ -24,7 +24,6 @@
  Resource Identifier (URIs). The services are accessed via APIML gateway. Example of a URI:
  `https://host:10010/endevormfno/api/v1/ENWSQA01/packages/PACKAGETST
  (https://{gatewayHost}:{port}/{serviceName}/api/v{majorVersion}/{resource}`)
- See [Components of URL](../extend-apiml/api-mediation-components-of-URL.md) for more information about the URL components of REST APIs.
 
  ## Data Model
 

docs/extend/extend-apiml/onboard-plain-java-enabler.md

@@ -40,7 +40,7 @@ The following steps outline the overall process to onboard a service with the AP
     * [Maven build automation system](#maven-build-automation-system)
 
 3. [Configuring your service](#configuring-your-service)
-    * [Service identification](#rest-service-identification)
+    * [Service identification](#service-identification)
     * [Administrative endpoints](#administrative-endpoints)
     * [API info](#api-info)
     * [API routing information](#api-routing-information)
@@ -312,7 +312,7 @@ customMetadata:
 ```
 The onboarding configuration parameters are broken down into the following groups:
 
-- [Service identification](#rest-service-identification)
+- [Service identification](#service-identification)
 - [Administrative endpoints](#administrative-endpoints)
 - [API info](#api-info)
 - [API routing information](#api-routing-information)

docs/extend/extend-desktop/mvd-server-config.md

@@ -3,11 +3,11 @@
 The Zowe's App Server and ZSS rely on many required or optional parameters to run, which includes setting up networking, deployment directories, plugin locations, and more. 
 These parameters can be specified in two ways: configuration files, or environment variables.
 
-Every configuration option and requirement is documented within the application framework [json-schema file](https://github.com/zowe/zlux/blob/v3.x/staging/schemas/zlux-config-schema.json)
+Every configuration option and requirement is documented within the application framework [json-schema file](https://github.com/zowe/zlux-app-server/blob/v3.x/staging/schemas/app-server-config.json)
 
 ## Configuration file
 
-In Zowe's server configuration file, app-server parameters can be specified within `components.app-server` as shown in the component [json-schema file](https://github.com/zowe/zlux/blob/v3.x/staging/schemas/zowe-schema.json), or `components.zss` for ZSS.
+In Zowe's server configuration file, app-server parameters can be specified within `components.app-server` as shown in the component [json-schema file](https://github.com/zowe/zlux-app-server/blob/v3.x/staging/schemas/zowe-schema.json), or `components.zss` for ZSS.
 
 ## Environment variables
 

docs/extend/extend-sdks.md

@@ -14,6 +14,6 @@ For detailed contribution guidelines, see the following documents:
 ## Community resources 
 
 - Join the [#zowe-cli Slack channel](https://openmainframeproject.slack.com/) to ask questions about Zowe CLI and Zowe SDKs, propose new ideas, and interact with the Zowe community.
-- 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.
+- You can join one of the [Zowe CLI squad meetings](https://zoom-lfx.platform.linuxfoundation.org/meetings/zowe) 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).

docs/getting-started/install-zowe-sdks.md

@@ -125,16 +125,16 @@ Download and install the packages:
 
 2. Unzip the SDK folder, which contains the packages for each set of functionality (such as z/OS Jobs). Copy each file that you want to install and paste them into your project directory.
 
-3. Install required dependencies, which are included in the bundle. See [Software requirements and dependencies](#software-requirements-and-dependencies) for more information.
+3. Install required dependencies, which are included in the bundle. See [Software requirements and dependencies](#sdk-software-requirements-and-dependencies) for more information.
 
-3. In a command-line window, navigate to your project directory. Issue *one* of the following commands.
+4. In a command-line window, navigate to your project directory. Issue *one* of the following commands.
 
    - To install a Node.js package: `npm install <packageName>.tgz`
    - To install a Python package: `pip install <packageName>.whl`
 
       -`<packageName>`
       The name of the package that you want to install, such as `zos-files-for-zowe-sdk`.
 
-4. Repeat the command for each package that you need.
+5. Repeat the command for each package that you need.
 
     Packages are now installed.

docs/troubleshoot/cli/troubleshoot-cli-credentials.md

@@ -14,7 +14,7 @@ Zowe CLI accepts various methods, or mechanisms, of authentication when communic
 
 However, some services can accept multiple methods of authentication. When multiple methods are provided (in a configuration profile or command) for a service, the CLI follows an *order of precedence* to determine which method to apply.
 
-To find the authentication methods used for different services and their order of precedence, see the table in [Authentication mechanisms](../../extend/extend-cli/cli-devTutorials.md#authentication-mechanisms).
+To find the authentication methods used for different services and their order of precedence, see the table in [Authentication mechanisms](../../extend/extend-cli/cli-authentication-mechanisms.md).
 
 ### PEM certificate files
 

docs/user-guide/_install-cli-via-proxy.md

@@ -64,7 +64,7 @@ You can install Zowe CLI from an online registry via proxy on Windows, macOS, or
 
    - [my-plugin]: The syntax for the plug-in. For example, `@zowe/cics@zowe-v2-lts`.
 ​
-6. **(Optional)** Test the connection to z/OSMF. See [Testing connections to z/OSMF](../user-guide/cli-using-test-zosmf-connection) 
+6. **(Optional)** Test the connection to z/OSMF. See [Testing connections to z/OSMF](../user-guide/_cli-using-test-zosmf-connection) 
 
 7. **(Optional)** Access the Zowe CLI Help (`zowe --help`) or the Zowe CLI Web Help for a complete reference of Zowe CLI.
 ​

docs/user-guide/address-network-requirements.md

@@ -8,18 +8,46 @@ Values presented in the table are default values. You can change the values by u
 
 For more information about variable names in the following table, see the [Zowe YAML configuration file reference](../appendix/zowe-yaml-configuration.md) in the References section.
 
+## Component Ports
+
+Most Components of Zowe are HTTPS servers. The ports of each and their default jobnames are listed below.
+The ports can be customized for each component by editing the value of `components.<component-name>.port` within the Zowe YAML file.
+Each Jobname has a default prefix of ZWE1, but that can be customized via the `zowe.job.prefix` value in the Zowe YAML file.
+
+| Port number | Category | Component | Default Jobname | Log Suffix | Purpose |
+|------|------|------|------|------|------|
+| 7552 | API Mediation Layer | api-catalog | ZWE1AC | AAC | Used to view API swagger / openAPI specifications for registered API services in the API Catalog. 
+| 7553 | API Mediation Layer | discovery | ZWE1AD | ADS | Discovery server port which dynamic API services can issue APIs to register or unregister themselves.
+| 7554 | API Mediation Layer | gateway | ZWE1AG | AGW | The northbound edge of the API Gateway used to accept client requests before routing them to registered API services.  This port must be exposed outside the z/OS network so clients (web browsers, VS Code, processes running the Zowe CLI) can reach the gateway.
+| 7555 | API Mediation Layer | caching-service | ZWE1CS | ACS | Port of the caching service that is used to share state between different Zowe instances in a high availability topology.
+| 7556 | App Framework | app-server | ZWE1DS | D | The Zowe Desktop (also known as ZLUX) port used to log in through web browsers.
+| 7557 | App Framework | zss | ZWE1SZ | SZ | Z Secure Services (ZSS) provides REST API services to ZLUX, used by the File Editor application and other ZLUX applications in the Zowe Desktop.
+| 7558 | API Mediation Layer | zaas | ZWE1AZ | AZ | 
+
+## Caching Service Infinispan ports
+
+The Caching Service will use these additional ports if enabled (`zowe.components.caching-service.enabled: true`) and set to use infinispan (the default, `zowe.components.caching-service.storage.mode: infinispan`).
+
 | Port number | zowe.yaml variable name | Purpose |
 |------|------|------|
-| 2157 | NA | The port at which the key server in Infinispan is listening. If the port is not available, the next port is probed, up to port+5. Used by the key server (server) to create an SSLServerSocket and by clients to connect to the key server.
-| 7098 | zowe.components.caching-service.storage.infinispan.jgroups.port | Bind port for the socket that is used to form an Infinispan cluster.
-| 7552 | zowe.components.api-catalog.port | Used to view API swagger / openAPI specifications for registered API services in the API Catalog. 
-| 7553 | zowe.components.discovery.port | Discovery server port which dynamic API services can issue APIs to register or unregister themselves.
-| 7554 | zowe.components.gateway.port | The northbound edge of the API Gateway used to accept client requests before routing them to registered API services.  This port must be exposed outside the z/OS network so clients (web browsers, VS Code, processes running the Zowe CLI) can reach the gateway.
-| 7555 | zowe.components.caching-service.port | Port of the caching service that is used to share state between different Zowe instances in a high availability topology.
-| 7556 | zowe.components.app-server.port | The Zowe Desktop (also known as ZLUX) port used to log in through web browsers.
-| 7557 | zowe.components.zss.port | Z Secure Services (ZSS) provides REST API services to ZLUX, used by the File Editor application and other ZLUX applications in the Zowe Desktop.
-| 7558 | zowe.components.zaas.port | 
-| N/A | zowe.components.explorer-jes | Port of the JES Explorer GUI for viewing and working with jobs in the Zowe Desktop.
-| N/A | zowe.components.explorer-mvs | Port of the MVS Explorer GUI for working with data sets in the Zowe Desktop.
-| N/A | zowe.components.explorer-uss | Port of the USS Explorer GUI for working with USS in the Zowe Desktop.
+| 7601 | zowe.components.caching-service.storage.infinispan.jgroups.keyExchange.port | The port at which the key server in Infinispan is listening. If the port is not available, the next port is probed, up to port+5. Used by the key server (server) to create an SSLServerSocket and by clients to connect to the key server.
+| 7600 | zowe.components.caching-service.storage.infinispan.jgroups.port | Bind port for the socket that is used to form an Infinispan cluster.
+
+## IP Addresses
+
+Zowe's servers by default use the TCP IP address `0.0.0.0` which assigns the servers to be available on all network interfaces available to the jobs.
+
+If this default is not desired, it is recommended to use [TCPIP port assignment statements](https://www.ibm.com/docs/en/zos/2.4.0?topic=assignments-profiletcpip-port) to restrict the IP & ports of each server by their jobnames. The jobnames of each Zowe component is derived from the property `zowe.job.prefix` and `<component-suffix>` as shown in the table prior.
+
+When `zowe.job.prefix` is "ZWE1", An example of port reservations with a fixed IP of "10.11.12.13" could be:
+
+```
+   7552 TCP ZWE1AC BIND 10.11.12.13 ; Zowe API Catalog
+   7553 TCP ZWE1AD BIND 10.11.12.13 ; Zowe Discovery
+   7554 TCP ZWE1AG BIND 10.11.12.13 ; Zowe Gateway
+   7555 TCP ZWE1CS BIND 10.11.12.13 ; Zowe Caching Service
+   7556 TCP ZWE1DS BIND 10.11.12.13 ; Zowe App Server
+   7557 TCP ZWE1SZ BIND 10.11.12.13 ; Zowe ZSS
+   7558 TCP ZWE1AZ BIND 10.11.12.13 ; Zowe ZAAS
+```
 

docs/user-guide/api-mediation/api-mediation-caching-service.md

@@ -16,7 +16,7 @@ The Caching Service is available only for internal Zowe applications, and is not
 - [Architecture](#architecture)
 - [Storage methods](#storage-methods)
   - [Infinispan](#infinispan-recommended)
-  - [VSAM](#vsam)
+  - [VSAM](#vsam-deprecated)
   - [Redis](#redis)
   - [InMemory](#inmemory)
 - [How to start the service](#how-to-start-the-service)

docs/user-guide/cli-installcli copy.md

@@ -19,12 +19,12 @@ To install Zowe CLI on **z/Linux**, **z/OS UNIX System Services (USS)**, or on a
 
 -  To install Zowe CLI on a z/Linux operating system and you **require** the Secure Credential Store:
    1. Follow the steps in [Configure Secure Credential Store on headless Linux operating systems](./cli-configure-scs-on-headless-linux-os.md).
-   2. Follow the steps in [Install Zowe CLI from npm](#install-zowe-cli-from-npm) or [Install Zowe CLI from a download](#install-zowe-cli-from-a-download).
+   2. Follow the steps in [Install Zowe CLI from npm](#install-zowe-cli-from-npm) or [Install Zowe CLI from a download](#install-zowe-cli-from-a-local-package).
 -  To install Zowe CLI on a z/Linux operating system and you **do not require** the Secure Credential Store:
-   1. Follow the steps in [Install Zowe CLI from npm](#install-zowe-cli-from-npm) or [Install Zowe CLI from a download](#install-zowe-cli-from-a-download).
+   1. Follow the steps in [Install Zowe CLI from npm](#install-zowe-cli-from-npm) or [Install Zowe CLI from a download](#install-zowe-cli-from-a-local-package).
    2. Follow the steps in [Configure Zowe CLI on operating systems where the Secure Credential Store is not available](./cli-configure-cli-on-os-where-scs-unavailable.md).
 -  To install Zowe CLI on a USS system or on an operating system where you **cannot install** the Secure Credential Store:
-   1. Follow the steps in [Install Zowe CLI from npm](#install-zowe-cli-from-npm) or [Install Zowe CLI from a download](#install-zowe-cli-from-a-download).
+   1. Follow the steps in [Install Zowe CLI from npm](#install-zowe-cli-from-npm) or [Install Zowe CLI from a download](#install-zowe-cli-from-a-local-package).
    2. Follow the steps in [Configure Zowe CLI on operating systems where the Secure Credential Store is not available](./cli-configure-cli-on-os-where-scs-unavailable.md).
 
 ### Installation notes
@@ -38,8 +38,6 @@ To install Zowe CLI on **z/Linux**, **z/OS UNIX System Services (USS)**, or on a
 
 ### Prerequisite notes
 
-- If you are installing Zowe CLI on a computer that is running Node.js 16 on a Windows operating system, see [Installing Zowe CLI with Node.js 16 on Windows](../user-guide/cli-install-cli-nodejs-windows.md).
-
 - If you are running NPM version 7 (`npm@7`) or NPM version 8 (`npm@8`) on a Windows operating system, ensure that your computer is connected to the Internet.
 
    Issue the following command ***before*** you install Zowe CLI:

docs/user-guide/cli-using-understanding-core-command-groups.md

@@ -258,7 +258,7 @@ The `zosmf` command group lets you work with Zowe CLI profiles and get general i
 
 With the `zosmf` command group, you can perform the following tasks:
 
-* Verify that your profiles are set up correctly to communicate with z/OSMF on your system. For more information, see [Testing connections to z/OSMF](../user-guide/cli-using-test-zosmf-connection).
+* Verify that your profiles are set up correctly to communicate with z/OSMF on your system. For more information, see [Testing connections to z/OSMF](../user-guide/_cli-using-test-zosmf-connection.md).
 * Get information about the current z/OSMF version, host, port, and plug-ins installed on your system.
 
 :::note

docs/user-guide/cli-using-usingcli.md

@@ -5,11 +5,11 @@ In this section, learn how to use Zowe CLI, including how to connect to the main
 You can use the CLI interactively from a command window on any computer on which it is installed, or run it in a container or automation environment.
 
 :::tip
-Text colors could be difficult to read in some terminals. If this is the case, we suggest either adjusting the terminal settings, or setting the `FORCE_COLOR` [environment variable](../user-guide/cli-configuringcli-ev.md#setting-other-environment-variables) to `0`. For other accessibility options, check the accessibility settings for your operating system or terminal.
+Text colors could be difficult to read in some terminals. If this is the case, we suggest either adjusting the terminal settings, or setting the `FORCE_COLOR` environment variable to `0`. For other accessibility options, check the accessibility settings for your operating system or terminal.
 :::
 
 
-Text colors could be difficult to read in some terminals. If this is the case, we suggest either adjusting the terminal settings, or setting the `FORCE_COLOR` [environment variable](../user-guide/cli-configuringcli-ev.md#setting-other-environment-variables) to `0`. For other accessibility options, check the accessibility settings for your operating system or terminal.
+Text colors could be difficult to read in some terminals. If this is the case, we suggest either adjusting the terminal settings, or setting the `FORCE_COLOR` environment variable to `0`. For other accessibility options, check the accessibility settings for your operating system or terminal.
 
 :::