From 8514f75e6067a5de9279f8a6e5451e25ce1ff937 Mon Sep 17 00:00:00 2001 From: Andrew Jandacek Date: Tue, 26 Nov 2024 11:26:47 +0100 Subject: [PATCH 1/4] change tilte from Using to Additing and other similar changes Signed-off-by: Andrew Jandacek --- docs/user-guide/use-certificates.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/user-guide/use-certificates.md b/docs/user-guide/use-certificates.md index c32ae73243..76c8b67539 100644 --- a/docs/user-guide/use-certificates.md +++ b/docs/user-guide/use-certificates.md @@ -1,6 +1,6 @@ -# Using certificates +# Adding certificates to Zowe configuration -Once you have generated or imported your certificates, you can now use the certificates with Zowe. Use the procedure descibed in this article that corresponds to the type of certificates you generated or imported. +Once you have generated or imported your certificates, you can now add your certificates in your Zowe configuration. Use the procedure descibed in this article that corresponds to the type of certificates you generated or imported. :::info Required roles: system programmer, security administrator ::: @@ -9,13 +9,13 @@ Choose from the following procedures: - [Use PKCS12 certificates](#use-pkcs12-certificates) - [Use JCERACFKS certificates](#use-jceracfks-certificates) -## Use PKCS12 certificates +## Add PKCS12 certificates -To use PKCS12 certificates, run the command `zwe start -c ./zowe.yaml` in the directory with the `zowe.yaml` file to start Zowe. +To add PKCS12 certificates, run the command `zwe start -c ./zowe.yaml` in the directory with the `zowe.yaml` file to start Zowe. Details about the PKCS12 certificate used when Zowe is launched are specified in the `zowe.yaml` section `certificates`. This section contains information about the certificate name and the location of the certificate, together with the truststore location. -The two most common scenarios for using a PKCS12 certificate are: +The two most common scenarios for adding a PKCS12 certificate in your Zowe configuration are: * You have an existing certificate and wish to configure Zowe to use the certificate. * You do not have a certificate and wish to [generate a new certificate](./generate-certificates.md). @@ -28,7 +28,7 @@ To troubleshoot issues during Zowe startup, see [Troubleshooting startup of Zowe Details about the JCERACFKS certificate used when Zowe is launched are specified in the `zowe.yaml` section `certificates`. This section contains information about the certificate name and location, together with the truststore location. -The two most common scenarios for using a JCERACFKS certificate are: +The two most common scenarios for adding a JCERACFKS certificate to your Zowe configuration are: * You have been given an existing certificate and wish to configure Zowe to use it. * You do not have a certificate and wish to generate a new one. From a66f764d4277a6d24293748c164e7cb410fd0a03 Mon Sep 17 00:00:00 2001 From: Andrew Jandacek Date: Tue, 26 Nov 2024 13:22:19 +0100 Subject: [PATCH 2/4] fix broken links Signed-off-by: Andrew Jandacek --- docs/user-guide/zos-components-installation-checklist-dev.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-guide/zos-components-installation-checklist-dev.md b/docs/user-guide/zos-components-installation-checklist-dev.md index bf36e325f8..346605fb50 100644 --- a/docs/user-guide/zos-components-installation-checklist-dev.md +++ b/docs/user-guide/zos-components-installation-checklist-dev.md @@ -43,7 +43,7 @@ Use one of the following installation options to install Zowe z/OS components. | Verification Step | Task | Results | Time Estimate | |----|-----------|----|-------------| | [Verify Zowe Application Framework installation](../user-guide/verify-zowe-runtime-install.md#verifying-zowe-application-framework-installation) | Open the Zowe Desktop from a supported browser | You should be able to open the Zowe Desktop from a supported browser. | 20 minutes| -| [Verify API Mediation installation](../user-guide/verify-zowe-runtime-install.md#verifying-api-mediation-installation) |Use a REST API client to review the value of the status variable of the API Catalog service routed through the API Gateway | See the example presented in Verify API Mediation installation | 15 minutes | +| [Verify API Mediation installation](../user-guide/verify-zowe-runtime-install.md#verifying-api-mediation-layer-installation) |Use a REST API client to review the value of the status variable of the API Catalog service routed through the API Gateway | See the example presented in Verify API Mediation installation | 15 minutes | |[Verify z/OS Services installation](../user-guide/verify-zowe-runtime-install.md#verifying-zos-services-installation) |Zowe z/OS services usually are registered with Zowe APIML Discovery| You should see JSON format data of all jobs running on the system | 15 minutes | From 0a0af8910b065e8778fe5b085c37f9f44f2342ed Mon Sep 17 00:00:00 2001 From: Andrew Jandacek Date: Wed, 27 Nov 2024 10:30:28 +0100 Subject: [PATCH 3/4] change link refs Signed-off-by: Andrew Jandacek --- docs/user-guide/generate-certificates.md | 2 +- docs/user-guide/import-certificates.md | 2 +- docs/user-guide/use-certificates.md | 8 ++++---- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/user-guide/generate-certificates.md b/docs/user-guide/generate-certificates.md index 6d60750459..520e16b29f 100644 --- a/docs/user-guide/generate-certificates.md +++ b/docs/user-guide/generate-certificates.md @@ -282,4 +282,4 @@ You completed the procedure to generate a JCERACFKS certificate. ### Next steps after JCERACFKS setup -For more information about how to use your JCERACFKS certificate, see [Use JCERACFKS certificates](./use-certificates.md). +For more information about how to use your JCERACFKS certificate, see [Add JCERACFKS certificates](./use-certificates.md). diff --git a/docs/user-guide/import-certificates.md b/docs/user-guide/import-certificates.md index 70ed86068f..5e9c14e68a 100644 --- a/docs/user-guide/import-certificates.md +++ b/docs/user-guide/import-certificates.md @@ -221,5 +221,5 @@ zowe: The configuration of `zowe.setup.certificate` populates information to be used by the subcommand `zwe init certificate` of `zwe init`. ## Next steps -Once your certificate is successfully imported, review the documentation about how to [use certificates](./use-certificates.md) in a Zowe production environment. +Once your certificate is successfully imported, review the documentation about how to [add certificates](./use-certificates.md) in a Zowe production environment. diff --git a/docs/user-guide/use-certificates.md b/docs/user-guide/use-certificates.md index 76c8b67539..d77c571c78 100644 --- a/docs/user-guide/use-certificates.md +++ b/docs/user-guide/use-certificates.md @@ -6,12 +6,12 @@ Once you have generated or imported your certificates, you can now add your cert ::: Choose from the following procedures: -- [Use PKCS12 certificates](#use-pkcs12-certificates) -- [Use JCERACFKS certificates](#use-jceracfks-certificates) +- [Add PKCS12 certificates](#use-pkcs12-certificates) +- [Add JCERACFKS certificates](#use-jceracfks-certificates) ## Add PKCS12 certificates -To add PKCS12 certificates, run the command `zwe start -c ./zowe.yaml` in the directory with the `zowe.yaml` file to start Zowe. +To add PKCS12 certificates to your Zowe configuration, run the command `zwe start -c ./zowe.yaml` in the directory with the `zowe.yaml` file to start Zowe. Details about the PKCS12 certificate used when Zowe is launched are specified in the `zowe.yaml` section `certificates`. This section contains information about the certificate name and the location of the certificate, together with the truststore location. @@ -24,7 +24,7 @@ The two most common scenarios for adding a PKCS12 certificate in your Zowe confi To troubleshoot issues during Zowe startup, see [Troubleshooting startup of Zowe z/OS components](https://docs.zowe.org/stable/troubleshoot/troubleshoot-zos-startup). -## Use JCERACFKS certificates +## Add JCERACFKS certificates Details about the JCERACFKS certificate used when Zowe is launched are specified in the `zowe.yaml` section `certificates`. This section contains information about the certificate name and location, together with the truststore location. From 8fe3876a175e7ac3132450cec248c0907686f4d4 Mon Sep 17 00:00:00 2001 From: Andrew Jandacek Date: Wed, 27 Nov 2024 11:14:02 +0100 Subject: [PATCH 4/4] fix links Signed-off-by: Andrew Jandacek --- .../extend-apiml/certificate-management-in-zowe-apiml.md | 4 ++-- docs/user-guide/use-certificates.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/extend/extend-apiml/certificate-management-in-zowe-apiml.md b/docs/extend/extend-apiml/certificate-management-in-zowe-apiml.md index 8ea0e707b0..2554a1bde4 100644 --- a/docs/extend/extend-apiml/certificate-management-in-zowe-apiml.md +++ b/docs/extend/extend-apiml/certificate-management-in-zowe-apiml.md @@ -62,8 +62,8 @@ There are two ways to set up certificates on a z/OS machine: - [Certificates in SAF keyring](#api-ml-saf-keyring) For detailed instructions about how to set up certificates during installation, see the following articles: -* [Use PKCS12 certificates](../../user-guide/use-certificates.md#use-pkcs12-certificates) -* [Use JCERACFS certificates](../../user-guide/use-certificates.md#use-jceracfks-certificates) in a keyring +* [Use PKCS12 certificates](../../user-guide/use-certificates.md#add-pkcs12-certificates) +* [Use JCERACFS certificates](../../user-guide/use-certificates.md#add-jceracfks-certificates) in a keyring Follow the procedure in the applicable section described in this article during installation. diff --git a/docs/user-guide/use-certificates.md b/docs/user-guide/use-certificates.md index d77c571c78..f3e33c9ca7 100644 --- a/docs/user-guide/use-certificates.md +++ b/docs/user-guide/use-certificates.md @@ -6,8 +6,8 @@ Once you have generated or imported your certificates, you can now add your cert ::: Choose from the following procedures: -- [Add PKCS12 certificates](#use-pkcs12-certificates) -- [Add JCERACFKS certificates](#use-jceracfks-certificates) +- [Add PKCS12 certificates](#add-pkcs12-certificates) +- [Add JCERACFKS certificates](#add-jceracfks-certificates) ## Add PKCS12 certificates