From 9208348c272ea6dfb12ad34fecb554278618f364 Mon Sep 17 00:00:00 2001 From: Zerlord Santiago Date: Wed, 17 Jul 2024 00:35:49 +0800 Subject: [PATCH 1/4] Accessibility improvement --- docs/.snippets/drapiversion.md | 2 +- docs/.snippets/feedback.md | 2 +- docs/.snippets/helmversion.md | 2 +- docs/howto/accessdrapi.md | 10 ++-- docs/howto/diagents.md | 4 +- docs/howto/drapiingress.md | 30 ++++++----- docs/howto/index.md | 14 +++--- docs/howto/insertattachments.md | 6 +-- docs/howto/k3suninstall.md | 2 +- docs/howto/uninstall.md | 10 ++-- docs/index.md | 2 +- docs/references/summernotewidget.md | 4 +- docs/references/whatsnew/v201.md | 4 +- docs/references/whatsnew/v202.md | 2 +- docs/references/whatsnew/v203.md | 2 +- docs/topicguides/declvariables.md | 2 +- docs/topicguides/dominoadapter.md | 2 +- docs/topicguides/method.md | 2 +- docs/tutorials/adaptertutorial.md | 25 ++++----- docs/tutorials/designimport.md | 56 ++++++++++----------- docs/tutorials/downloadhelmchart.md | 23 +++++---- docs/tutorials/firsttouch.md | 22 ++++---- docs/tutorials/installation.md | 12 ++--- docs/tutorials/installiris.md | 6 +-- docs/tutorials/k3sinstall.md | 14 +++--- docs/tutorials/nativeinstallers.md | 46 ++++++++--------- docs/tutorials/obtainauthenticationtoken.md | 6 +-- docs/tutorials/portaldownload.md | 10 ++-- docs/tutorials/sysreq.md | 33 ++++++------ docs/tutorials/versionupgrade.md | 26 ++++------ docs/tutorials/voltformula.md | 12 ++--- mkdocs.yml | 3 +- 32 files changed, 192 insertions(+), 204 deletions(-) diff --git a/docs/.snippets/drapiversion.md b/docs/.snippets/drapiversion.md index 0bf2063b..7a75e6b2 100644 --- a/docs/.snippets/drapiversion.md +++ b/docs/.snippets/drapiversion.md @@ -1,2 +1,2 @@ !!!warning "Important" - Make sure to check [version compatibility](../references/compatibilitymatrix.md) between Volt MX Go and Domino REST API. \ No newline at end of file + Make sure to check [**version compatibility**](../references/compatibilitymatrix.md) between Volt MX Go and Domino REST API. \ No newline at end of file diff --git a/docs/.snippets/feedback.md b/docs/.snippets/feedback.md index 2fc95c6c..dfb0fb6f 100644 --- a/docs/.snippets/feedback.md +++ b/docs/.snippets/feedback.md @@ -1,3 +1,3 @@ !!! success "Your input matters!" - We would like to here from you. If you have questions, topics for discussion, ideas to share, or feedback, reach us through the [OpenNTF Discord channel](https://discord.com/invite/jmRHpDRnH4). \ No newline at end of file + We would like to here from you. If you have questions, topics for discussion, ideas to share, or feedback, reach us through the [**OpenNTF Discord channel**](https://discord.com/invite/jmRHpDRnH4). \ No newline at end of file diff --git a/docs/.snippets/helmversion.md b/docs/.snippets/helmversion.md index 8729a2f1..f432addd 100644 --- a/docs/.snippets/helmversion.md +++ b/docs/.snippets/helmversion.md @@ -1 +1 @@ -See [Volt MX Go and Helm chart version compatibility](../references/compatibilitymatrix.md#volt-mx-go-and-helm-chart-version-compatibility) to know the latest Helm chart version. \ No newline at end of file +See [**Volt MX Go and Helm chart version compatibility**](../references/compatibilitymatrix.md#volt-mx-go-and-helm-chart-version-compatibility) to know the latest Helm chart version. \ No newline at end of file diff --git a/docs/howto/accessdrapi.md b/docs/howto/accessdrapi.md index 88b39dbd..c9d4bb1b 100644 --- a/docs/howto/accessdrapi.md +++ b/docs/howto/accessdrapi.md @@ -6,13 +6,13 @@ Access Domino REST API Admin UI so you can add and configure a schema, add a sco ## Before you begin -You must complete the [Volt MX Go installation](../tutorials/installation.md). +You must complete the [**Volt MX Go installation**](../tutorials/installation.md). ## Procedure ### For Domino REST API installed via an installer -- Check how to login to [Domino REST API Admin UI](https://opensource.hcltechsw.com/Domino-rest-api/tutorial/adminui.html#login){: target="_blank" rel="noopener noreferrer"}. +- Check how to login to [**Domino REST API Admin UI**](https://opensource.hcltechsw.com/Domino-rest-api/tutorial/adminui.html#login) in the HCL Domino REST API documentation. - Use your Domino server administrator username and password to log in. ### For Domino REST API installed as part of the installation on a development or test only environment @@ -24,10 +24,10 @@ You must complete the [Volt MX Go installation](../tutorials/installation.md). - password: `password` !!!note - If you updated the administrator's first name, last name, and password in the `values.yaml` file in the [Download the Domino REST API Helm chart](../tutorials/downloadhelmchart.md#1-download-the-domino-rest-api-helm-chart) procedure, use the updated values for the username and password. + If you updated the administrator's first name, last name, and password in the `values.yaml` file in the [**Download the Domino REST API Helm chart**](../tutorials/downloadhelmchart.md#1-download-the-domino-rest-api-helm-chart) procedure, use the updated values for the username and password. 3. Click **Log in**. -## Expected result   +## Expected result -A successful login leads you to the Domino REST API landing page. For details on adding and configuring a schema, adding a scope and an application, see [Using Admin UI](https://opensource.hcltechsw.com/Domino-rest-api/references/usingwebui/index.html){: target="_blank" rel="noopener noreferrer"} in the Domino REST API documentation. +A successful login leads you to the Domino REST API landing page. For details on adding and configuring a schema, adding a scope and an application, see [**Using Admin UI**](https://opensource.hcltechsw.com/Domino-rest-api/references/usingwebui/index.html) in the HCL Domino REST API documentation. diff --git a/docs/howto/diagents.md b/docs/howto/diagents.md index 68a2f49e..1b26f6f9 100644 --- a/docs/howto/diagents.md +++ b/docs/howto/diagents.md @@ -4,7 +4,7 @@ **Domino Agents** which are part the HCL Domino are part of the `nsf` that only Domino Designer can be able to modify. These `nsf` will be able to use by the Domino REST API to be able to use it for other services. Only those configured Agents in a `nsf` will be available to amend by the Domino REST API. These **Agents** will be imported to Volt MX Go Iris as part of the Design Import. -For more information, see [Agents](https://help.hcltechsw.com/dom_designer/11.0.1/basic/H_ABOUT_DESIGNING_AGENTS.html){: target="_blank" rel="noopener noreferrer"}. +For more information, see [**Agents**](https://help.hcltechsw.com/dom_designer/14.0.0/basic/H_ABOUT_DESIGNING_AGENTS.html) in the HCL Domino Designer documentation. ## About this task @@ -16,7 +16,7 @@ Shows you how the **Agents** are imported to the Volt MX Iris Go Design Import. ## Procedure -1. You must finished the procedure [importing Domino Application](../tutorials/designimport.md#import-a-domino-application-using-a-new-volt-mx-go-foundry-app). +1. You must finish the procedure [**importing Domino Application**](../tutorials/designimport.md#import-a-domino-application-using-a-new-volt-mx-go-foundry-app). !!!important - For the Volt MX Go release v2.0.4, only limited Agents are supported. diff --git a/docs/howto/drapiingress.md b/docs/howto/drapiingress.md index 361026fc..bef91261 100644 --- a/docs/howto/drapiingress.md +++ b/docs/howto/drapiingress.md @@ -1,7 +1,5 @@ # Configure Kubernetes Ingress for Domino REST API - - --8<-- "devtestenvironment.md" ## About this task @@ -29,15 +27,15 @@ Familiarize yourself with the various properties and parameters related to Kuber - **ingress.tls.drapiCustomCert**: Use to specify a Custom SSL certificate for Domino REST API. If `ingress.tls.drapiCustomCert.cert` and `ingress.tls.drapiCustomCert.key` are not set, the Cluster SSL certificate will be used for TLS. - - **ingress.tls.drapiCustomCert.cert**: The file name for the custom certificate. Place your SSL certificate file in the top level direct `drapi` directory (where `values.yaml` is located). The value of this property should be a file path of the form `my-drapi-custom-cert.cert` where my-drapi-custom-cert.cert is the name of your certificate file. This certificate must be in DER format as per [Section 5.1 of RFC 7468](https://datatracker.ietf.org/doc/html/rfc7468#section-5.1){: target="_blank" rel="noopener noreferrer"}. + - **ingress.tls.drapiCustomCert.cert**: The file name for the custom certificate. Place your SSL certificate file in the top level direct `drapi` directory (where `values.yaml` is located). The value of this property should be a file path of the form `my-drapi-custom-cert.cert` where my-drapi-custom-cert.cert is the name of your certificate file. This certificate must be in DER format as per [**Section 5.1 of RFC 7468**](https://datatracker.ietf.org/doc/html/rfc7468#section-5.1). - - **ingress.tls.drapiCustomCert.key**: The file name for the custom key. Place your SSL certificate key file in the top level direct 'drapi' directory (where values.yaml is located). The value of this property should be of the form `my-drapi-custom-cert.key` where my-drapi-custom-cert.key is the name of your private key file. The key file must be PKCS #8 in DER format [Section 11 of RFC 7468](https://datatracker.ietf.org/doc/html/rfc7468#section-11){: target="_blank" rel="noopener noreferrer"}. + - **ingress.tls.drapiCustomCert.key**: The file name for the custom key. Place your SSL certificate key file in the top level direct 'drapi' directory (where values.yaml is located). The value of this property should be of the form `my-drapi-custom-cert.key` where my-drapi-custom-cert.key is the name of your private key file. The key file must be PKCS #8 in DER format [**Section 11 of RFC 7468**](https://datatracker.ietf.org/doc/html/rfc7468#section-11). - **ingress.tls.drapiManagementCustomCert**: Use to specify a Custom SSL certificate for Domino REST API. If `ingress.tls.drapiCustomCert.cert` and `ingress.tls.drapiCustomCert.key` are not set, then the Cluster SSL certificate will be used for TLS. - - **ingress.tls.drapiManagementCustomCert.cert**: The file name for the custom certificate. Place your SSL certificate file in the top level direct `drapi` directory (where `values.yaml` is located). The value of this property should be a file path of the form `my-drapi-mgmt-custom-cert.cert` where my-drapi-mgmtcustom-cert.cert is the name of your certificate file. This certificate must be in DER format as per [Section 5.1 of RFC 7468](https://datatracker.ietf.org/doc/html/rfc7468#section-5.1){: target="_blank" rel="noopener noreferrer"}. + - **ingress.tls.drapiManagementCustomCert.cert**: The file name for the custom certificate. Place your SSL certificate file in the top level direct `drapi` directory (where `values.yaml` is located). The value of this property should be a file path of the form `my-drapi-mgmt-custom-cert.cert` where my-drapi-mgmtcustom-cert.cert is the name of your certificate file. This certificate must be in DER format as per [**Section 5.1 of RFC 7468**](https://datatracker.ietf.org/doc/html/rfc7468#section-5.1). - - **ingress.tls.drapiManagementCustomCert.key**: The file name for the custom key. Place your SSL certificate key file in the top level direct 'drapi' directory (where values.yaml is located). The value of this property should be of the form `my-drapi-mgmt-custom-cert.key` where my-drapi-mgmt-custom-cert.key is the name of your private key file. The key file must be PKCS #8 in DER format [Section 11 of RFC 7468](https://datatracker.ietf.org/doc/html/rfc7468#section-11){: target="_blank" rel="noopener noreferrer"}. + - **ingress.tls.drapiManagementCustomCert.key**: The file name for the custom key. Place your SSL certificate key file in the top level direct 'drapi' directory (where values.yaml is located). The value of this property should be of the form `my-drapi-mgmt-custom-cert.key` where my-drapi-mgmt-custom-cert.key is the name of your private key file. The key file must be PKCS #8 in DER format [**Section 11 of RFC 7468**](https://datatracker.ietf.org/doc/html/rfc7468#section-11). - **ingress.annotations**: Allows you to specify additional annotations that will be added to every ingress object. Add one annotation per line. Each annotation should be indented 2 spaces and of the format `annotationName: value`. When rendered, your annotation value will automatically be quoted. @@ -47,11 +45,11 @@ Familiarize yourself with the various properties and parameters related to Kuber You can configure Kubernetes Ingress to accept connections over HTTP or HTTPS. HTTP isn't secure but works without any extra configuration. It's recommended to use HTTPS for most deployments. !!!note - You can't easily change the deployment domain name once installed, this includes changing from HTTP to HTTPS. For more information, see [How to change Hostname/IP address and port details of Volt MX Go Foundry Server?](https://support.hcltechsw.com/csm?id=kb_article&sysparm_article=KB0089025){: target="_blank" rel="noopener noreferrer"}. + You can't easily change the deployment domain name once installed, this includes changing from HTTP to HTTPS. For more information, see [**How to change Hostname/IP address and port details of Volt MX Go Foundry Server?**](https://support.hcltechsw.com/csm?id=kb_article&sysparm_article=KB0089025). One approach to enable HTTPS is to use a self-signed SSL certificate, which avoids purchasing your own certificate from a Certificate Authority (CA). However, since Volt MX Go Foundry makes back-end server to server requests between applications, there are more steps to enable Volt MX Go Foundry to trust the secured communication channel when utilizing a self-signed certificate. -If you configure your Kubernetes Ingress to use a self-signed SSL certificate or an SSL certificate from your enterprise's own Certificate Authority that's not within a trusted root certification path, or if you use the cluster default cert created from a self-signed CA, you need to add the SSL certificate or CA certificate to the trust store used by Tomcat. Failure to do so results in runtime errors when Volt MX Go Foundry components need to communicate with each other. For more information, see [Certification Authority Trust Model](http://technet.microsoft.com/en-us/library/cc962065.aspx){: target="_blank" rel="noopener noreferrer"}. +If you configure your Kubernetes Ingress to use a self-signed SSL certificate or an SSL certificate from your enterprise's own Certificate Authority that's not within a trusted root certification path, or if you use the cluster default cert created from a self-signed CA, you need to add the SSL certificate or CA certificate to the trust store used by Tomcat. Failure to do so results in runtime errors when Volt MX Go Foundry components need to communicate with each other. For more information, see [**Certification Authority Trust Model**](http://technet.microsoft.com/en-us/library/cc962065.aspx). ## Procedure @@ -63,9 +61,9 @@ If you configure your Kubernetes Ingress to use a self-signed SSL certificate or You can use any of the following options: - Purchase a certificate from a trusted Certificate Authority -- Obtain a free certificate from [Let's Encrypt](https://letsencrypt.org/){: target="_blank" rel="noopener noreferrer"} or [ZeroSSL](https://zerossl.com){: target="_blank" rel="noopener noreferrer"}. -- For test purposes, [create a self-signed certificate](#create-a-self-signed-certificate). -- Use the [Kubernetes default cluster certificate](#obtain-default-cluster-certificate) by pulling it from your cluster. +- Obtain a free certificate from [**Let's Encrypt**](https://letsencrypt.org/) or [**ZeroSSL**](https://zerossl.com). +- For test purposes, [**create a self-signed certificate**](#create-a-self-signed-certificate). +- Use the [**Kubernetes default cluster certificate**](#obtain-default-cluster-certificate) by pulling it from your cluster. #### Create a self-signed certificate @@ -102,7 +100,7 @@ The following procedure could be used to generate a self-signed certificate: cat drapi-server.crt | sed -ne '/-BEGIN CERTIFICATE/,/END CERTIFICATE/p' > ./drapi-server.pem ``` -5. Proceed to [import drapi-server.pem into the trust store](#3-import-certificate-into-the-truststore-with-keytool). +5. Proceed to [**import drapi-server.pem into the trust store**](#3-import-certificate-into-the-truststore-with-keytool). #### Obtain default Cluster Certificate @@ -116,7 +114,7 @@ The following procedure could be used to generate a self-signed certificate: The parameter following `-connect` must be a DNS name or IP address that resolves to your OpenShift ingress. The `-servername` parameter specifies the DNS name you use to access your Volt MX Go Foundry deployment. This should match the value you specified for `serverDomainName` in `values.yaml`. The DNS names could be the same as long as they resolve to the IP address of your Kubernetes load balancer in front of Ingress or Ingress itself. -2. Proceed to [Import the Certificate into the truststore with keytool](#3-import-certificate-into-the-truststore-with-keytool). +2. Proceed to [**Import the Certificate into the truststore with keytool**](#3-import-certificate-into-the-truststore-with-keytool). ### 2. Copy your SSL certificates and keys into the Domino REST API top level directory @@ -133,7 +131,7 @@ The following procedure could be used to generate a self-signed certificate: cp ~/drapi-management-server.key . ``` -2. [Update parameters in `values.yaml`](#4-update-the-helm-valuesyaml) with these file names. +2. [**Update parameters in `values.yaml`**](#4-update-the-helm-valuesyaml) with these file names. ### 3. Import certificate into the truststore with keytool @@ -155,13 +153,13 @@ keytool -import -alias drapi2 -file ./drapi-server.pem -keypass changeit -storep - `-keystore ../foundry/voltmx-foundry/certs/cacerts` is the location of the truststore your certificate will be imported to and later use by Tomcat. This file path shouldn't be changed. - `changeit` is the default password and shouldn't be changed. -For more information about `keytool`, see [Java Keytool documentation](https://docs.oracle.com/en/java/javase/11/tools/keytool.html){: target="_blank" rel="noopener noreferrer"}. +For more information about `keytool`, see [Java Keytool documentation](https://docs.oracle.com/en/java/javase/11/tools/keytool.html. ### 4. Update the Helm `values.yaml` - Update your `values.yaml` with the following configuration details to properly configure SSL. - Check the notes for specific use cases and refer to Kubernetes Ingress details in [Before you begin](#before-you-begin) for more details on each parameter. + Check the notes for specific use cases and refer to Kubernetes Ingress details in [**Before you begin**](#before-you-begin) for more details on each parameter. ``` bash diff --git a/docs/howto/index.md b/docs/howto/index.md index 0ef10c57..a2272ae6 100644 --- a/docs/howto/index.md +++ b/docs/howto/index.md @@ -2,14 +2,12 @@ How-to guides instruct users in completing key goals and tasks related to Volt MX Go. -- [Install](howtoinstall.md) -- [Design Import](diindex.md) -- [VoltFormula](vfindex.md) -- [First Touch](ftindex.md) -- [Operation](genindex.md) - - -- [Uninstall](uninstall.md) +- [**Install**](howtoinstall.md) +- [**Design Import**](diindex.md) +- [**VoltFormula**](vfindex.md) +- [**First Touch**](ftindex.md) +- [**Operation**](genindex.md) +- [**Uninstall**](uninstall.md) diff --git a/docs/howto/insertattachments.md b/docs/howto/insertattachments.md index 7f2e157e..2ef41b13 100644 --- a/docs/howto/insertattachments.md +++ b/docs/howto/insertattachments.md @@ -6,8 +6,8 @@ Guides you on how to insert attachments via the [Summernote Editor](../reference ## Before you begin -- You have [generated CRUD forms for Object Service](codegen.md). -- You have [built and published your app in Volt MX Go Iris](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_user_guide/Content/Cloud_Build_in_VoltMX_Iris.html#post-successful-build){: target="_blank" rel="noopener noreferrer"}. +- You have [**generated CRUD forms for Object Service**](codegen.md). +- You have [**built and published your app in Volt MX Go Iris**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_user_guide/Content/Cloud_Build_in_VoltMX_Iris.html#post-successful-build). !!!note "Important" Make sure that you included the virtual field `$FILES` in the form configured in Domino REST API. @@ -61,4 +61,4 @@ You can download attachments from the Grid or Details form of a document. - To download all attachments, click **Download All Attachments**. - To download an individual attachment, click the attachment file link on the rich text field. -To learn more about attachments, see [Attachments](../topicguides/method.md#attachments). \ No newline at end of file +To learn more about attachments, see [**Attachments**](../topicguides/method.md#attachments). \ No newline at end of file diff --git a/docs/howto/k3suninstall.md b/docs/howto/k3suninstall.md index 24da6518..c4337e3b 100644 --- a/docs/howto/k3suninstall.md +++ b/docs/howto/k3suninstall.md @@ -14,4 +14,4 @@ Guides you in uninstalling K3s in case you want to start over with the K3s insta sudo k3s-uninstall.sh ``` -For more information, see [Uninstalling K3s](https://docs.k3s.io/installation/uninstall){: target="_blank" rel="noopener noreferrer"}. \ No newline at end of file +For more information, see [**Uninstalling K3s**](https://docs.k3s.io/installation/uninstall). \ No newline at end of file diff --git a/docs/howto/uninstall.md b/docs/howto/uninstall.md index 6ea5f561..ece148be 100644 --- a/docs/howto/uninstall.md +++ b/docs/howto/uninstall.md @@ -5,8 +5,8 @@ List of uninstall procedures for completing uninstall tasks related to Volt MX G - [Uninstall K3s](k3suninstall.md) - [Uninstall Rancher Desktop on Windows](rancheruninstall.md) - [Uninstall First Touch](uninstallfirsttouch.md) -- [Uninstall Volt MX Go Foundry for Linux](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_linux_install_guide/Content/Uninstalling_VoltMX_Foundry.html){: target="_blank" rel="noopener noreferrer"} -- [Uninstall Volt MX Go Foundry for Windows](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_windows_install_guide/Content/Uninstalling_VoltMX_Foundry.html){: target="_blank" rel="noopener noreferrer"} -- [Uninstall Volt MX Go Foundry installled on supported Kubernetes platform](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmxfoundry_containers_helm/Content/Installing_Containers_With_Helm.html#uninstalling-foundry){: target="_blank" rel="noopener noreferrer"} -- [Uninstall Volt MX Go Iris for Windows](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_starter_install_win/Content/Uninstalling%20VoltMX%20Iris.html){: target="_blank" rel="noopener noreferrer"} -- [Uninstall Volt MX Go Iris for Mac](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_starter_install_mac/Content/Uninstalling%20VoltMX%20Iris.html){: target="_blank" rel="noopener noreferrer"} \ No newline at end of file +- [Uninstall Volt MX Go Foundry for Linux](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_linux_install_guide/Content/Uninstalling_VoltMX_Foundry.html) +- [Uninstall Volt MX Go Foundry for Windows](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_windows_install_guide/Content/Uninstalling_VoltMX_Foundry.html) +- [Uninstall Volt MX Go Foundry installled on supported Kubernetes platform](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmxfoundry_containers_helm/Content/Installing_Containers_With_Helm.html#uninstalling-foundry) +- [Uninstall Volt MX Go Iris for Windows](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_starter_install_win/Content/Uninstalling%20VoltMX%20Iris.html) +- [Uninstall Volt MX Go Iris for Mac](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_starter_install_mac/Content/Uninstalling%20VoltMX%20Iris.html) \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 6e1439f4..759ada1c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -13,7 +13,7 @@ Volt MX Go modernizes and extends the value of your Domino applications with the - expanding who can code applications built in Domino, allowing for app modernization or migration without requiring a complete rewrite of the code - importing existing Domino views, forms, and fields into Volt MX Go Foundry to get a head start on your Volt MX Go applications -To learn more, see [**Introducing Volt MX Go**](topicguides/introvoltmxgo.md). +To learn more, see [**Introducing Volt MX Go**](topicguides/introvoltmxgo.md "Links to the topic introducing Volt MX Go"){aria-label="This is a link"}. --- ## Get started diff --git a/docs/references/summernotewidget.md b/docs/references/summernotewidget.md index 28feda9e..1c6b1efe 100644 --- a/docs/references/summernotewidget.md +++ b/docs/references/summernotewidget.md @@ -32,7 +32,7 @@ Methods are used by the form to interact with the Summernote Editor component. 3. In the **Properties** pane, click the **Action** tab. 4. Click **Manage Methods** to open the **Manage Methods** dialog. -You can now configure the component methods. For more information, see [**Manage Methods**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_user_guide/Content/C_CreatingComponent.html#manage-methods-of-a-component-with-a-contract) in the Volt MX Documentation. +You can now configure the component methods. For more information, see [**Manage Methods**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_user_guide/Content/C_CreatingComponent.html#manage-methods-of-a-component-with-a-contract) in the HCL Volt MX Documentation. **Methods** @@ -69,7 +69,7 @@ You need a default property to build the Summernote Editor component. The table 3. In the **Properties** pane, click the **Component** tab. 4. Click **Manage Properties** to open the **Manage Properties** dialog. -You can now configure the component properties. For more information, see [**Manage Properties**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_user_guide/Content/C_CreatingComponent.html#manage-properties-of-a-component-with-a-contract) in the Volt MX Documentation. +You can now configure the component properties. For more information, see [**Manage Properties**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_user_guide/Content/C_CreatingComponent.html#manage-properties-of-a-component-with-a-contract) in the HCL Volt MX Documentation. **Properties** diff --git a/docs/references/whatsnew/v201.md b/docs/references/whatsnew/v201.md index 9c1e4adf..f1672680 100644 --- a/docs/references/whatsnew/v201.md +++ b/docs/references/whatsnew/v201.md @@ -87,7 +87,7 @@ and User environment category on the Notes Formula. ## VoltScript Early Access -*VoltScript* is a [BASIC](https://en.wikipedia.org/wiki/BASIC){: target="_blank" rel="noopener noreferrer"} scripting language for use with HCL Volt MX Go as a server-side scripting language running within the Foundry middleware layer. *VoltScript* includes: +*VoltScript* is a [BASIC](https://en.wikipedia.org/wiki/BASIC) scripting language for use with HCL Volt MX Go as a server-side scripting language running within the Foundry middleware layer. *VoltScript* includes: - Visual Studio Code extension for allowing developers to write code in VS Code - Linux Docker image for allowing Mac developers to use the VS Code extension @@ -96,4 +96,4 @@ and User environment category on the Notes Formula. - A toolkit for scaffolding the various VoltScript extensions and script code and autogenerating starter code and related documentation - Various VoltScript Extensions for supporting various processes, such as data access over HTTP to specific or generic REST services, handling JSON data, interacting with the operating system and files, managing input parameters -To learn more about the **early access version** of VoltScript and related components, see [VoltScript Documentation](https://help.hcltechsw.com/docs/voltscript/early-access/index.html){: target="_blank" rel="noopener noreferrer"}. \ No newline at end of file +To learn more about the **early access version** of VoltScript and related components, see [VoltScript Documentation](https://help.hcltechsw.com/docs/voltscript/early-access/index.html). \ No newline at end of file diff --git a/docs/references/whatsnew/v202.md b/docs/references/whatsnew/v202.md index 77dc7b9f..966dc1a5 100644 --- a/docs/references/whatsnew/v202.md +++ b/docs/references/whatsnew/v202.md @@ -16,7 +16,7 @@ ## Improvements -- Volt IQ capabilities are now functional in Volt MX Go. For more information, see [Volt IQ](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_user_guide/Content/Volt_IQ.html){: target="_blank" rel="noopener noreferrer"} in the Volt MX documentation. +- Volt IQ capabilities are now functional in Volt MX Go. For more information, see [Volt IQ](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_user_guide/Content/Volt_IQ.html) in the HCL Volt MX documentation. - You can now build Windows and macOS Desktop applications with the latest release of Volt MX Go. ### Domino Adapter diff --git a/docs/references/whatsnew/v203.md b/docs/references/whatsnew/v203.md index b0507cd0..6754e589 100644 --- a/docs/references/whatsnew/v203.md +++ b/docs/references/whatsnew/v203.md @@ -152,4 +152,4 @@ The **Early Access v2 release** of *VoltScript* is now available and features a new VoltScript Extension for manipulating XML documents, *XMLVSE*, many improvements for existing VSEs and VSCode extensions, and a preview of an interactive debugger for VoltScript. -To learn more about the **Early Access v2 release** of VoltScript and related components, see [VoltScript Documentation](https://help.hcltechsw.com/docs/voltscript/early-access/index.html){: target="_blank" rel="noopener noreferrer"}. \ No newline at end of file +To learn more about the **Early Access v2 release** of VoltScript and related components, see [VoltScript Documentation](https://help.hcltechsw.com/docs/voltscript/early-access/index.html). \ No newline at end of file diff --git a/docs/topicguides/declvariables.md b/docs/topicguides/declvariables.md index 464eca1a..9a417efb 100644 --- a/docs/topicguides/declvariables.md +++ b/docs/topicguides/declvariables.md @@ -20,7 +20,7 @@ There are two mechanisms by which the Rosetta Converter accepts and converts var ## Using JSP style syntax -The converter uses **JSP expression** syntax in **OpenFormula** formulas to provide capabilities for formula conversion not currently possible with strict OpenFormula syntax. For more information, see [**JSP expression syntax**](https://docs.oracle.com/javaee/5/tutorial/doc/bnaov.html){: target="_blank" rel="noopener noreferrer"}. +The converter uses **JSP expression** syntax in **OpenFormula** formulas to provide capabilities for formula conversion not currently possible with strict OpenFormula syntax. For more information, see [**JSP expression syntax**](https://docs.oracle.com/javaee/5/tutorial/doc/bnaov.html). Example: diff --git a/docs/topicguides/dominoadapter.md b/docs/topicguides/dominoadapter.md index dfefd281..6e8d26a3 100644 --- a/docs/topicguides/dominoadapter.md +++ b/docs/topicguides/dominoadapter.md @@ -17,4 +17,4 @@ The `object` of the Object service essentially has two components: - [**Data Model**](datamodel.md) - refers to the definition of the fields that comprise the object definition - [**Methods**](method.md) - verbs for interacting with the data, for example GET, POST -For more information, see [**Object Services**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_user_guide/Content/Objectservices.html) in the Volt MX documentation. +For more information, see [**Object Services**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_user_guide/Content/Objectservices.html) in the HCL Volt MX documentation. diff --git a/docs/topicguides/method.md b/docs/topicguides/method.md index ab7fb300..1477fd17 100644 --- a/docs/topicguides/method.md +++ b/docs/topicguides/method.md @@ -166,7 +166,7 @@ The Volt MX SDK has CRUD functions allowing an end-user application to use the R Using the binary APIs with Domino Adapter requires more properties in the functional call. You need to add an object with a `queryParams` key to the options argument of the `createBinaryContent`. The object should contain query parameters required for using the binary APIs with Domino Adapter, including `unid` and `name` parameters. !!!note - - For more information, see the general use of the [**binary APIs from the Volt MX SDK**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_user_guide/Content/ObjectsAPIReference/OnlineObjectService_Class.html#getbinarycontent-method) in the Volt MX documentation. + - For more information, see the general use of the [**binary APIs from the Volt MX SDK**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_user_guide/Content/ObjectsAPIReference/OnlineObjectService_Class.html#getbinarycontent-method) in the HCL Volt MX documentation. - There is no function in the Volt MX SDK for calling `deleteBinary`. ???example "Refer to the code examples for using the SDK's binary functions." diff --git a/docs/tutorials/adaptertutorial.md b/docs/tutorials/adaptertutorial.md index f46df8f4..c3d6d3ce 100644 --- a/docs/tutorials/adaptertutorial.md +++ b/docs/tutorials/adaptertutorial.md @@ -2,14 +2,14 @@ The tutorial guides you through the Domino Adapter process in Volt MX Go. You will create an app in Volt MX Go Foundry and connect the app to your Domino database as an endpoint via the Domino REST API. You will then configure a data model and test the methods, including standard CRUD operations, for interacting with the data model. -For more information, see [Data models](../topicguides/datamodel.md) and [Methods](../topicguides/method.md). +For more information, see [**Data models**](../topicguides/datamodel.md) and **[Methods**](../topicguides/method.md). At the end of this tutorial, you can manually create an app in Volt MX Go Foundry and create an Identity Service and Object Service to connect your app to your Domino database via Domino REST API. ## Before you begin -- You have completed the [Volt MX Go installation](installation.md). -- You have a [Volt MX Go Foundry admin account](../howto/foundryadminaccount.md). +- You have completed the [**Volt MX Go installation**](installation.md). +- You have a [**Volt MX Go Foundry admin account**](../howto/foundryadminaccount.md). !!!tip The following actions might require certain Domino access rights. Contact your Domino Administrator/Domino REST API Administrator for assistance. @@ -18,10 +18,10 @@ At the end of this tutorial, you can manually create an app in Volt MX Go Foundr - You have at least an *Editor* access to the Domino Keep Configuration database `keepconfig.nsf` to create a scope and OAuth application for the Domino application. - You have the correct access level to the Domino database to test the CRUD operations. - For more information, see [Access Levels in the ACL](https://help.hcltechsw.com/domino/14.0.0/admin/conf_accesslevelsintheacl_c.html){: target="_blank" rel="noopener noreferrer"} or contact your Domino/Domino REST API administrator. + For more information, see [**Access Levels in the ACL**](https://help.hcltechsw.com/domino/14.0.0/admin/conf_accesslevelsintheacl_c.html) in the HCL Domino documentation or contact your Domino/Domino REST API administrator. -- You have added a schema, activated the forms of the schema, and added a `dql` mode similar to the `default` mode to each activated form in Domino REST API. For more information, see [Schema Management](https://opensource.hcltechsw.com/Domino-rest-api/references/usingwebui/schemaui.html){: target="_blank" rel="noopener noreferrer"}. -- You have added a scope for your schema in Domino REST API. For more information, see [Scope Management](https://opensource.hcltechsw.com/Domino-rest-api/references/usingwebui/scopeui.html){: target="_blank" rel="noopener noreferrer"}. +- You have added a schema, activated the forms of the schema, and added a `dql` mode similar to the `default` mode to each activated form in Domino REST API. For more information, see [**Schema Management**](https://opensource.hcltechsw.com/Domino-rest-api/references/usingwebui/schemaui.html). +- You have added a scope for your schema in Domino REST API. For more information, see [**Scope Management**](https://opensource.hcltechsw.com/Domino-rest-api/references/usingwebui/scopeui.html). ## Log in to Volt MX Go Foundry @@ -43,7 +43,7 @@ At the end of this tutorial, you can manually create an app in Volt MX Go Foundr 3. Click the **Edit App Name** icon to give a unique name to your app. !!!tip - For more information, see [How to Add Applications](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_user_guide/Content/Adding_Applications.html){: target="_blank" rel="noopener noreferrer"} in the HCL Volt MX documentation. + For more information, see [**How to Add Applications**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_user_guide/Content/Adding_Applications.html) in the HCL Volt MX documentation. ## Configure an Identity service @@ -95,7 +95,7 @@ At the end of this tutorial, you can manually create an app in Volt MX Go Foundr 3. Enter the App Secret of your app in Domino REST API in the **Client Secret** text box. !!!tip - The App ID and App Secret are generated when you add an app in Domino REST API. For more information, see [Application Management](https://opensource.hcltechsw.com/Domino-rest-api/references/usingwebui/appui.html){: target="_blank" rel="noopener noreferrer"} in the Domino REST API documentation. + The App ID and App Secret are generated when you add an app in Domino REST API. For more information, see [**Application Management**](https://opensource.hcltechsw.com/Domino-rest-api/references/usingwebui/appui.html) in the Domino REST API documentation. 6. Under **Advanced**: @@ -150,7 +150,7 @@ At the end of this tutorial, you can manually create an app in Volt MX Go Foundr 3. Enter *true* or *false* in the **Return documents from Bulk Update** text field. By default, the value is set to *true*. !!!note - Entering true in the **Return documents from Bulk Update** text field ensures the return of documents updated using the BULK UPDATE method. For more information, see [Methods](../topicguides/method.md). + Entering true in the **Return documents from Bulk Update** text field ensures the return of documents updated using the BULK UPDATE method. For more information, see [**Methods**](../topicguides/method.md). !!!tip To test the connection parameters, select the environment you added from the **Select an Environment** drop-down list and then click **Test Connection**. You will see a *Connection Successful* message if the configured connection parameters are correct. @@ -182,7 +182,7 @@ At the end of this tutorial, you can manually create an app in Volt MX Go Foundr !!!tip - You can change the data model object names of the selected forms and view entities. - - For more information on naming limitations, see [naming limitations](../references/knownlimitation.md#naming). + - For more information on naming limitations, see [**Known limitations**](../references/knownlimitation.md#naming). 5. Click **Generate**. The forms and view entities are now added to the **Data Model**. @@ -210,7 +210,7 @@ At the end of this tutorial, you can manually create an app in Volt MX Go Foundr 4. Click **Save** after viewing. -For more information on supported parameters, see [Supported OData query parameters for form-based GET method](../topicguides/method.md#supported-odata-query-parameters-for-form-based-get-method) and [Supported OData query parameters for view-based GET method](../topicguides/method.md#supported-odata-query-parameters-for-view-based-get-method). +For more information on supported parameters, see [**Supported OData query parameters for form-based GET method**](../topicguides/method.md#supported-odata-query-parameters-for-form-based-get-method) and [**Supported OData query parameters for view-based GET method**](../topicguides/method.md#supported-odata-query-parameters-for-view-based-get-method). ## Test the POST method by creating a record @@ -270,9 +270,6 @@ For more information on supported parameters, see [Supported OData query paramet 4. In the **Request Payload**, the fields of the data model should be displaying. 5. Beside the fields, input the updated values, then click **Send**. - - ![Input updated values](../assets/images/patchrequest.png){: style="height:60%;width:60%"} The **Response** console shows the fields with updated values and the number of updated records. diff --git a/docs/tutorials/designimport.md b/docs/tutorials/designimport.md index a91cc8a1..7a9d6cc5 100644 --- a/docs/tutorials/designimport.md +++ b/docs/tutorials/designimport.md @@ -12,40 +12,40 @@ The tutorial implements two user experiences: ## Before you begin !!!info - If you have granted access to any of the following roles: **Volt MX Go Foundry admin, Domino REST API admin,** or the **Volt MX Go Iris developer**, please follow the specific instructions for **each user**. + If you are granted access to any of the following roles: **Volt MX Go Foundry admin, Domino REST API admin,** or the **Volt MX Go Iris developer**, please follow the specific instructions for **each user**. ### For Volt MX Go Foundry admin -- You must the [Volt MX Go installation](installfoundry.md). +- You must complete the [**Volt MX Go installation**](installfoundry.md). - You must create a Volt MX Go Foundry admin account to the Volt MX Go Iris developer. ### For Domino REST API admin -- You have completed the [Domino REST API installation](https://opensource.hcltechsw.com/Domino-rest-api/tutorial/installconfig/index.html). +- You have completed the [**Domino REST API installation**](https://opensource.hcltechsw.com/Domino-rest-api/tutorial/installconfig/index.html). - You have at least an *Editor* access to the *Domino Keep Configuration database* `keepconfig.nsf` to create a scope and Domino REST API application. - You have set up Domino REST API with a specified Domino database `.nsf`, schema, scopes, and application. -- When you configure the `schema`, [set the views to Active status](https://opensource.hcltechsw.com/Domino-rest-api/references/usingwebui/schemaui.html#activate-a-view){: target="_blank" rel="noopener noreferrer"}. +- When you configure the `schema`, [**set the views to Active status**](https://opensource.hcltechsw.com/Domino-rest-api/references/usingwebui/schemaui.html#activate-a-view). -- When you configure the `schema`, include the `$Files` field in the configured form. This is to capture the uploading and downloading of files in the Design Import. For more information, see [step numer 3 in Change form configuration](https://opensource.hcltechsw.com/Domino-rest-api/references/usingwebui/schemaui.html#change-form-configuration){: target="_blank" rel="noopener noreferrer"}. +- When you configure the `schema`, include the `$Files` field in the configured form. This is to capture the uploading and downloading of files in the Design Import. For more information, see [**step numer 3 in Change form configuration**](https://opensource.hcltechsw.com/Domino-rest-api/references/usingwebui/schemaui.html#change-form-configuration). -- When you configure the `schema`, set the **Mode Formula Settings → Formula for Delete Access** to `@True` in `default` and `dql` mode in all the schema forms. For more information, see [step number 5 in Change form configuration](https://opensource.hcltechsw.com/Domino-rest-api/references/usingwebui/schemaui.html#change-form-configuration){: target="_blank" rel="noopener noreferrer"}. +- When you configure the `schema`, set the **Mode Formula Settings → Formula for Delete Access** to `@True` in `default` and `dql` mode in all the schema forms. For more information, see [**step number 5 in Change form configuration**](https://opensource.hcltechsw.com/Domino-rest-api/references/usingwebui/schemaui.html#change-form-configuration). -- When you configure the `schema`, add the `default` and `dql` modes and must have a matching fields. For more information, see [Cloning modes](https://opensource.hcltechsw.com/Domino-rest-api/references/usingwebui/schemaui.html#clone-a-mode){: target="_blank" rel="noopener noreferrer"}. +- When you configure the `schema`, add the `default` and `dql` modes and must have a matching fields. For more information, see [**Cloning modes**](https://opensource.hcltechsw.com/Domino-rest-api/references/usingwebui/schemaui.html#clone-a-mode). - When you configure `scope`, the scope name must be limited to 30 characters. -- When you configure the `scopes`, set the *Maximum Access Level* to **Designer** or **Manager** ACL role. For more information, see [Add a scope in Domino REST API](https://opensource.hcltechsw.com/Domino-rest-api/references/usingwebui/scopeui.html#add-a-scope){: target="_blank" rel="noopener noreferrer"}. +- When you configure the `scopes`, set the *Maximum Access Level* to **Designer** or **Manager** ACL role. For more information, see [**Add a scope in Domino REST API**](https://opensource.hcltechsw.com/Domino-rest-api/references/usingwebui/scopeui.html#add-a-scope). -- When you configure your Domino REST API app, it's mandatory to add `$SETUP` to Scope field. For more information, see [Application Management](https://opensource.hcltechsw.com/Domino-rest-api/references/usingwebui/appui.html#add-an-application). +- When you configure your Domino REST API app, it's mandatory to add `$SETUP` to Scope field. For more information, see [**Application Management**](https://opensource.hcltechsw.com/Domino-rest-api/references/usingwebui/appui.html#add-an-application). - Provide the Domino REST API URL, Client ID, Client Secret and scope to the Volt MX Go Iris developer from your Domino REST API app. ### For Volt MX Go Iris Developer -- You must install [Volt MX Go Iris](installiris.md) +- You must install [**Volt MX Go Iris**](installiris.md) - You must have a Volt MX Go Foundry admin account. - You must have at least a **Designer role** to the Domino database `.nsf` that you are importing and to the **Domino Keep Configuration Database (`keepconfig.nsf`)**. - You must have your Domino REST API URL, Client ID, Client Secret and scope which comes from the Domino REST API admin. @@ -88,7 +88,7 @@ The tutorial implements two user experiences: 1. On the top menu, select **Project** → **New Project**. 2. On the **What do you want to start with now?** dialog, select **Web App** and click **Next**. - For other platforms, please see [Native App]( ../howto/dicreatenativeapp.md). + For other platforms, please see [**Native App**]( ../howto/dicreatenativeapp.md). ![Design Import Wizard dialog](../assets/images/didevice.png){: style="height:80%;width:80%"} @@ -147,7 +147,7 @@ You can now see your project name in the upper-left corner of the **Volt MX Go I 3. Click **Next**. !!!warning "Important" - If the wizard is terminated, you may proceed with [Import a Domino Application using existing identity service from existing Volt MX Go Foundry app](#import-a-domino-application-using-existing-identity-service-from-existing-volt-mx-go-foundry-app). + If the wizard is terminated, you may proceed with [**Import a Domino Application using existing identity service from existing Volt MX Go Foundry app**](#import-a-domino-application-using-existing-identity-service-from-existing-volt-mx-go-foundry-app). 4. Login with your **Domino credentials** within this wizard dialog and click **Allow**. @@ -159,7 +159,7 @@ You can now see your project name in the upper-left corner of the **Volt MX Go I ![Design Import Wizard dialog](../assets/images/difoundry.png) !!!warning "Important" - The wizard expects to stop if your login credentials don't have *Designer* access in Domino REST API on your scope, or if your Domino database ACL doesn't give you a *Designer* role. For more information, see [troubleshooting](../references/troubleshoot.md#design-import). + The wizard expects to stop if your login credentials don't have *Designer* access in Domino REST API on your scope, or if your Domino database ACL doesn't give you a *Designer* role. For more information, see [**Troubleshooting**](../references/troubleshoot.md#design-import). 5. On **Scope and Forms** @@ -169,11 +169,11 @@ You can now see your project name in the upper-left corner of the **Volt MX Go I 1. Select the **scope** that you’ve configured in Domino REST API. !!!warning "Important" - The scope name should be no more than 30 characters. If it exceeds this limit, a prompt will appear. In this case, contact your Domino REST API admin to configure your scope. Please take note of the prerequisites required for [importing Domino Application](../tutorials/designimport.md#before-you-begin). + The scope name should be no more than 30 characters. If it exceeds this limit, a prompt will appear. In this case, contact your Domino REST API admin to configure your scope. Please take note of the prerequisites required for [**importing Domino Application**](../tutorials/designimport.md#before-you-begin). ![Design Import Wizard dialog](../assets/images/discope.png) - When a **Domino REST API Issues Report** prompt appears, check [Domino REST API schema issues](../references/troubleshoot.md#design-import). + When a **Domino REST API Issues Report** prompt appears, check [**Domino REST API schema issues**](../references/troubleshoot.md#design-import). 2. **Select** or **deselect** the active `forms`, `fields` in each form, `views`, `agents`, `actions` and click **Next**. @@ -193,7 +193,7 @@ You can now see your project name in the upper-left corner of the **Volt MX Go I ![Design Import Wizard dialog](../assets/images/diagents.png) - Follow this link to learn more on [showing Domino Agents as part of the Design Import app](../howto/diagents.md) + Follow this link to learn more on [**showing Domino Agents as part of the Design Import app**](../howto/diagents.md) 6. On **Summary**, review the final `forms`, `fields` in each form, `views` and `agent`, and then click **Build Iris Application**. @@ -255,7 +255,7 @@ Once you click **Done**, each of the selected forms, views, and agents are impor ![Design Import Wizard dialog](../assets/images/didrapi.png) !!!warning "Important" - - It's important to get your **callback URL** in Volt MX Go Foundry and send it to Domino REST API admin. Form more information. see [copy callback URL in Volt MX Go Foundry](#copy-callback-url-in-volt-mx-go-foundry). Be sure that your Domino REST API admin updated the callback URL in your Domino REST API application immediately without closing the wizard. Otherwise, the wizard will close. + - It's important to get your **callback URL** in Volt MX Go Foundry and send it to Domino REST API admin. Form more information. see [**copy callback URL in Volt MX Go Foundry**](#copy-callback-url-in-volt-mx-go-foundry). Be sure that your Domino REST API admin updated the callback URL in your Domino REST API application immediately without closing the wizard. Otherwise, the wizard will close. 2. Click **Next**. @@ -268,7 +268,7 @@ Once you click **Done**, each of the selected forms, views, and agents are impor ![Design Import Wizard dialog](../assets/images/difoundry.png) !!!warning "Important" - The wizard expects to stop if your login credentials don't have *Designer* access in Domino REST API on your scope, or if your Domino database ACL doesn't give you a *Designer* role. For more information, see [troubleshooting](../references/troubleshoot.md#design-import) + The wizard expects to stop if your login credentials don't have *Designer* access in Domino REST API on your scope, or if your Domino database ACL doesn't give you a *Designer* role. For more information, see [**Troubleshooting**](../references/troubleshoot.md#design-import) 5. On **Scope and Forms** @@ -278,11 +278,11 @@ Once you click **Done**, each of the selected forms, views, and agents are impor 1. Select the **scope** that you’ve configured in Domino REST API. !!!warning "Important" - The scope name should be no more than 30 characters. If it exceeds this limit, a prompt will appear. In this case, contact your Domino REST API admin to configure your scope. Please take note of the prerequisites required for [importing Domino Application](../tutorials/designimport.md#before-you-begin). + The scope name should be no more than 30 characters. If it exceeds this limit, a prompt will appear. In this case, contact your Domino REST API admin to configure your scope. Please take note of the prerequisites required for [**importing Domino Application**](../tutorials/designimport.md#before-you-begin). ![Design Import Wizard dialog](../assets/images/discope.png) - When a **Domino REST API Issues Report** prompt appears, check [Domino REST API schema issues](../references/troubleshoot.md#design-import). + When a **Domino REST API Issues Report** prompt appears, check [**Domino REST API schema issues**](../references/troubleshoot.md#design-import). 2. **Select** or **deselect** the active `forms`, `views`, `agents` and `actions` and click **Next**. @@ -302,7 +302,7 @@ Once you click **Done**, each of the selected forms, views, and agents are impor ![Agents tab](../assets/images/diagents.png) - Follow this link to learn more on [showing Domino Agents as part of the Design Import app](../howto/diagents.md) + Follow this link to learn more on [**showing Domino Agents as part of the Design Import app**](../howto/diagents.md). 6. On **Summary**, review the final `forms`, `views` and `agents` you want to import, and then click **Build Iris Application**. @@ -336,18 +336,18 @@ Once you click **Done**, each of the selected forms, views, and agents have impo The Domino REST API admin updates the **Domino Application callback URL** in Domino Application. !!!warning "Important" - You may continue the procedure in **step 4.b** in the [Import a Domino Application using the new Volt MX Go Foundry app](#import-a-domino-application-using-a-new-volt-mx-go-foundry-app). If the wizard was terminated, you may proceed with [Import a Domino Application using existing identity service from existing Volt MX Go Foundry app](#import-a-domino-application-using-existing-identity-service-from-existing-volt-mx-go-foundry-app). + You may continue the procedure in **step 4.b** in the [**Import a Domino Application using the new Volt MX Go Foundry app**](#import-a-domino-application-using-a-new-volt-mx-go-foundry-app). If the wizard was terminated, you may proceed with [**Import a Domino Application using existing identity service from existing Volt MX Go Foundry app**](#import-a-domino-application-using-existing-identity-service-from-existing-volt-mx-go-foundry-app). ## CRUD operation upon importing the Domino database `.nsf` !!!note "Published the web app and native app in Volt MX Go Iris" - Before you can do the CRUD operation in your imported Domino app, you must first build and publish the web and native app in Volt MX Go Iris. - - If your app is a **Web App**, see [Building a Web App](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_microapps/Content/WebPublish.html#publish-a-web-app){: target="_blank" rel="noopener noreferrer"}. + - If your app is a **Web App**, see [**Building a Web App**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_microapps/Content/WebPublish.html#publish-a-web-app) in the HCL Volt MX documentation. - If your app is a **Native App:** - 1. [Configure your mobile app browser](../howto/configmobile.md). - 2. After configuring your mobile app browser, see [Building a Native App](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_user_guide/Content/LocalBuildStarter.html){: target="_blank" rel="noopener noreferrer"} to view the mobile app. + 1. [**Configure your mobile app browser**](../howto/configmobile.md). + 2. After configuring your mobile app browser, see [**Building a Native App**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_user_guide/Content/LocalBuildStarter.html) in the HCL Volt MX documentation to view the mobile app. - Log in to your account in Domino REST API using the newly published imported Domino application. Your configuration in Domino REST API decides what operations you can include in the **design import** form. @@ -368,7 +368,7 @@ Once you click **Done**, each of the selected forms, views, and agents have impo 1. Select the file you want to upload. You can select more than one file to upload. !!!notes - To see the details of uploading size limit, see [HCL Notes and DOMINO file limits](https://help.hcltechsw.com/dom_designer/11.0.1/basic/H_NOTES_AND_DOMINO_KNOWN_LIMITS.html) + To see the details of uploading size limit, see [**HCL Notes and DOMINO file limits**](https://help.hcltechsw.com/dom_designer/14.0.0/basic/H_NOTES_AND_DOMINO_KNOWN_LIMITS.html) in the HCL Domino documentation. 2. Click **Open**. If the file is pre-existing, a dialog prompt appears with the option to overwrite it. @@ -403,7 +403,7 @@ Once you click **Done**, each of the selected forms, views, and agents have impo 2. In the **Dashboard/AllCustomers_Leads** page, search the customer, click the name and select **Edit**. !!!note - If the detail view **DOESN'T show**, check the [Database Views in Domino Rest API](https://opensource.hcltechsw.com/Domino-rest-api/references/usingwebui/schemaui.html#list-available-database-views) under schema, to confirm that the **Database View** is **active** and the columns in the view are added during the import. + If the detail view **DOESN'T show**, check the [**Database Views in Domino Rest API**](https://opensource.hcltechsw.com/Domino-rest-api/references/usingwebui/schemaui.html#list-available-database-views) under schema, to confirm that the **Database View** is **active** and the columns in the view are added during the import. ![Screenshot](../assets/images/dieditdata.png) @@ -417,7 +417,7 @@ Once you click **Done**, each of the selected forms, views, and agents have impo 1. Select the file you want to upload. You can select more than one file to upload. !!!notes - To see the details of uploading size limit, see [HCL Notes and DOMINO file limits](https://help.hcltechsw.com/dom_designer/11.0.1/basic/H_NOTES_AND_DOMINO_KNOWN_LIMITS.html) + To see the details of uploading size limit, see [**HCL Notes and DOMINO file limits**](https://help.hcltechsw.com/dom_designer/14.0.0/basic/H_NOTES_AND_DOMINO_KNOWN_LIMITS.html) 2. Click **Open**. If the file is pre-existing, a dialog prompt will appear with the option to overwrite it. diff --git a/docs/tutorials/downloadhelmchart.md b/docs/tutorials/downloadhelmchart.md index d3570008..0d1ffde9 100644 --- a/docs/tutorials/downloadhelmchart.md +++ b/docs/tutorials/downloadhelmchart.md @@ -33,7 +33,7 @@ The procedure guides you in downloading the Domino REST API Helm chart and deplo 4. Edit the `values.yaml` file using your preferred editor to update the file with your HCL Container Repository credentials, and the DNS name settings. - 1. Locate the following lines in the file and replace `your-email` and `your-authentication-token` with your [email and authentication token](obtainauthenticationtoken.md) used with the HCL Container Repository: + 1. Locate the following lines in the file and replace `your-email` and `your-authentication-token` with your [**email and authentication token**](obtainauthenticationtoken.md) used with the HCL Container Repository: ```{ .yaml .no-copy } imageCredentials: @@ -42,7 +42,7 @@ The procedure guides you in downloading the Domino REST API Helm chart and deplo ``` !!!note - Use the **CLI secret** value you saved from [obtaining authentication token from HCL Container Repository](obtainauthenticationtoken.md) as your authentication token or password. + Use the **CLI secret** value you saved from [**obtaining authentication token from HCL Container Repository**](obtainauthenticationtoken.md) as your authentication token or password. 2. Locate the following lines in the file and add your DNS hostname settings: @@ -51,12 +51,12 @@ The procedure guides you in downloading the Domino REST API Helm chart and deplo drapiDnsName: drapiManagementDnsName: ``` - Whatever hostnames you specify here and later in the Volt MX Go Foundry install, you need to ensure that the hostnames are resolvable. There is no additional work if you have already registered the hostnames in DNS. However, if you haven't registered them, you must add the hostnames to the server's /etc/hosts file as described in [Ensure Foundry Hostnames are resolvable](prereq.md#3-ensure-foundry-hostnames-are-resolvable), substituting your hostnames. Additionally, you must make the same updates in k3s's coredns config map as described in [For K3s only](prereq.md#for-k3s-only) again substituting your hostnames. + Whatever hostnames you specify here and later in the Volt MX Go Foundry install, you need to ensure that the hostnames are resolvable. There is no additional work if you have already registered the hostnames in DNS. However, if you haven't registered them, you must add the hostnames to the server's /etc/hosts file as described in [**Ensure Foundry Hostnames are resolvable**](prereq.md#3-ensure-foundry-hostnames-are-resolvable), substituting your hostnames. Additionally, you must make the same updates in k3s's coredns config map as described in [**For K3s only**](prereq.md#for-k3s-only) again substituting your hostnames. !!!note The example names used are `drapi.mymxgo.com` and `drapi-management.mymxgo.com` respectively. - 3. Locate the following lines in the file for the Administrator's first name, last name, and password. Set values for each of these settings. In our example we're using "mxgo", "admin" and "password". However, if you use your own values, remember the values and use them when required such as when you [Run First Touch](firsttouch.md#run-first-touch), and [Access Domino REST API](../howto/accessdrapi.md#access-domino-rest-api). Remember that the values of `dominoAdminFirstName` and `dominoAdminLastName` are combined, but separated by a space, to form the **username**. + 3. Locate the following lines in the file for the Administrator's first name, last name, and password. Set values for each of these settings. In our example we're using "mxgo", "admin" and "password". However, if you use your own values, remember the values and use them when required such as when you [**Run First Touch**](firsttouch.md#run-first-touch), and [**Access Domino REST API**](../howto/accessdrapi.md#access-domino-rest-api). Remember that the values of `dominoAdminFirstName` and `dominoAdminLastName` are combined, but separated by a space, to form the **username**. ```{ .yaml .no-copy } dominoAdminFirstName: "mxgo" @@ -73,7 +73,7 @@ The procedure guides you in downloading the Domino REST API Helm chart and deplo dominoNetworkHostname: "" ``` - Consult the [Table of variables](https://opensource.hcltechsw.com/Domino-rest-api/tutorial/installconfig/docker.html#table-of-variables){: target="_blank" rel="noopener noreferrer"} in *Run Domino REST API with a Docker image* in [Domino REST API documentation](https://opensource.hcltechsw.com/Domino-rest-api/index.html){: target="_blank" rel="noopener noreferrer"} to determine if you need to update these fields as well. The mapping of `values.yaml` settings to variables is as follows: + Consult the [**Table of variables**](https://opensource.hcltechsw.com/Domino-rest-api/tutorial/installconfig/docker.html#table-of-variables) in *Run Domino REST API with a Docker image* in the [**Domino REST API documentation**](https://opensource.hcltechsw.com/Domino-rest-api/index.html) to determine if you need to update these fields as well. The mapping of `values.yaml` settings to variables is as follows: - `dominoServerDomainName = SERVERSETUP_SERVER_DOMAINNAME` - `dominoOrgName = SERVERSETUP_ORG_ORGNAME` @@ -84,13 +84,13 @@ The procedure guides you in downloading the Domino REST API Helm chart and deplo - `do-not-expose`: Set this value to prevent exposure of TCP port 1352 to the network. - `HostPort`: Set this value to use TCP port 1352 on your machine for the Notes client to communicate with Domino using the Notes Remote Procedure Call (NRPC) protocol. **This is only recommended when using Rancher Desktop for Kubernetes**. - - `NodePort`: Set this value if you want Kubernetes to allocate a random port in a specified range, by default 30000 to 32767, that's available on every worker node in the cluster. Kubernetes automatically routes traffic on this port from the Kubernetes node to the back-end Domino pod. **This is the recommended option if you want to expose NRPC to your Notes Clients when deploying into a non Rancher Desktop cluster**. See [Create a new server connection under Procedure](../howto/connectdominofromnotes.md#procedure) for instructions on how to obtain the random port number. + - `NodePort`: Set this value if you want Kubernetes to allocate a random port in a specified range, by default 30000 to 32767, that's available on every worker node in the cluster. Kubernetes automatically routes traffic on this port from the Kubernetes node to the back-end Domino pod. **This is the recommended option if you want to expose NRPC to your Notes Clients when deploying into a non Rancher Desktop cluster**. See [**Create a new server connection under Procedure**](../howto/connectdominofromnotes.md#procedure) for instructions on how to obtain the random port number. - `LoadBalancer`: Set this value if you want an external load balancer to be provisioned by a cloud provider which supports external load balancers. Traffic from the external load balancer is directed at the Domino pod, and the cloud provider decides how it is load balanced. Kubernetes typically starts off by making the changes that are equivalent to you requesting NodePort. The cloud-controller-manager component then configures the external load balancer to forward traffic to that assigned node port. - You can read more about these options at [https://kubernetes.io/docs/concepts/services-networking/service/](https://kubernetes.io/docs/concepts/services-networking/service/). + You can read more about these options in the [**Service**](https://kubernetes.io/docs/concepts/services-networking/service/) topic in the Kubernetes documentation. -5. **(Optional)** If you would like to configure Ingress for Domino REST API, proceed to [Configure Kubernetes Ingress for Domino REST API](../howto/drapiingress.md). +5. **(Optional)** If you would like to configure Ingress for Domino REST API, proceed to [**Configure Kubernetes Ingress for Domino REST API**](../howto/drapiingress.md). 6. Save the file and exit. @@ -126,8 +126,9 @@ The procedure guides you in downloading the Domino REST API Helm chart and deplo ## Additional information -- To know how to manually update your Domino container if you obtain a new version of *FirstTouchRecipes.nsf*, see [Update FirstTouchRecipes.nsf](../howto/FTnsfupdate.md). -- To know more about Domino server processes within a Domino container, see [Interacting with Domino server process within Domino container](../topicguides/dominoserver.md). +- To know how to manually update your Domino container if you obtain a new version of *FirstTouchRecipes.nsf*, see [**Update FirstTouchRecipes.nsf**](../howto/FTnsfupdate.md). +- To know more about Domino server processes within a Domino container, see [**Interacting with Domino server process within Domino container**](../topicguides/dominoserver.md). + ## Next step -Proceed to [Install MySql for Volt MX Go Foundry](installmysqlfoundry.md). +Proceed to [**Install MySql for Volt MX Go Foundry**](installmysqlfoundry.md). diff --git a/docs/tutorials/firsttouch.md b/docs/tutorials/firsttouch.md index c8185c34..78fb607e 100644 --- a/docs/tutorials/firsttouch.md +++ b/docs/tutorials/firsttouch.md @@ -8,9 +8,9 @@ This tutorial guides you in accessing and running the First Touch Recipe Catalog **For Volt MX Go install to a production environment** - - You have completed the [Volt MX Go installation in a production environment](prerequisite.md). - - You have created your [Volt MX Go Foundry admin account](../howto/foundryadminaccount.md). - - If using MySQL, make sure that the maximum allowed packet size is at least 16 MB. For more information, see **First Touch or Custom Application Fails to Install on Volt MX Go Foundry** issue in [Troubleshooting](../references/troubleshoot.md). + - You have completed the [**Volt MX Go installation in a production environment**](prerequisite.md). + - You have created your [**Volt MX Go Foundry admin account**](../howto/foundryadminaccount.md). + - If using MySQL, make sure that the maximum allowed packet size is at least 16 MB. For more information, see **First Touch or Custom Application Fails to Install on Volt MX Go Foundry** issue in [**Troubleshooting**](../references/troubleshoot.md). @@ -18,16 +18,16 @@ This tutorial guides you in accessing and running the First Touch Recipe Catalog !!!tip The following actions might require certain Domino access rights. Contact your Domino Administrator/Domino REST API Administrator for assistance. - - You have [set up an oauth.nsf](https://opensource.hcltechsw.com/Domino-rest-api/howto/VoltMX/setupoauthnsf.html){: target="_blank" rel="noopener noreferrer"}. - - You have [set up Domino REST API](https://opensource.hcltechsw.com/Domino-rest-api/howto/IdP/configuredrapiIdP.html){: target="_blank" rel="noopener noreferrer"}. - - You have [downloaded the FirstTouchRecipes.nsf.zip](portaldownload.md) file, extracted the NSF file from the zip file, and copied the NSF file to the root of the data directory of your Domino server. + - You have [**set up an oauth.nsf**](https://opensource.hcltechsw.com/Domino-rest-api/howto/VoltMX/setupoauthnsf.html). + - You have [**set up Domino REST API**](https://opensource.hcltechsw.com/Domino-rest-api/howto/IdP/configuredrapiIdP.html). + - You have [**downloaded the FirstTouchRecipes.nsf.zip**](portaldownload.md) file, extracted the NSF file from the zip file, and copied the NSF file to the root of the data directory of your Domino server. === "For development or test-only environment" **For Volt MX Go install to a development or test-only environment** - - You have completed the [Volt MX Go installation in a development or test-only environment](containerdeployment.md). - - You have created your [Volt MX Go Foundry admin account](../howto/foundryadminaccount.md). + - You have completed the [**Volt MX Go installation in a development or test-only environment**](containerdeployment.md). + - You have created your [**Volt MX Go Foundry admin account**](../howto/foundryadminaccount.md). ## Log in to Volt MX Go Foundry @@ -98,6 +98,6 @@ You can now view and explore the First Touch Recipe Catalog app. ## Additional information -- To learn more about the app, see [First Touch Recipe Catalog app](../topicguides/firsttouchapp.md). -- To know how to import the First Touch Recipe app project to Volt MX Go Iris, see [Import First Touch into Volt MX Go Iris](../howto/importft.md). -- To know how to manually update your Domino container if you obtain a new version of *FirstTouchRecipes.nsf*, see [Update FirstTouchRecipes.nsf](../howto/FTnsfupdate.md). \ No newline at end of file +- To learn more about the app, see [**First Touch Recipe Catalog app**](../topicguides/firsttouchapp.md). +- To know how to import the First Touch Recipe app project to Volt MX Go Iris, see [**Import First Touch into Volt MX Go Iris**](../howto/importft.md). +- To know how to manually update your Domino container if you obtain a new version of *FirstTouchRecipes.nsf*, see [**Update FirstTouchRecipes.nsf**](../howto/FTnsfupdate.md). \ No newline at end of file diff --git a/docs/tutorials/installation.md b/docs/tutorials/installation.md index 443ccbef..0935efb5 100644 --- a/docs/tutorials/installation.md +++ b/docs/tutorials/installation.md @@ -6,17 +6,17 @@ Guides you through the procedures for installing and upgrading Volt MX Go. In case you would like to deploy Volt MX Go in a **development or test only environment**, you can do so with Kubernetes using the following options: -- using [K3s](https://docs.k3s.io){: target="_blank" rel="noopener noreferrer"} on an Ubuntu, RHEL, SLES machine or VM -- using [Rancher Desktop](https://docs.rancherdesktop.io){: target="_blank" rel="noopener noreferrer"} running on Windows +- using [**K3s**](https://docs.k3s.io) on an Ubuntu, RHEL, SLES machine or VM +- using [**Rancher Desktop**](https://docs.rancherdesktop.io) running on Windows ## System requirements -Before starting the installation, make sure to verify that you meet the [System requirements](sysreq.md). +Before starting the installation, make sure to verify that you meet the [**System requirements**](sysreq.md). ## Installation and upgrade guide -To install and upgrade the server components of Volt MX Go, proceed to [Install and upgrade Volt MX Go in a production environment](prerequisite.md). +To install and upgrade the server components of Volt MX Go, proceed to [**Install and upgrade Volt MX Go in a production environment**](prerequisite.md). -To install and upgrade the server components of Volt MX Go in a development or test only environment, proceed to [Install and upgrade Volt MX Go in development or test only environment](containerdeployment.md). +To install and upgrade the server components of Volt MX Go in a development or test only environment, proceed to [**Install and upgrade Volt MX Go in development or test only environment**](containerdeployment.md). -After installing the server components, proceed to [Install and upgrade Volt MX Go Iris](installiris.md). +After installing the server components, proceed to [**Install and upgrade Volt MX Go Iris**](installiris.md). diff --git a/docs/tutorials/installiris.md b/docs/tutorials/installiris.md index 09646de1..da81a1f7 100644 --- a/docs/tutorials/installiris.md +++ b/docs/tutorials/installiris.md @@ -8,14 +8,14 @@ ### Prerequisite -- You have [downloaded the HCL Volt MX Go Release package](portaldownload.md). +- You have [**downloaded the HCL Volt MX Go Release package**](portaldownload.md). ### Procedure Install Volt MX Go Iris. -- [For Mac](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_starter_install_mac/Content/Installing%20VoltMX%20Iris.html#installing){: target="_blank" rel="noopener noreferrer"} -- [For Windows](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_starter_install_win/Content/Installing%20VoltMX%20Iris.html#installing){: target="_blank" rel="noopener noreferrer"} +- [**For Mac**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_starter_install_mac/Content/Installing%20VoltMX%20Iris.html#installing) +- [**For Windows**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_starter_install_win/Content/Installing%20VoltMX%20Iris.html#installing) ## Upgrade Volt MX Go Iris diff --git a/docs/tutorials/k3sinstall.md b/docs/tutorials/k3sinstall.md index 02d43041..4738cf15 100644 --- a/docs/tutorials/k3sinstall.md +++ b/docs/tutorials/k3sinstall.md @@ -2,21 +2,21 @@ --8<-- "devtestenvironment.md" -K3s is a fully compliant Kubernetes distribution. For more information, see [K3s - Lightweight Kubernetes](https://docs.k3s.io/){: target="_blank" rel="noopener noreferrer"}. +K3s is a fully compliant Kubernetes distribution. For more information, see [**K3s - Lightweight Kubernetes**](https://docs.k3s.io/). !!!warning "Caution" - In all the following instructions, it's assumed you are running commands as a **non-root user**. However, there are certain commands that must with sudo permissions. For these commands, you need to configure your non-root user with sudo. To do this, see [Using sudo to allow non-root users to perform root level functions](https://www.suse.com/support/kb/doc/?id=000016906){: target="_blank" rel="noopener noreferrer"}. + In all the following instructions, it's assumed you are running commands as a **non-root user**. However, there are certain commands that must with sudo permissions. For these commands, you need to configure your non-root user with sudo. To do this, see [**Using sudo to allow non-root users to perform root level functions**](https://www.suse.com/support/kb/doc/?id=000016906). ## Before you begin !!!note If you will use Rancher Desktop in deploying Volt MX Go, you don't need to install K3s. -Before starting with the procedure, make sure that you have checked and verified that all system requirements [for deploying MX Go using K3s on an Ubuntu, RHEL, SLES machine, or VM](sysreq.md#for-deploying-volt-mx-go-using-k3s-on-an-ubuntu-rhel-sles-machine-or-vm) are met. +Before starting with the procedure, make sure that you have checked and verified that all system requirements [**for deploying MX Go using K3s on an Ubuntu, RHEL, SLES machine, or VM**](sysreq.md#for-deploying-volt-mx-go-using-k3s-on-an-ubuntu-rhel-sles-machine-or-vm) are met. ## 1. Install K3s -Before installing K3s, make sure you have met any operating system configuration required by K3s, specifically for [RHEL and CENTOS](https://docs.k3s.io/advanced#red-hat-enterprise-linux--centos){: target="_blank" rel="noopener noreferrer"}. +Before installing K3s, make sure you have met any operating system configuration required by K3s, specifically for [**RHEL and CENTOS**](https://docs.k3s.io/advanced#red-hat-enterprise-linux--centos). 1. Run the following command: @@ -63,7 +63,7 @@ export KUBECONFIG=~/.kube/config ## 4. Install Helm -Helm is the package manager for Kubernetes and is used to install Volt MX Go. For more information, see [Helm](https://helm.sh/){: target="_blank" rel="noopener noreferrer"}. +Helm is the package manager for Kubernetes and is used to install Volt MX Go. For more information, see [**Helm**](https://helm.sh/). To install Helm, run the following commands: @@ -74,7 +74,7 @@ sudo mv linux-386/helm /usr/local/bin/helm sudo rm -rf helm-v3.11.2-linux-386.tar.gz linux-386 ``` -For more information, see [Installing Helm](https://helm.sh/docs/intro/install/){: target="_blank" rel="noopener noreferrer"} and [Helm releases](https://github.com/helm/helm/releases){: target="_blank" rel="noopener noreferrer"}. +For more information, see [**Installing Helm**](https://helm.sh/docs/intro/install/) and [**Helm releases**](https://github.com/helm/helm/releases). ## 5. Ensure K3s is active and ready @@ -104,4 +104,4 @@ For more information, see [Installing Helm](https://helm.sh/docs/intro/install/) ## Next step -Proceed to [Complete preparatory procedure](prereq.md). \ No newline at end of file +Proceed to [**Complete preparatory procedure**](prereq.md). \ No newline at end of file diff --git a/docs/tutorials/nativeinstallers.md b/docs/tutorials/nativeinstallers.md index ebb0e9ca..958298e4 100644 --- a/docs/tutorials/nativeinstallers.md +++ b/docs/tutorials/nativeinstallers.md @@ -8,7 +8,7 @@ The procedures guide you in installing the following server components of Volt M !!!warning "Important" - Using this installation option would require you to use your own Domino server. - - Before starting the installation, make sure to verify that you meet the [System requirements](sysreq.md). + - Before starting the installation, make sure to verify that you meet the [**System requirements**](sysreq.md). --8<-- "browsertab.md" @@ -16,15 +16,15 @@ The procedures guide you in installing the following server components of Volt M --8<-- "drapiversion.md" -1. Downloaded the Domino REST API installer. For more information, see [Download the Domino REST API](https://opensource.hcltechsw.com/Domino-rest-api/tutorial/installconfig/index.html#download-the-domino-rest-api){: target="_blank" rel="noopener noreferrer"}. +1. Downloaded the Domino REST API installer. For more information, see [**Download the Domino REST API**](https://opensource.hcltechsw.com/Domino-rest-api/tutorial/installconfig/index.html#download-the-domino-rest-api) in the HCL Domino REST API documentation. 2. Follow the links to the installation procedure based on your preferred installation platform: - - [For Windows](https://opensource.hcltechsw.com/Domino-rest-api/tutorial/installconfig/win.html){: target="_blank" rel="noopener noreferrer"} - - [For Linux](https://opensource.hcltechsw.com/Domino-rest-api/tutorial/installconfig/linux.html){: target="_blank" rel="noopener noreferrer"} + - [**For Windows**](https://opensource.hcltechsw.com/Domino-rest-api/tutorial/installconfig/win.html) + - [**For Linux**](https://opensource.hcltechsw.com/Domino-rest-api/tutorial/installconfig/linux.html) -3. Complete all the [post-installation tasks](https://opensource.hcltechsw.com/Domino-rest-api/tutorial/installconfig/postinstallation.html){: target="_blank" rel="noopener noreferrer"}. +3. Complete all the [**post-installation tasks**](https://opensource.hcltechsw.com/Domino-rest-api/tutorial/installconfig/postinstallation.html). -For more information, see the [Installation and configuration](https://opensource.hcltechsw.com/Domino-rest-api/tutorial/installconfig/index.html){: target="_blank" rel="noopener noreferrer"} page in the Domino REST API documentation. +For more information, see the [**Installation and configuration**](https://opensource.hcltechsw.com/Domino-rest-api/tutorial/installconfig/index.html) page in the HCL Domino REST API documentation. ## Install Volt MX Go Foundry @@ -39,7 +39,7 @@ Volt MX Go Foundry supports the following installation mechanisms: 1. Download the Volt MX Go Foundry installer based on your preferred installation platform/option. - For more information, see [Download HCL Volt MX Go Release package](portaldownload.md). + For more information, see [**Download HCL Volt MX Go Release package**](portaldownload.md). 2. Extract the installer from the downloaded ZIP file. 3. Follow the links to the installation guides based on your preferred installation platform/option: @@ -48,9 +48,9 @@ Volt MX Go Foundry supports the following installation mechanisms: - The installation guides will indicate installation files and installation file download locations. **You must use the installer you downloaded in Step 1.** - Make sure to check all the details and complete all the applicable procedures indicated in the sections in the installation guides. - - [For Windows](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_windows_install_guide/Content/Introduction.html){: target="_blank" rel="noopener noreferrer"} - - [For Linux](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_linux_install_guide/Content/Introduction.html){: target="_blank" rel="noopener noreferrer"} - - [For command line installer](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/VoltMX_Foundry_CLI/Content/installer_cli.html){: target="_blank" rel="noopener noreferrer"} + - [**For Windows**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_windows_install_guide/Content/Introduction.html) + - [**For Linux**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_linux_install_guide/Content/Introduction.html) + - [**For command line installer**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/VoltMX_Foundry_CLI/Content/installer_cli.html) ### For using helm charts on a supported Kubernetes platform @@ -64,7 +64,7 @@ Volt MX Go Foundry supports the following installation mechanisms: ``` !!!note "Prerequisite" - [Obtain authentication token from HCL Container Repository](obtainauthenticationtoken.md) before proceeding. + [**Obtain authentication token from HCL Container Repository**](obtainauthenticationtoken.md) before proceeding. #### 1. Create a namespace and a temp directory for the charts @@ -81,7 +81,7 @@ cd ~/mxgo #### 2. Configure Helm to pull from HCL Container Repository -The procedure sets up Helm with the details necessary to authenticate with the HCL Container Repository. You will need your [email and authentication token](obtainauthenticationtoken.md) used with the HCL Container Repository. +The procedure sets up Helm with the details necessary to authenticate with the HCL Container Repository. You will need your [**email and authentication token**](obtainauthenticationtoken.md) used with the HCL Container Repository. - Run the following command to set up Helm: @@ -94,7 +94,7 @@ The procedure sets up Helm with the details necessary to authenticate with the H !!!note - Use the **CLI secret** value you saved from [obtaining authentication token from HCL Container Repository](obtainauthenticationtoken.md) as your authentication token or password. + Use the **CLI secret** value you saved from [**obtaining authentication token from HCL Container Repository**](obtainauthenticationtoken.md) as your authentication token or password. If you get an error message similar to the following: @@ -136,7 +136,7 @@ The procedure sets up Helm with the details necessary to authenticate with the H ./init-guids.sh --new ``` -4. Edit the `values.yaml` file to update the `imageCredentials` by replacing `your-email` and `your-authentication-token` with your [email and authentication token](obtainauthenticationtoken.md) used with the HCL Container Repository. +4. Edit the `values.yaml` file to update the `imageCredentials` by replacing `your-email` and `your-authentication-token` with your [**email and authentication token**](obtainauthenticationtoken.md) used with the HCL Container Repository. ```{ .yaml .no-copy } imageCredentials: @@ -145,14 +145,14 @@ The procedure sets up Helm with the details necessary to authenticate with the H ``` !!!note - Use the **CLI secret** value you saved from [obtaining authentication token from HCL Container Repository](obtainauthenticationtoken.md) as your authentication token or password. + Use the **CLI secret** value you saved from [**obtaining authentication token from HCL Container Repository**](obtainauthenticationtoken.md) as your authentication token or password. 5. Locate the following line in the file and add your Volt MX Go Foundry server domain name setting: ```{ .yaml .no-copy } serverDomainName: ``` - Whatever server domain name you specify here, you need to ensure that it's resolvable. There is no additional work if you have already registered your server domain name in DNS. However, if you haven't registered it, you must add it to the server's /etc/hosts file [Ensure Foundry Hostnames are resolvable](prereq.md#3-ensure-foundry-hostnames-are-resolvable), substituting your server domain name. Additionally, you must make the same updates in k3s's coredns config map as described in [For K3s only](prereq.md#for-k3s-only) again substituting your server domain name. + Whatever server domain name you specify here, you need to ensure that it's resolvable. There is no additional work if you have already registered your server domain name in DNS. However, if you haven't registered it, you must add it to the server's /etc/hosts file [**Ensure Foundry Hostnames are resolvable**](prereq.md#3-ensure-foundry-hostnames-are-resolvable), substituting your server domain name. Additionally, you must make the same updates in k3s's coredns config map as described in [**For K3s only**](prereq.md#for-k3s-only) again substituting your server domain name. 6. Locate the following lines in the file and add your Volt MX Go Foundry database details: @@ -183,13 +183,13 @@ The procedure sets up Helm with the details necessary to authenticate with the H dbPass: ``` -7. For more advanced configuration options, see [Configuration](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmxfoundry_containers_helm/Content/Installing_Containers_With_Helm.html#configuration){: target="_blank" rel="noopener noreferrer"} in the *Installation Guide for Volt MX Foundry Containers Helm Installation*. +7. For more advanced configuration options, see [**Configuration**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmxfoundry_containers_helm/Content/Installing_Containers_With_Helm.html#configuration) in the *Installation Guide for Volt MX Foundry Containers Helm Installation*. 8. Save the file and exit. #### 4. (Optional) Perform advanced scenario procedures -- Perform the procedures under [Advanced Scenarios](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmxfoundry_containers_helm/Content/Installing_Containers_With_Helm_Advanced_Scenarios.html){: target="_blank" rel="noopener noreferrer"} +- Perform the procedures under [**Advanced Scenarios**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmxfoundry_containers_helm/Content/Installing_Containers_With_Helm_Advanced_Scenarios.html). #### 5. Deploy Foundry's dbupdate to create the databases @@ -247,23 +247,23 @@ The procedure sets up Helm with the details necessary to authenticate with the H !!!note - If you defined a different Volt MX Go Foundry hostname, the Foundry URL would be the defined Foundry hostname concatenated with `/mfconsole/`. - If you want to access this deployment from a remote machine, you most likely need to update the `/etc/hosts` file on the remote machine as well. - - To create an account, see [Create a Volt MX Go Foundry administrator account](../howto/foundryadminaccount.md). - - To connect to Domino server from your Notes client, see [Connect to Domino server from your Notes client](../howto/connectdominofromnotes.md). + - To create an account, see [**Create a Volt MX Go Foundry administrator account**](../howto/foundryadminaccount.md). + - To connect to Domino server from your Notes client, see [**Connect to Domino server from your Notes client**](../howto/connectdominofromnotes.md). #### 7. (Optional) Perform monitoring procedures -- Perform the procedures under [Monitoring](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmxfoundry_containers_helm/Content/Installing_Containers_With_Helm_Monitoring.html){: target="_blank" rel="noopener noreferrer"}. +- Perform the procedures under [**Monitoring**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmxfoundry_containers_helm/Content/Installing_Containers_With_Helm_Monitoring.html) in the HCL Volt MX documentation. !!!note The procedures are for enabling important monitoring features such as Metrics Server, Elastic Stack, Kuberhealthy. #### 8. (Optional) Perform post installation tasks -- Perform the procedures under the [Post Installation Tasks](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmxfoundry_containers_helm/Content/Installing_Containers_With_Helm_PostInstallation.html){: target="_blank" rel="noopener noreferrer"} +- Perform the procedures under the [**Post Installation Tasks**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmxfoundry_containers_helm/Content/Installing_Containers_With_Helm_PostInstallation.html) in the HCL Volt MX documentation. ## Additional information -After completing the installation of **Domino REST API** and **Volt MX Go Foundry**, proceed to [Install Volt MX Go Iris](installiris.md). +After completing the installation of **Domino REST API** and **Volt MX Go Foundry**, proceed to [**Install Volt MX Go Iris**](installiris.md). diff --git a/docs/tutorials/obtainauthenticationtoken.md b/docs/tutorials/obtainauthenticationtoken.md index 3c8e6d30..6a2f4aec 100644 --- a/docs/tutorials/obtainauthenticationtoken.md +++ b/docs/tutorials/obtainauthenticationtoken.md @@ -6,7 +6,7 @@ The binary images and Helm charts for Volt MX Go server components are pulled fr ## To obtain your authentication token -1. Go to the [HCL Container Repository](https://hclcr.io){: target="_blank" rel="noopener noreferrer"}. +1. Go to the [**HCL Container Repository**](https://hclcr.io "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"} ![link image](../assets/images/external-link.svg){: style="height:15px;width:15px"}. 2. On the login page, click **LOGIN VIA OIDC Provider**, and then login using your corporate email address. 3. On the **Projects** page, click your username and select **User Profile**. @@ -25,6 +25,6 @@ The binary images and Helm charts for Volt MX Go server components are pulled fr ## Next step -For installing Volt MX Go using helm charts on a supported Kubernetes platform for a production environment, proceed to [Configure Helm to pull from HCL Container Repository](nativeinstallers.md#1-create-a-namespace-and-a-temp-directory-for-the-charts). +For installing Volt MX Go using helm charts on a supported Kubernetes platform for a production environment, proceed to [**Configure Helm to pull from HCL Container Repository**](nativeinstallers.md#1-create-a-namespace-and-a-temp-directory-for-the-charts). -For installing Volt MX Go to **development or test only environment**, proceed to [Deploy Kubernetes](deploykubernetes.md). \ No newline at end of file +For installing Volt MX Go to **development or test only environment**, proceed to [**Deploy Kubernetes**](deploykubernetes.md). \ No newline at end of file diff --git a/docs/tutorials/portaldownload.md b/docs/tutorials/portaldownload.md index 2feadf32..a2a44234 100644 --- a/docs/tutorials/portaldownload.md +++ b/docs/tutorials/portaldownload.md @@ -5,16 +5,16 @@ Guides you on how to search and download the HCL Volt MX Go Release package from the **HCL License & Download Portal**. !!!tip - To learn more about **HCL License & Download Portal**, see [What is the HCL Software License & Download Portal?](https://support.hcltechsw.com/csm?id=kb_article&sysparm_article=KB0073344){: target="_blank" rel="noopener noreferrer"}. + To learn more about **HCL License & Download Portal**, see [**What is the HCL Software License & Download Portal?**](https://support.hcltechsw.com/csm?id=kb_article&sysparm_article=KB0073344). ## Procedure **To search and download the HCL Volt MX Go Release package** -1. Go to [HCL License & Download Portal](https://hclsoftware.flexnetoperations.com/){: target="_blank" rel="noopener noreferrer"}. +1. Go to [**HCL License & Download Portal**](https://hclsoftware.flexnetoperations.com/ "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"} ![link image](../assets/images/external-link.svg){: style="height:15px;width:15px"}. 2. On the sign in page, enter your username and click **Next**. The **License & Download Portal** home page opens. 3. On the **License & Download Portal** home page, go to **Downloads** → **List Downloads**. -4. On the **Downloads** page, search for and click `HCL Volt MX `. +4. On the **Downloads** page, search for and click **HCL Volt MX**. 5. On the **Download Packages** page, click the **HCL Volt MX Go Version x.x** package. !!!note @@ -32,6 +32,6 @@ Guides you on how to search and download the HCL Volt MX Go Release package from ## Next step -For a new installation, proceed to [Install Volt MX Go server components](nativeinstallers.md). +For a new installation, proceed to [**Install Volt MX Go server components**](nativeinstallers.md). -For an upgrade installation, proceed to [Upgrade Volt MX Go server components](versionupgrade.md) +For an upgrade installation, proceed to [**Upgrade Volt MX Go server components**](versionupgrade.md) diff --git a/docs/tutorials/sysreq.md b/docs/tutorials/sysreq.md index c57d22c8..1f057fda 100644 --- a/docs/tutorials/sysreq.md +++ b/docs/tutorials/sysreq.md @@ -5,32 +5,35 @@ This section describes the minimum system requirements for deploying Volt MX Go. ## For installing Volt MX Go Foundry ### Software requirements -Check the [Supported OS, Application Servers, and Database Guide](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmxfoundry_supported_devices_os_browsers/Content/Introduction.html){: target="_blank" rel="noopener noreferrer"} to know the software requirements for installing Volt MX Go Foundry using installers. +Check the [**Supported OS, Application Servers, and Database Guide**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmxfoundry_supported_devices_os_browsers/Content/Introduction.html) to know the software requirements for installing Volt MX Go Foundry using installers. ### Hardware requirements -- [For Windows](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_windows_install_guide/Content/Prerequisites.html#hardware-requirements){: target="_blank" rel="noopener noreferrer"} -- [For Linux](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_linux_install_guide/Content/Prerequisites.html#hardware-requirements){: target="_blank" rel="noopener noreferrer"} +- [**For Windows**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_windows_install_guide/Content/Prerequisites.html#hardware-requirements) +- [**For Linux**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_linux_install_guide/Content/Prerequisites.html#hardware-requirements) ### Network settings -- [For Windows](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_windows_install_guide/Content/Prerequisites.html#network-settings){: target="_blank" rel="noopener noreferrer"} -- [For Linux](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_linux_install_guide/Content/Prerequisites.html#network-settings){: target="_blank" rel="noopener noreferrer"} +- [**For Windows**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_windows_install_guide/Content/Prerequisites.html#network-settings) +- [**For Linux**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_linux_install_guide/Content/Prerequisites.html#network-settings) ### Supported browsers -Check the [supported browsers](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmxfoundry_supported_devices_os_browsers/Content/Supported_Browsers.html){: target="_blank" rel="noopener noreferrer"} for the Volt MX Go Foundry Console. + +Check the [**supported browsers**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmxfoundry_supported_devices_os_browsers/Content/Supported_Browsers.html) for the Volt MX Go Foundry Console. ### Prerequisites for Volt MX Go Foundry command line installer -Check the additional [prerequisites](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/VoltMX_Foundry_CLI/Content/installer_cli.html#prerequisites){: target="_blank" rel="noopener noreferrer"} when using the Foundry command line installer. + +Check the additional [**prerequisites**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/VoltMX_Foundry_CLI/Content/installer_cli.html#prerequisites) when using the Foundry command line installer. ### Prerequisites for Volt MX Foundry Containers Helm Installation -Check the [prerequisites](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmxfoundry_containers_helm/Content/Installing_Containers_With_Helm.html#prerequisites){: target="_blank" rel="noopener noreferrer"} when using the Volt MX Go Foundry Containers Helm Installation. + +Check the [**prerequisites**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmxfoundry_containers_helm/Content/Installing_Containers_With_Helm.html#prerequisites) when using the Volt MX Go Foundry Containers Helm Installation. ## For installing Domino REST API --8<-- "drapiversion.md" -Check the [system requirements](https://support.hcltechsw.com/csm?id=kb_article&sysparm_article=KB0101789){: target="_blank" rel="noopener noreferrer"} for installing Domino REST API using the installer. +Check the [**system requirements**](https://support.hcltechsw.com/csm?id=kb_article&sysparm_article=KB0101789) for installing Domino REST API using the installer. ## For installing Volt MX Go Iris on Windows @@ -38,8 +41,6 @@ Check the [system requirements](https://support.hcltechsw.com/csm?id=kb_article& Windows 11, Windows 10, Windows 8.1 Update. Supports 64-bit Operating Systems - - ### Hardware |Component |Requirement| @@ -82,8 +83,8 @@ Mac OS X 10.9 and above | RAM | 16 GB | !!!note - - For more information on K3s, see [K3s - Lightweight Kubernetes](https://docs.k3s.io/){: target="_blank" rel="noopener noreferrer"}. - - For more information on the installation requirements for K3s, see [K3s Installation Requirements](https://docs.k3s.io/installation/requirements){: target="_blank" rel="noopener noreferrer"}. + - For more information on K3s, see [**K3s - Lightweight Kubernetes**](https://docs.k3s.io/). + - For more information on the installation requirements for K3s, see [**K3s Installation Requirements**](https://docs.k3s.io/installation/requirements). ## For deploying Volt MX Go using Rancher Desktop running on Windows @@ -110,9 +111,9 @@ Rancher Desktop requires the following on Windows: - Windows Subsystem for Linux on Windows. This will automatically be installed as part of the Rancher Desktop setup. Manually downloading a distribution isn't necessary. !!!note - - For more information on Rancher Desktop, see [Introduction](https://docs.rancherdesktop.io/){: target="_blank" rel="noopener noreferrer"}. - - For more information on Rancher Desktop installation requirements, see [Installation](https://docs.rancherdesktop.io/getting-started/installation/#windows){: target="_blank" rel="noopener noreferrer"}. + - For more information on Rancher Desktop, see [**Introduction**](https://docs.rancherdesktop.io/) in the Rancher Desktop documentation. + - For more information on Rancher Desktop installation requirements, see [**Installation**](https://docs.rancherdesktop.io/getting-started/installation/#windows) in the Rancher Desktop documentation. ## Next step -Proceed to [Installation](../tutorials/installation.md). \ No newline at end of file +Proceed to [**Installation**](../tutorials/installation.md). \ No newline at end of file diff --git a/docs/tutorials/versionupgrade.md b/docs/tutorials/versionupgrade.md index fa975515..8bbc9e29 100644 --- a/docs/tutorials/versionupgrade.md +++ b/docs/tutorials/versionupgrade.md @@ -8,21 +8,13 @@ The following procedures guide you in upgrading the server components of Volt MX --8<-- "drapiversion.md" -1. Downloaded the required version of the Domino REST API installer. For more information, see [Download the Domino REST API](https://opensource.hcltechsw.com/Domino-rest-api/tutorial/installconfig/index.html#download-the-domino-rest-api){: target="_blank" rel="noopener noreferrer"}. -2. Follow the relevant steps in the [upgrade procedure](https://opensource.hcltechsw.com/Domino-rest-api/howto/production/versionupdate.html){: target="_blank" rel="noopener noreferrer"} based on your installation platform. - - +1. Downloaded the required version of the Domino REST API installer. For more information, see [**Download the Domino REST API**](https://opensource.hcltechsw.com/Domino-rest-api/tutorial/installconfig/index.html#download-the-domino-rest-api) in the HCL Domino REST API documentation. +2. Follow the relevant steps in the [**upgrade procedure**](https://opensource.hcltechsw.com/Domino-rest-api/howto/production/versionupdate.html) in the HCL Domino REST API documentation based on your installation platform. ## Upgrade Volt MX Go Foundry As Volt MX Go Foundry supports various installation mechanisms, refer to the relevant upgrade procedure. - - ### For using an installer !!!warning "Important" @@ -34,7 +26,7 @@ As Volt MX Go Foundry supports various installation mechanisms, refer to the rel #### Before you begin - Back up your databases and server artifacts. -- You have downloaded the latest Volt MX Go Foundry installer based on your used installation platform/option. For more information, see [Download HCL Volt MX Go Release package](portaldownload.md). +- You have downloaded the latest Volt MX Go Foundry installer based on your used installation platform/option. For more information, see [**Download HCL Volt MX Go Release package**](portaldownload.md). - Ensure that the installer has execute permission. - Ensure that you have the path of your previous installation directory. - Ensure that you stop the application server of your existing Volt MX Go Foundry instance, which you want to upgrade. @@ -46,9 +38,9 @@ As Volt MX Go Foundry supports various installation mechanisms, refer to the rel - The upgrade procedure will indicate installation files and installation file download locations. **You must use the installer you downloaded in *Before you begin*.** - Check all the details and complete all the applicable steps indicated in the upgrade procedure. - - [For Windows](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_windows_install_guide/Content/Upgrading_VoltMX_Foundry_SP1.html){: target="_blank" rel="noopener noreferrer"} - - [For Linux](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_linux_install_guide/Content/Upgrading_VoltMX_Foundry_SP1.html){: target="_blank" rel="noopener noreferrer"} - + - [For Windows](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_windows_install_guide/Content/Upgrading_VoltMX_Foundry_SP1.html) + - [For Linux](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_linux_install_guide/Content/Upgrading_VoltMX_Foundry_SP1.html) + ### For using helm charts on a supported Kubernetes platform @@ -74,7 +66,7 @@ As Volt MX Go Foundry supports various installation mechanisms, refer to the rel 2. Configure Helm to pull from HCL Container Repository. - You will need your [email and authentication token](obtainauthenticationtoken.md) used with the HCL Container Repository. + You will need your [**email and authentication token**](obtainauthenticationtoken.md) used with the HCL Container Repository. 1. Run the following command to check if `hclcr` is already defined: @@ -98,7 +90,7 @@ As Volt MX Go Foundry supports various installation mechanisms, refer to the rel !!!note - Use the **CLI secret** value you saved from [obtaining authentication token from HCL Container Repository](obtainauthenticationtoken.md) as your authentication token or password. + Use the **CLI secret** value you saved from [**obtaining authentication token from HCL Container Repository**](obtainauthenticationtoken.md) as your authentication token or password. If you get an error message similar to the following: @@ -149,5 +141,5 @@ As Volt MX Go Foundry supports various installation mechanisms, refer to the rel ## Additional information -After completing the upgrade installation of **Domino REST API** and **Volt MX Go Foundry**, proceed to [Install and upgrade Volt MX Go Iris](installiris.md). +After completing the upgrade installation of **Domino REST API** and **Volt MX Go Foundry**, proceed to [**Install and upgrade Volt MX Go Iris**](installiris.md). diff --git a/docs/tutorials/voltformula.md b/docs/tutorials/voltformula.md index 47baba14..16e2e495 100644 --- a/docs/tutorials/voltformula.md +++ b/docs/tutorials/voltformula.md @@ -1,12 +1,12 @@ # VoltFormula tutorial -This tutorial shows you how to use VoltFormula in Volt MX Go Iris to convert formulas from OpenFormula and NotesFormula into Volt MX Go Rosetta JavaScript. This feature in Volt MX Go Iris allows you to enter into source [OpenFormula](https://docs.oasis-open.org/office/OpenDocument/v1.3/OpenDocument-v1.3-part4-formula.html){: target="_blank" rel="noopener noreferrer"} and [Notes Formula Language](https://help.hcltechsw.com/dom_designer/10.0.1/basic/H_NOTES_FORMULA_LANGUAGE.html){: target="_blank" rel="noopener noreferrer"} and have it translated automatically into JavaScript code. +This tutorial shows you how to use VoltFormula in Volt MX Go Iris to convert formulas from OpenFormula and NotesFormula into Volt MX Go Rosetta JavaScript. This feature in Volt MX Go Iris allows you to enter into source [**OpenFormula**](https://docs.oasis-open.org/office/OpenDocument/v1.3/OpenDocument-v1.3-part4-formula.html) and [**Notes Formula Language**](https://help.hcltechsw.com/dom_designer/10.0.1/basic/H_NOTES_FORMULA_LANGUAGE.html) and have it translated automatically into JavaScript code. ## Before you begin -- You have completed the [Volt MX Go installation](installation.md). -- You have created your [Volt MX Go Foundry admin account](../howto/foundryadminaccount.md). -- You know how to use [actions](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_user_guide/Content/working_with_Action_Editor.html#search-for-an-action-in-action-editor){: target="_blank" rel="noopener noreferrer"}. +- You have completed the [**Volt MX Go installation**](installation.md). +- You have created your [**Volt MX Go Foundry admin account**](../howto/foundryadminaccount.md). +- You know how to use [**Actions**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_user_guide/Content/working_with_Action_Editor.html#search-for-an-action-in-action-editor). ## Launch Volt MX Go Iris @@ -160,6 +160,6 @@ This tutorial shows you how to use VoltFormula in Volt MX Go Iris to convert for ![Edit Rosetta JS](../assets/images/vfjavaedit.png) !!!Info - - The default Rosetta VoltFormula setting can be modified according to your need for your app. To change the configuration, see [Configure VoltFormula's Rosetta API Options](../howto/configrosetta.md). - - To know more about the proper way of handling codes, see [VoltFormula coding exercise examples in Volt MX Go Iris](../topicguides/vfcodingguides.md). + - The default Rosetta VoltFormula setting can be modified according to your need for your app. To change the configuration, see [**Configure VoltFormula's Rosetta API Options**](../howto/configrosetta.md). + - To know more about the proper way of handling codes, see [**VoltFormula coding exercise examples in Volt MX Go Iris**](../topicguides/vfcodingguides.md). diff --git a/mkdocs.yml b/mkdocs.yml index dc6896d6..96c8fe4a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -89,7 +89,8 @@ edit_uri: edit/main/docs # Customization extra_css: - - ../assets/css/voltmxgo.css + - assets/css/voltmxgo.css +# - ../assets/css/voltmxgo.css plugins: - search From 8723a838aafc1829ce77cb412c71baf2a9f79180 Mon Sep 17 00:00:00 2001 From: Zerlord Santiago Date: Thu, 18 Jul 2024 00:26:41 +0800 Subject: [PATCH 2/4] Accessibility improvements --- docs/.snippets/devtestenvironment.md | 2 +- docs/.snippets/drapiversion.md | 2 +- docs/.snippets/feedback.md | 2 +- docs/.snippets/helmversion.md | 2 +- docs/assets/css/voltmxgo.css | 66 ++++++++++++++++++++- docs/howto/.pages | 5 ++ docs/howto/accessdrapi.md | 8 +-- docs/howto/configrosetta.md | 4 +- docs/howto/diagents.md | 4 +- docs/howto/drapiingress.md | 28 ++++----- docs/howto/foundryadminaccount.md | 2 +- docs/howto/index.md | 12 ++-- docs/howto/insertattachments.md | 6 +- docs/howto/k3suninstall.md | 2 +- docs/howto/uninstall.md | 2 +- docs/index.md | 8 +-- docs/references/docguide.md | 5 +- docs/references/index.md | 40 ++++++------- docs/references/knownlimitation.md | 7 ++- docs/references/summernotewidget.md | 10 ++-- docs/references/troubleshoot.md | 8 +-- docs/topicguides/datamodel.md | 12 ++-- docs/topicguides/declvariables.md | 8 +-- docs/topicguides/dominoadapter.md | 6 +- docs/topicguides/dominoserver.md | 18 +++--- docs/topicguides/extendrosettapi.md | 2 +- docs/topicguides/introvoltmxgo.md | 20 +++---- docs/topicguides/method.md | 8 +-- docs/topicguides/rosettaapi.md | 4 +- docs/topicguides/rosettaconverterconfig.md | 6 +- docs/topicguides/vfcodingpractices.md | 2 +- docs/topicguides/voltformulaintro.md | 6 +- docs/tutorials/adaptertutorial.md | 22 +++---- docs/tutorials/designimport.md | 54 ++++++++--------- docs/tutorials/downloadhelmchart.md | 22 +++---- docs/tutorials/firsttouch.md | 22 +++---- docs/tutorials/installation.md | 12 ++-- docs/tutorials/installiris.md | 6 +- docs/tutorials/k3sinstall.md | 14 ++--- docs/tutorials/nativeinstallers.md | 46 +++++++------- docs/tutorials/obtainauthenticationtoken.md | 6 +- docs/tutorials/portaldownload.md | 8 +-- docs/tutorials/sysreq.md | 28 ++++----- docs/tutorials/versionupgrade.md | 12 ++-- docs/tutorials/voltformula.md | 12 ++-- docs/tutorials/webinar.md | 8 +-- 46 files changed, 330 insertions(+), 259 deletions(-) diff --git a/docs/.snippets/devtestenvironment.md b/docs/.snippets/devtestenvironment.md index 32499c6d..6c916898 100644 --- a/docs/.snippets/devtestenvironment.md +++ b/docs/.snippets/devtestenvironment.md @@ -1,2 +1,2 @@ !!!warning "Important" - This is only applicable when you [**install Volt MX Go to a development or test only environment**](../tutorials/containerdeployment.md). \ No newline at end of file + This is only applicable when you [install Volt MX Go to a development or test only environment](../tutorials/containerdeployment.md). \ No newline at end of file diff --git a/docs/.snippets/drapiversion.md b/docs/.snippets/drapiversion.md index 7a75e6b2..0bf2063b 100644 --- a/docs/.snippets/drapiversion.md +++ b/docs/.snippets/drapiversion.md @@ -1,2 +1,2 @@ !!!warning "Important" - Make sure to check [**version compatibility**](../references/compatibilitymatrix.md) between Volt MX Go and Domino REST API. \ No newline at end of file + Make sure to check [version compatibility](../references/compatibilitymatrix.md) between Volt MX Go and Domino REST API. \ No newline at end of file diff --git a/docs/.snippets/feedback.md b/docs/.snippets/feedback.md index dfb0fb6f..2fc95c6c 100644 --- a/docs/.snippets/feedback.md +++ b/docs/.snippets/feedback.md @@ -1,3 +1,3 @@ !!! success "Your input matters!" - We would like to here from you. If you have questions, topics for discussion, ideas to share, or feedback, reach us through the [**OpenNTF Discord channel**](https://discord.com/invite/jmRHpDRnH4). \ No newline at end of file + We would like to here from you. If you have questions, topics for discussion, ideas to share, or feedback, reach us through the [OpenNTF Discord channel](https://discord.com/invite/jmRHpDRnH4). \ No newline at end of file diff --git a/docs/.snippets/helmversion.md b/docs/.snippets/helmversion.md index f432addd..8729a2f1 100644 --- a/docs/.snippets/helmversion.md +++ b/docs/.snippets/helmversion.md @@ -1 +1 @@ -See [**Volt MX Go and Helm chart version compatibility**](../references/compatibilitymatrix.md#volt-mx-go-and-helm-chart-version-compatibility) to know the latest Helm chart version. \ No newline at end of file +See [Volt MX Go and Helm chart version compatibility](../references/compatibilitymatrix.md#volt-mx-go-and-helm-chart-version-compatibility) to know the latest Helm chart version. \ No newline at end of file diff --git a/docs/assets/css/voltmxgo.css b/docs/assets/css/voltmxgo.css index bc3b0cc4..f2837ef9 100644 --- a/docs/assets/css/voltmxgo.css +++ b/docs/assets/css/voltmxgo.css @@ -86,4 +86,68 @@ pre { .newpageicon { font-size: x-small; - } \ No newline at end of file + } + + /* + the following css is for increasing the font size and changing the font and font color of the copyright + */ + + .md-copyright { + font-family:"HCLTech Roobert"; + font-size:medium; + color: #FFFFFF; + } + + /* + the following css is for increasing the font size of the admonition + */ + + .admonition p{ + font-size:medium + } + + .admonition ul{ + font-size:medium + } + + .admonition ol{ + font-size:medium + } + + /* + the following css is for the links within the admonition + */ + + .admonition a{ + text-decoration: underline; + } + + /* + the following css is for the color and font size of the footer + */ + + .footnote ol li p{ + font-size:110%; + color: #000000; + } + + /* + the following css is for the links in the page + */ + + p a{ + text-decoration: underline; + } + + /* + the following css is for increasing the font size in tables + */ + table td{ + font-size: medium; + } + + table th{ + font-size: medium; + } + + \ No newline at end of file diff --git a/docs/howto/.pages b/docs/howto/.pages index b020f018..16cf02ce 100644 --- a/docs/howto/.pages +++ b/docs/howto/.pages @@ -32,4 +32,9 @@ nav: - k3suninstall.md - rancheruninstall.md - uninstallfirsttouch.md + - Uninstall Volt MX Go Foundry for Linux: https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_linux_install_guide/Content/Uninstalling_VoltMX_Foundry.html + - Uninstall Volt MX Go Foundry for Windows: https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_windows_install_guide/Content/Uninstalling_VoltMX_Foundry.html + - Uninstall Volt MX Go Foundry installed on supported Kubernetes platform: https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmxfoundry_containers_helm/Content/Installing_Containers_With_Helm.html#uninstalling-foundry + - Uninstall Volt MX Go Iris for Windows: https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_starter_install_win/Content/Uninstalling%20VoltMX%20Iris.html + - Uninstall Volt MX Go Iris for Mac: https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_starter_install_mac/Content/Uninstalling%20VoltMX%20Iris.html diff --git a/docs/howto/accessdrapi.md b/docs/howto/accessdrapi.md index c9d4bb1b..e7e8afa3 100644 --- a/docs/howto/accessdrapi.md +++ b/docs/howto/accessdrapi.md @@ -6,13 +6,13 @@ Access Domino REST API Admin UI so you can add and configure a schema, add a sco ## Before you begin -You must complete the [**Volt MX Go installation**](../tutorials/installation.md). +You must complete the [Volt MX Go installation](../tutorials/installation.md). ## Procedure ### For Domino REST API installed via an installer -- Check how to login to [**Domino REST API Admin UI**](https://opensource.hcltechsw.com/Domino-rest-api/tutorial/adminui.html#login) in the HCL Domino REST API documentation. +- Check how to login to [Domino REST API Admin UI](https://opensource.hcltechsw.com/Domino-rest-api/tutorial/adminui.html#login) in the HCL Domino REST API documentation. - Use your Domino server administrator username and password to log in. ### For Domino REST API installed as part of the installation on a development or test only environment @@ -24,10 +24,10 @@ You must complete the [**Volt MX Go installation**](../tutorials/installation.md - password: `password` !!!note - If you updated the administrator's first name, last name, and password in the `values.yaml` file in the [**Download the Domino REST API Helm chart**](../tutorials/downloadhelmchart.md#1-download-the-domino-rest-api-helm-chart) procedure, use the updated values for the username and password. + If you updated the administrator's first name, last name, and password in the `values.yaml` file in the [Download the Domino REST API Helm chart](../tutorials/downloadhelmchart.md#1-download-the-domino-rest-api-helm-chart) procedure, use the updated values for the username and password. 3. Click **Log in**. ## Expected result -A successful login leads you to the Domino REST API landing page. For details on adding and configuring a schema, adding a scope and an application, see [**Using Admin UI**](https://opensource.hcltechsw.com/Domino-rest-api/references/usingwebui/index.html) in the HCL Domino REST API documentation. +A successful login leads you to the Domino REST API landing page. For details on adding and configuring a schema, adding a scope and an application, see [Using Admin UI](https://opensource.hcltechsw.com/Domino-rest-api/references/usingwebui/index.html) in the HCL Domino REST API documentation. diff --git a/docs/howto/configrosetta.md b/docs/howto/configrosetta.md index d36e4901..70c08932 100644 --- a/docs/howto/configrosetta.md +++ b/docs/howto/configrosetta.md @@ -30,8 +30,8 @@ You have launched Volt MX Go Iris. |Rosetta area | Rosetta area sections | Description| |-------------|------------|------------| |**API Configuration**| |Allows you to configure options specific to the APIs' implementation and execution. | - | |**Register Custom API**|Allows you to upload a file with custom APIs. Refer to the [**Rosetta API reference documentation**](../javadoc/index.html) under the rosetta-api module for method `registerAPI` for more details on expected file format and parameters.| - | |**Preferred API Implementation**| Allows you to specify whether to execute the **Notes Formula** or the **Open Formula** implementation when calling an API method, which has an existing implementation in either formula language. Example, `@Abs()` and `=ABS()` are encapsulated by Rosettas `abs()` method. Selecting `Notes` option makes Rosetta call the Notes implementation. Usually, either implementation behaves the same. But in other cases, there may be differences in parameters, execution, or returned results. For example, most Notes formula functions allow lists to be passed in as arguments while OpenFormula allows lists as ranges for only a number of methods. Refer to the [**Rosetta API reference documentation**](../javadoc/index.html) for details on each API.| + | |**Register Custom API**|Allows you to upload a file with custom APIs. Refer to the [Rosetta API reference documentation](../javadoc/index.html) under the rosetta-api module for method `registerAPI` for more details on expected file format and parameters.| + | |**Preferred API Implementation**| Allows you to specify whether to execute the **Notes Formula** or the **Open Formula** implementation when calling an API method, which has an existing implementation in either formula language. Example, `@Abs()` and `=ABS()` are encapsulated by Rosettas `abs()` method. Selecting `Notes` option makes Rosetta call the Notes implementation. Usually, either implementation behaves the same. But in other cases, there may be differences in parameters, execution, or returned results. For example, most Notes formula functions allow lists to be passed in as arguments while OpenFormula allows lists as ranges for only a number of methods. Refer to the [Rosetta API reference documentation](../javadoc/index.html) for details on each API.| | **Intellisense Configuration**| |Allows you to include or exclude names of formulas that won't be implemented and not yet implemented in the formula list IntelliSense. When **Include no plans to implement items** is selected, the names of the formulas that won't be implemented are shown as ~~strikethrough text~~. If **Include not yet implemented items** is selected, the names of the formulas that aren't yet implemented are shown but appears dimmed.| |**Converter Configuration**| |Allows you to configure options related to how formulas are converted into their corresponding Rosetta-enabled JavaScript.| | |**Passthrough unrecognized formula language into JavasSript conversion results**|Allows you to specify whether the converter allows unrecognized formula code to be part of the JavaScript conversion results without any massaging, or if it should throw an error when encountering unrecognizable formula code. This allows greater flexibility but also exposes the API to injection of code. **Use with care**.| diff --git a/docs/howto/diagents.md b/docs/howto/diagents.md index 1b26f6f9..cdbf1f1a 100644 --- a/docs/howto/diagents.md +++ b/docs/howto/diagents.md @@ -4,7 +4,7 @@ **Domino Agents** which are part the HCL Domino are part of the `nsf` that only Domino Designer can be able to modify. These `nsf` will be able to use by the Domino REST API to be able to use it for other services. Only those configured Agents in a `nsf` will be available to amend by the Domino REST API. These **Agents** will be imported to Volt MX Go Iris as part of the Design Import. -For more information, see [**Agents**](https://help.hcltechsw.com/dom_designer/14.0.0/basic/H_ABOUT_DESIGNING_AGENTS.html) in the HCL Domino Designer documentation. +For more information, see [Agents](https://help.hcltechsw.com/dom_designer/14.0.0/basic/H_ABOUT_DESIGNING_AGENTS.html) in the HCL Domino Designer documentation. ## About this task @@ -16,7 +16,7 @@ Shows you how the **Agents** are imported to the Volt MX Iris Go Design Import. ## Procedure -1. You must finish the procedure [**importing Domino Application**](../tutorials/designimport.md#import-a-domino-application-using-a-new-volt-mx-go-foundry-app). +1. You must finish the procedure [importing Domino Application](../tutorials/designimport.md#import-a-domino-application-using-a-new-volt-mx-go-foundry-app). !!!important - For the Volt MX Go release v2.0.4, only limited Agents are supported. diff --git a/docs/howto/drapiingress.md b/docs/howto/drapiingress.md index bef91261..6e4ba2f6 100644 --- a/docs/howto/drapiingress.md +++ b/docs/howto/drapiingress.md @@ -27,15 +27,15 @@ Familiarize yourself with the various properties and parameters related to Kuber - **ingress.tls.drapiCustomCert**: Use to specify a Custom SSL certificate for Domino REST API. If `ingress.tls.drapiCustomCert.cert` and `ingress.tls.drapiCustomCert.key` are not set, the Cluster SSL certificate will be used for TLS. - - **ingress.tls.drapiCustomCert.cert**: The file name for the custom certificate. Place your SSL certificate file in the top level direct `drapi` directory (where `values.yaml` is located). The value of this property should be a file path of the form `my-drapi-custom-cert.cert` where my-drapi-custom-cert.cert is the name of your certificate file. This certificate must be in DER format as per [**Section 5.1 of RFC 7468**](https://datatracker.ietf.org/doc/html/rfc7468#section-5.1). + - **ingress.tls.drapiCustomCert.cert**: The file name for the custom certificate. Place your SSL certificate file in the top level direct `drapi` directory (where `values.yaml` is located). The value of this property should be a file path of the form `my-drapi-custom-cert.cert` where my-drapi-custom-cert.cert is the name of your certificate file. This certificate must be in DER format as per [Section 5.1 of RFC 7468](https://datatracker.ietf.org/doc/html/rfc7468#section-5.1). - - **ingress.tls.drapiCustomCert.key**: The file name for the custom key. Place your SSL certificate key file in the top level direct 'drapi' directory (where values.yaml is located). The value of this property should be of the form `my-drapi-custom-cert.key` where my-drapi-custom-cert.key is the name of your private key file. The key file must be PKCS #8 in DER format [**Section 11 of RFC 7468**](https://datatracker.ietf.org/doc/html/rfc7468#section-11). + - **ingress.tls.drapiCustomCert.key**: The file name for the custom key. Place your SSL certificate key file in the top level direct 'drapi' directory (where values.yaml is located). The value of this property should be of the form `my-drapi-custom-cert.key` where my-drapi-custom-cert.key is the name of your private key file. The key file must be PKCS #8 in DER format [Section 11 of RFC 7468](https://datatracker.ietf.org/doc/html/rfc7468#section-11). - **ingress.tls.drapiManagementCustomCert**: Use to specify a Custom SSL certificate for Domino REST API. If `ingress.tls.drapiCustomCert.cert` and `ingress.tls.drapiCustomCert.key` are not set, then the Cluster SSL certificate will be used for TLS. - - **ingress.tls.drapiManagementCustomCert.cert**: The file name for the custom certificate. Place your SSL certificate file in the top level direct `drapi` directory (where `values.yaml` is located). The value of this property should be a file path of the form `my-drapi-mgmt-custom-cert.cert` where my-drapi-mgmtcustom-cert.cert is the name of your certificate file. This certificate must be in DER format as per [**Section 5.1 of RFC 7468**](https://datatracker.ietf.org/doc/html/rfc7468#section-5.1). + - **ingress.tls.drapiManagementCustomCert.cert**: The file name for the custom certificate. Place your SSL certificate file in the top level direct `drapi` directory (where `values.yaml` is located). The value of this property should be a file path of the form `my-drapi-mgmt-custom-cert.cert` where my-drapi-mgmtcustom-cert.cert is the name of your certificate file. This certificate must be in DER format as per [Section 5.1 of RFC 7468](https://datatracker.ietf.org/doc/html/rfc7468#section-5.1). - - **ingress.tls.drapiManagementCustomCert.key**: The file name for the custom key. Place your SSL certificate key file in the top level direct 'drapi' directory (where values.yaml is located). The value of this property should be of the form `my-drapi-mgmt-custom-cert.key` where my-drapi-mgmt-custom-cert.key is the name of your private key file. The key file must be PKCS #8 in DER format [**Section 11 of RFC 7468**](https://datatracker.ietf.org/doc/html/rfc7468#section-11). + - **ingress.tls.drapiManagementCustomCert.key**: The file name for the custom key. Place your SSL certificate key file in the top level direct 'drapi' directory (where values.yaml is located). The value of this property should be of the form `my-drapi-mgmt-custom-cert.key` where my-drapi-mgmt-custom-cert.key is the name of your private key file. The key file must be PKCS #8 in DER format [Section 11 of RFC 7468](https://datatracker.ietf.org/doc/html/rfc7468#section-11). - **ingress.annotations**: Allows you to specify additional annotations that will be added to every ingress object. Add one annotation per line. Each annotation should be indented 2 spaces and of the format `annotationName: value`. When rendered, your annotation value will automatically be quoted. @@ -45,11 +45,11 @@ Familiarize yourself with the various properties and parameters related to Kuber You can configure Kubernetes Ingress to accept connections over HTTP or HTTPS. HTTP isn't secure but works without any extra configuration. It's recommended to use HTTPS for most deployments. !!!note - You can't easily change the deployment domain name once installed, this includes changing from HTTP to HTTPS. For more information, see [**How to change Hostname/IP address and port details of Volt MX Go Foundry Server?**](https://support.hcltechsw.com/csm?id=kb_article&sysparm_article=KB0089025). + You can't easily change the deployment domain name once installed, this includes changing from HTTP to HTTPS. For more information, see [How to change Hostname/IP address and port details of Volt MX Go Foundry Server?](https://support.hcltechsw.com/csm?id=kb_article&sysparm_article=KB0089025). One approach to enable HTTPS is to use a self-signed SSL certificate, which avoids purchasing your own certificate from a Certificate Authority (CA). However, since Volt MX Go Foundry makes back-end server to server requests between applications, there are more steps to enable Volt MX Go Foundry to trust the secured communication channel when utilizing a self-signed certificate. -If you configure your Kubernetes Ingress to use a self-signed SSL certificate or an SSL certificate from your enterprise's own Certificate Authority that's not within a trusted root certification path, or if you use the cluster default cert created from a self-signed CA, you need to add the SSL certificate or CA certificate to the trust store used by Tomcat. Failure to do so results in runtime errors when Volt MX Go Foundry components need to communicate with each other. For more information, see [**Certification Authority Trust Model**](http://technet.microsoft.com/en-us/library/cc962065.aspx). +If you configure your Kubernetes Ingress to use a self-signed SSL certificate or an SSL certificate from your enterprise's own Certificate Authority that's not within a trusted root certification path, or if you use the cluster default cert created from a self-signed CA, you need to add the SSL certificate or CA certificate to the trust store used by Tomcat. Failure to do so results in runtime errors when Volt MX Go Foundry components need to communicate with each other. For more information, see [Certification Authority Trust Model](http://technet.microsoft.com/en-us/library/cc962065.aspx). ## Procedure @@ -61,9 +61,9 @@ If you configure your Kubernetes Ingress to use a self-signed SSL certificate or You can use any of the following options: - Purchase a certificate from a trusted Certificate Authority -- Obtain a free certificate from [**Let's Encrypt**](https://letsencrypt.org/) or [**ZeroSSL**](https://zerossl.com). -- For test purposes, [**create a self-signed certificate**](#create-a-self-signed-certificate). -- Use the [**Kubernetes default cluster certificate**](#obtain-default-cluster-certificate) by pulling it from your cluster. +- Obtain a free certificate from [Let's Encrypt](https://letsencrypt.org/) or [ZeroSSL](https://zerossl.com). +- For test purposes, [create a self-signed certificate](#create-a-self-signed-certificate). +- Use the [Kubernetes default cluster certificate](#obtain-default-cluster-certificate) by pulling it from your cluster. #### Create a self-signed certificate @@ -100,7 +100,7 @@ The following procedure could be used to generate a self-signed certificate: cat drapi-server.crt | sed -ne '/-BEGIN CERTIFICATE/,/END CERTIFICATE/p' > ./drapi-server.pem ``` -5. Proceed to [**import drapi-server.pem into the trust store**](#3-import-certificate-into-the-truststore-with-keytool). +5. Proceed to [import drapi-server.pem into the trust store](#3-import-certificate-into-the-truststore-with-keytool). #### Obtain default Cluster Certificate @@ -114,7 +114,7 @@ The following procedure could be used to generate a self-signed certificate: The parameter following `-connect` must be a DNS name or IP address that resolves to your OpenShift ingress. The `-servername` parameter specifies the DNS name you use to access your Volt MX Go Foundry deployment. This should match the value you specified for `serverDomainName` in `values.yaml`. The DNS names could be the same as long as they resolve to the IP address of your Kubernetes load balancer in front of Ingress or Ingress itself. -2. Proceed to [**Import the Certificate into the truststore with keytool**](#3-import-certificate-into-the-truststore-with-keytool). +2. Proceed to [Import the Certificate into the truststore with keytool](#3-import-certificate-into-the-truststore-with-keytool). ### 2. Copy your SSL certificates and keys into the Domino REST API top level directory @@ -131,7 +131,7 @@ The following procedure could be used to generate a self-signed certificate: cp ~/drapi-management-server.key . ``` -2. [**Update parameters in `values.yaml`**](#4-update-the-helm-valuesyaml) with these file names. +2. [Update parameters in `values.yaml`](#4-update-the-helm-valuesyaml) with these file names. ### 3. Import certificate into the truststore with keytool @@ -159,7 +159,7 @@ For more information about `keytool`, see [Java Keytool documentation](https://d - Update your `values.yaml` with the following configuration details to properly configure SSL. - Check the notes for specific use cases and refer to Kubernetes Ingress details in [**Before you begin**](#before-you-begin) for more details on each parameter. + Check the notes for specific use cases and refer to Kubernetes Ingress details in [Before you begin](#before-you-begin) for more details on each parameter. ``` bash @@ -180,5 +180,5 @@ ingress.tls.drapiManagementCustomCert.key: “drapi-management-server.key” - The `drapiCustomCert.cert`, `drapiCustomCert.key`, `drapiManagementCustomCert.cert`, and `drapiManagementCustomCert.key` details can be omitted when using the default cluster certificate. If you go with this approach, make sure that the DNS hostname which you will access the deployment with matches the host name details in the certificate. Otherwise, the backend communication will fail because the host name doesn't match. -Return to [**Deploy Domino REST API**](../tutorials/downloadhelmchart.md#2-deploy-domino-rest-api). +Return to [Deploy Domino REST API](../tutorials/downloadhelmchart.md#2-deploy-domino-rest-api). diff --git a/docs/howto/foundryadminaccount.md b/docs/howto/foundryadminaccount.md index 6766118c..2160a335 100644 --- a/docs/howto/foundryadminaccount.md +++ b/docs/howto/foundryadminaccount.md @@ -12,7 +12,7 @@ You must complete the [Volt MX Go installation](../tutorials/installation.md). ### For Volt MX Go Foundry installed via installers -- Check the procedure on [**how to get started with Volt MX Foundry Console**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_user_guide/Content/How_to_access_VoltMX_Foundry_Portal_on-Prem.html). +- Check the procedure on [how to get started with Volt MX Foundry Console](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_user_guide/Content/How_to_access_VoltMX_Foundry_Portal_on-Prem.html). You can also contact the Volt MX Go Foundry administrator to request for an administrator account. diff --git a/docs/howto/index.md b/docs/howto/index.md index a2272ae6..b75b25e9 100644 --- a/docs/howto/index.md +++ b/docs/howto/index.md @@ -2,12 +2,12 @@ How-to guides instruct users in completing key goals and tasks related to Volt MX Go. -- [**Install**](howtoinstall.md) -- [**Design Import**](diindex.md) -- [**VoltFormula**](vfindex.md) -- [**First Touch**](ftindex.md) -- [**Operation**](genindex.md) -- [**Uninstall**](uninstall.md) +- [Install](howtoinstall.md) +- [Design Import](diindex.md) +- [VoltFormula](vfindex.md) +- [First Touch](ftindex.md) +- [Operation](genindex.md) +- [Uninstall](uninstall.md) diff --git a/docs/howto/insertattachments.md b/docs/howto/insertattachments.md index 2ef41b13..e8bdc02f 100644 --- a/docs/howto/insertattachments.md +++ b/docs/howto/insertattachments.md @@ -6,8 +6,8 @@ Guides you on how to insert attachments via the [Summernote Editor](../reference ## Before you begin -- You have [**generated CRUD forms for Object Service**](codegen.md). -- You have [**built and published your app in Volt MX Go Iris**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_user_guide/Content/Cloud_Build_in_VoltMX_Iris.html#post-successful-build). +- You have [generated CRUD forms for Object Service](codegen.md). +- You have [built and published your app in Volt MX Go Iris](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_user_guide/Content/Cloud_Build_in_VoltMX_Iris.html#post-successful-build). !!!note "Important" Make sure that you included the virtual field `$FILES` in the form configured in Domino REST API. @@ -61,4 +61,4 @@ You can download attachments from the Grid or Details form of a document. - To download all attachments, click **Download All Attachments**. - To download an individual attachment, click the attachment file link on the rich text field. -To learn more about attachments, see [**Attachments**](../topicguides/method.md#attachments). \ No newline at end of file +To learn more about attachments, see [Attachments](../topicguides/method.md#attachments). \ No newline at end of file diff --git a/docs/howto/k3suninstall.md b/docs/howto/k3suninstall.md index c4337e3b..10754579 100644 --- a/docs/howto/k3suninstall.md +++ b/docs/howto/k3suninstall.md @@ -14,4 +14,4 @@ Guides you in uninstalling K3s in case you want to start over with the K3s insta sudo k3s-uninstall.sh ``` -For more information, see [**Uninstalling K3s**](https://docs.k3s.io/installation/uninstall). \ No newline at end of file +For more information, see [Uninstalling K3s](https://docs.k3s.io/installation/uninstall). \ No newline at end of file diff --git a/docs/howto/uninstall.md b/docs/howto/uninstall.md index ece148be..23840854 100644 --- a/docs/howto/uninstall.md +++ b/docs/howto/uninstall.md @@ -7,6 +7,6 @@ List of uninstall procedures for completing uninstall tasks related to Volt MX G - [Uninstall First Touch](uninstallfirsttouch.md) - [Uninstall Volt MX Go Foundry for Linux](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_linux_install_guide/Content/Uninstalling_VoltMX_Foundry.html) - [Uninstall Volt MX Go Foundry for Windows](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_windows_install_guide/Content/Uninstalling_VoltMX_Foundry.html) -- [Uninstall Volt MX Go Foundry installled on supported Kubernetes platform](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmxfoundry_containers_helm/Content/Installing_Containers_With_Helm.html#uninstalling-foundry) +- [Uninstall Volt MX Go Foundry installed on supported Kubernetes platform](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmxfoundry_containers_helm/Content/Installing_Containers_With_Helm.html#uninstalling-foundry) - [Uninstall Volt MX Go Iris for Windows](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_starter_install_win/Content/Uninstalling%20VoltMX%20Iris.html) - [Uninstall Volt MX Go Iris for Mac](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_starter_install_mac/Content/Uninstalling%20VoltMX%20Iris.html) \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 759ada1c..a9ee0d51 100644 --- a/docs/index.md +++ b/docs/index.md @@ -13,7 +13,7 @@ Volt MX Go modernizes and extends the value of your Domino applications with the - expanding who can code applications built in Domino, allowing for app modernization or migration without requiring a complete rewrite of the code - importing existing Domino views, forms, and fields into Volt MX Go Foundry to get a head start on your Volt MX Go applications -To learn more, see [**Introducing Volt MX Go**](topicguides/introvoltmxgo.md "Links to the topic introducing Volt MX Go"){aria-label="This is a link"}. +To learn more, see [Introducing Volt MX Go](topicguides/introvoltmxgo.md "Links to the topic introducing Volt MX Go"){aria-label="This is a link"}. --- ## Get started @@ -27,7 +27,7 @@ To learn more, see [**Introducing Volt MX Go**](topicguides/introvoltmxgo.md "Li --- ## What's new -For the latest release information about Volt MX Go, see [**What's new**](references/whatsnew/whatisnew.md). +For the latest release information about Volt MX Go, see [What's new](references/whatsnew/whatisnew.md). --- @@ -41,7 +41,7 @@ For the latest release information about Volt MX Go, see [**What's new**](refere --- ## How the documentation is organized -The Volt MX Go documentation is based on the [**Diátaxis framework**](https://diataxis.fr/), which organizes documentation into the following modes to address users' documentation needs at different times and in different circumstances. Below shows an overview that guides you on where to look for needed information: +The Volt MX Go documentation is based on the [Diátaxis framework](https://diataxis.fr/), which organizes documentation into the following modes to address users' documentation needs at different times and in different circumstances. Below shows an overview that guides you on where to look for needed information: **[Tutorials](tutorials/index.md)** - Hands-on introduction to Volt MX Go @@ -52,5 +52,5 @@ The Volt MX Go documentation is based on the [**Diátaxis framework**](https://d **[References](references/index.md)** - Technical references and descriptions on using Volt MX Go !!!tip - For more information on using the Volt MX Go documentation, see [**Guide to documentation**](references/docguide.md). + For more information on using the Volt MX Go documentation, see [Guide to documentation](references/docguide.md). diff --git a/docs/references/docguide.md b/docs/references/docguide.md index 7be5c67a..03793ba0 100644 --- a/docs/references/docguide.md +++ b/docs/references/docguide.md @@ -39,6 +39,7 @@ The search result shows the number of documents with content matching all or any ## Support and community -- To open support tickets, go to the [**Customer Support**](https://support.hcltechsw.com/csm "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"} ![link image](../assets/images/external-link.svg){: style="height:15px;width:15px"} portal. -- To share information, ask questions, and learn about Volt MX Go, go to the [**Community**](https://support.hcltechsw.com/community?id=community_forum&sys_id=2a45adef1bc4fd14a67e9759bc4bcb3d "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"} ![link image](../assets/images/external-link.svg){: style="height:15px;width:15px"} portal. +To open support tickets, go to the [Customer Support](https://support.hcltechsw.com/csm "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"} ![link image](../assets/images/external-link.svg){: style="height:15px;width:15px"} portal. + +To share information, ask questions, and learn about Volt MX Go, go to the [Community](https://support.hcltechsw.com/community?id=community_forum&sys_id=2a45adef1bc4fd14a67e9759bc4bcb3d "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"} ![link image](../assets/images/external-link.svg){: style="height:15px;width:15px"} portal. diff --git a/docs/references/index.md b/docs/references/index.md index 3c0170cb..84b6eb50 100644 --- a/docs/references/index.md +++ b/docs/references/index.md @@ -4,75 +4,75 @@ Provides technical references and descriptions for using Volt MX Go. ## What's new -Check the [**latest information**](whatsnew/whatisnew.md) about Volt MX Go. +Check the [latest information](whatsnew/whatisnew.md) about Volt MX Go. -To know the details in the early access version, see [**Early Access Version changes**](earlyaccesschanges.md){: target="blank"}. +To know the details in the early access version, see [Early Access Version changes](earlyaccesschanges.md){: target="blank"}. ## System requirements -Check the minimum [**System requirements**](../tutorials/sysreq.md) for deploying Volt MX Go. +Check the minimum [System requirements](../tutorials/sysreq.md) for deploying Volt MX Go. ## Compatibility matrix -Check [**version compatibility**](compatibilitymatrix.md) between Volt MX Go and Domino REST API. +Check [version compatibility](compatibilitymatrix.md) between Volt MX Go and Domino REST API. ## Rosetta API reference documentation -The full specification of the API is available in a structured format in the [**Rosetta API reference documentation**](../javadoc/index.html). +The full specification of the API is available in a structured format in the [Rosetta API reference documentation](../javadoc/index.html). -For the implementation status, see [**Rosetta API implementation status**](../javadoc/api_status.html). +For the implementation status, see [Rosetta API implementation status](../javadoc/api_status.html). ## VoltFormula coding practices -Recommended [**VoltFormula coding practices**](../topicguides/vfcodingguides.md) in Volt MX Go Iris. +Recommended [VoltFormula coding practices](../topicguides/vfcodingguides.md) in Volt MX Go Iris. ## Helm and Kubectl commands -Useful [**Helm and Kubectl commands**](kubecheatsheet.md) related to [**Volt MX Go installation**](../tutorials/installation.md). +Useful [Helm and Kubectl commands](kubecheatsheet.md) related to [Volt MX Go installation](../tutorials/installation.md). ## Logging levels -Describes different [**logging levels**](reflogginglevels.md) for better monitoring and evaluation of activities and events. +Describes different [logging levels](reflogginglevels.md) for better monitoring and evaluation of activities and events. ## Documentation references -[**HCL Volt MX Documentation**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/index.html) +[HCL Volt MX Documentation](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/index.html) - Provides documentation and more information about Volt MX Iris and Volt MX Foundry. -[**HCL Domino REST API Documentation**](https://opensource.hcltechsw.com/Domino-rest-api/index.html) +[HCL Domino REST API Documentation](https://opensource.hcltechsw.com/Domino-rest-api/index.html) - Provides documentation and more information about Domino REST API. -[**HCL Domino Documentation**](https://help.hcltechsw.com/domino/welcome/index.html) +[HCL Domino Documentation](https://help.hcltechsw.com/domino/welcome/index.html) - Provides documentation and more information on how to install, configure, and manage Domino servers and related components. -[**HCL Software Product Documentation**](https://help.hcltechsw.com/) +[HCL Software Product Documentation](https://help.hcltechsw.com/) - Provides a complete list of links to the documentation of different HCL Software products. -[**VoltScript**](https://help.hcltechsw.com/docs/voltscript/early-access/index.html) +[VoltScript](https://help.hcltechsw.com/docs/voltscript/early-access/index.html) - Provides documentation and more information about the **early access version** of VoltScript and related components. ## Known limitations -List of [**known limitations**](knownlimitation.md) of Volt MX Go. +List of [known limitations](knownlimitation.md) of Volt MX Go. ## Troubleshooting -To learn about identified issues and their corresponding workarounds and resolutions, see [**Troubleshooting**](troubleshoot.md). +To learn about identified issues and their corresponding workarounds and resolutions, see [Troubleshooting](troubleshoot.md). ## Support -- To open support tickets, go to the [**Customer Support**](https://support.hcltechsw.com/csm "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"} ![link image](../assets/images/external-link.svg){: style="height:15px;width:15px"} portal. +- To open support tickets, go to the [Customer Support](https://support.hcltechsw.com/csm "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"} ![link image](../assets/images/external-link.svg){: style="height:15px;width:15px"} portal. -- To share information, ask questions, and learn about Volt MX Go, go to the [**Community**](https://support.hcltechsw.com/community?id=community_forum&sys_id=2a45adef1bc4fd14a67e9759bc4bcb3d "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"} ![link image](../assets/images/external-link.svg){: style="height:15px;width:15px"} portal. +- To share information, ask questions, and learn about Volt MX Go, go to the [Community](https://support.hcltechsw.com/community?id=community_forum&sys_id=2a45adef1bc4fd14a67e9759bc4bcb3d "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"} ![link image](../assets/images/external-link.svg){: style="height:15px;width:15px"} portal. ## Summernote Editor -[**Summernote Editor**](summernotewidget.md) enables you to add a WYSIWYG editor to your form for handling rich text. +[Summernote Editor](summernotewidget.md) enables you to add a WYSIWYG editor to your form for handling rich text. ## Guide to documentation -Provides a [**guide**](docguide.md) on using the Volt MX Go documentation. \ No newline at end of file +Provides a [guide](docguide.md) on using the Volt MX Go documentation. \ No newline at end of file diff --git a/docs/references/knownlimitation.md b/docs/references/knownlimitation.md index 479c6c11..d13d6125 100644 --- a/docs/references/knownlimitation.md +++ b/docs/references/knownlimitation.md @@ -26,7 +26,7 @@ Verb mapping isn't supported for binary verbs in the Volt MX Go Foundry Console. If a document is hard deleted in the Domino DB by another app, the devices using the offline sync DB won't know about this deletion, and any subsequent sync calls won't remove the document from the sync DB. This results in a stranded document on the device, but not in the back end. -To resolve stranded documents in an offline app, use the [**`clearOfflineData`**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/offline_objectsapi_reference_guide/Content/Object_clearOfflineData.html) function provided by the Volt MX SDK in Volt MX Go Iris. The function clears out the device's sync DB at the level you choose (app level, object service level, object level) so that syncing the app with the back end fully syncs all data without sending any hard deleted documents and allows the device's sync DB to match up with what's in the back end. +To resolve stranded documents in an offline app, use the [`clearOfflineData`](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/offline_objectsapi_reference_guide/Content/Object_clearOfflineData.html) function provided by the Volt MX SDK in Volt MX Go Iris. The function clears out the device's sync DB at the level you choose (app level, object service level, object level) so that syncing the app with the back end fully syncs all data without sending any hard deleted documents and allows the device's sync DB to match up with what's in the back end. ### Soft delete @@ -41,6 +41,7 @@ Disabling document deletion on the Domino DB if using it with an offline-enabled ## VoltFormula -- Date APIs for Notes implementations return JavaScript Date Objects, which differ from Notes Date Objects. -- Prompt `[LocalBrowse]` and `[ChooseDatabase]` for Volt MX Go Iris application don't have a filter setting for file type since only [**registered file types**](https://www.iana.org/assignments/media-types/media-types.xhtml) are allowed in [**voltmx.io.FileSystem**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_api_dev_guide/content/voltmx.io.filesystem_functions.html). +Date APIs for Notes implementations return JavaScript Date Objects, which differ from Notes Date Objects. + +Prompt `[LocalBrowse]` and `[ChooseDatabase]` for Volt MX Go Iris application don't have a filter setting for file type since only [registered file types](https://www.iana.org/assignments/media-types/media-types.xhtml) are allowed in [voltmx.io.FileSystem](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_api_dev_guide/content/voltmx.io.filesystem_functions.html). diff --git a/docs/references/summernotewidget.md b/docs/references/summernotewidget.md index 1c6b1efe..082ce111 100644 --- a/docs/references/summernotewidget.md +++ b/docs/references/summernotewidget.md @@ -16,10 +16,10 @@ Following are some use cases of the Summernote Editor component: You will find the Summernote Editor component in the Default Library. To use the Summernote Editor component, drag and drop it onto the custom form. You can then configure its placement and utilize its properties to retrieve and set data on the editor. -For more information on components, see [**Use Components**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_user_guide/Content/C_UsingComponents.html) and [**Creating Applications with Components**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_user_guide/Content/C_DesigningWorkingWithComponents.html) in the Volt MX documentation. +For more information on components, see [Use Components](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_user_guide/Content/C_UsingComponents.html) and [Creating Applications with Components](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_user_guide/Content/C_DesigningWorkingWithComponents.html) in the Volt MX documentation. !!!note - When performing code generation of forms, the Summernote Editor component is included only if a rich text field is found on the form in the Domino REST API. For more information on code generation of forms, see [**Generate CRUD forms for Object Service**](../howto/codegen.md). + When performing code generation of forms, the Summernote Editor component is included only if a rich text field is found on the form in the Domino REST API. For more information on code generation of forms, see [Generate CRUD forms for Object Service](../howto/codegen.md). ## Methods @@ -32,7 +32,7 @@ Methods are used by the form to interact with the Summernote Editor component. 3. In the **Properties** pane, click the **Action** tab. 4. Click **Manage Methods** to open the **Manage Methods** dialog. -You can now configure the component methods. For more information, see [**Manage Methods**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_user_guide/Content/C_CreatingComponent.html#manage-methods-of-a-component-with-a-contract) in the HCL Volt MX Documentation. +You can now configure the component methods. For more information, see [Manage Methods](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_user_guide/Content/C_CreatingComponent.html#manage-methods-of-a-component-with-a-contract) in the HCL Volt MX Documentation. **Methods** @@ -69,7 +69,7 @@ You need a default property to build the Summernote Editor component. The table 3. In the **Properties** pane, click the **Component** tab. 4. Click **Manage Properties** to open the **Manage Properties** dialog. -You can now configure the component properties. For more information, see [**Manage Properties**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_user_guide/Content/C_CreatingComponent.html#manage-properties-of-a-component-with-a-contract) in the HCL Volt MX Documentation. +You can now configure the component properties. For more information, see [Manage Properties](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_user_guide/Content/C_CreatingComponent.html#manage-properties-of-a-component-with-a-contract) in the HCL Volt MX Documentation. **Properties** @@ -81,4 +81,4 @@ You can now configure the component properties. For more information, see [**Man ## Additional information -To learn more, see [**Summernote Editor**](https://summernote.org/). \ No newline at end of file +To learn more, see [Summernote Editor](https://summernote.org/). \ No newline at end of file diff --git a/docs/references/troubleshoot.md b/docs/references/troubleshoot.md index 6ffcfdaf..a29ea4c4 100644 --- a/docs/references/troubleshoot.md +++ b/docs/references/troubleshoot.md @@ -18,7 +18,7 @@ List of issues and corresponding resolutions. You should contact your Domino administrator to update your assigned access level to the Domino database to *Designer*. - [^1]: **The Maximum Access Level refers to access through the Domino REST API and doesn't override the database's ACL. The access level granted to the user in the Domino database ACL won't be exceeded. For example, if a user has Reader access in the Domino database ACL and the maximum access level for the scope in the Domino REST API is Editor, the user still won't be able to create or edit documents.** + [^1]: The Maximum Access Level refers to access through the Domino REST API and doesn't override the database's ACL. The access level granted to the user in the Domino database ACL won't be exceeded. For example, if a user has Reader access in the Domino database ACL and the maximum access level for the scope in the Domino REST API is Editor, the user still won't be able to create or edit documents. - **Domino REST API schema misconfigured settings** @@ -42,14 +42,14 @@ List of issues and corresponding resolutions. The issue occurs when only the **default** mode is declared. Make sure to add the **dql** mode before importing the schema. -Contact your Domino Rest API administrator for assistance in complying with the Domino Rest API related [**prerequisites for importing Domino Application**](../tutorials/designimport.md#before-you-begin). +Contact your Domino Rest API administrator for assistance in complying with the Domino Rest API related [prerequisites for importing Domino Application](../tutorials/designimport.md#before-you-begin). ## First Touch -- [**First Touch or Custom Application Fails to Install on Volt MX Go Foundry**](https://support.hcltechsw.com/csm?id=kb_article&sysparm_article=KB0106427) +- [First Touch or Custom Application Fails to Install on Volt MX Go Foundry](https://support.hcltechsw.com/csm?id=kb_article&sysparm_article=KB0106427) !!!note - This issue and its corresponding resolution aren't applicable when setting up First Touch in Volt MX Go [**installed in a development or test-only environment**](../tutorials/containerdeployment.md). + This issue and its corresponding resolution aren't applicable when setting up First Touch in Volt MX Go [installed in a development or test-only environment](../tutorials/containerdeployment.md). ## General issues diff --git a/docs/topicguides/datamodel.md b/docs/topicguides/datamodel.md index b1abf0b2..042ff79e 100644 --- a/docs/topicguides/datamodel.md +++ b/docs/topicguides/datamodel.md @@ -8,11 +8,11 @@ Data models can be generated in an Object Service by Volt MX Go Foundry administ `Forms` and `views` are created in a Domino REST API `schema` and named by a Domino REST API `scope`. -In addition to some [**Meta fields**](#meta-fields), generated data models include: +In addition to some [Meta fields](#meta-fields), generated data models include: - **Form** data models include all fields defined by the associated Domino REST API `schema`. - **View** data models include all view columns defined in the NSF design. -- [**Other Metadata**](#other-metadata) data models include fields that pertain to the requested information. +- [Other Metadata](#other-metadata) data models include fields that pertain to the requested information. Volt MX Go Foundry data models are in sync with the Domino REST API `schema` at the time of data model generation. The data models may be out of sync with the `schema`, which may lead to undesired or unexpected results, because of the following: @@ -20,7 +20,7 @@ Volt MX Go Foundry data models are in sync with the Domino REST API `schema` at - schema is modified in Domino REST API - changes in the NSF design -For more information on schemas, scopes, forms, and views, see [**Using Admin UI**](https://opensource.hcltechsw.com/Domino-rest-api/tutorial/adminui.html) in the Domino REST API documentation. +For more information on schemas, scopes, forms, and views, see [Using Admin UI](https://opensource.hcltechsw.com/Domino-rest-api/tutorial/adminui.html) in the Domino REST API documentation. ## Data model artifact names @@ -67,8 +67,8 @@ The table shows a simplified list of data-type mappings between Domino REST API |BOOLEAN|boolean|Example: `true`| |BINARY|string|| |AUTHORS, NAMES, PASSWORD, READERS|string|| -|RICH TEXT|string|Field values are in Base64-encoded HTML format.

For more information, see [**Data model metadata attribute**](#data-model-metadata-attribute).| -|ARRAY|string|Field values are "stringified JSON Array"
Example: `"[\"flour\",\"eggs\"]"`

Other data types may also be marked as multi-value, in which case the JSON array contains values of the corresponding type. Examples:
String array: `"[\"flour\",\"eggs\"]"`
Number array: `"[1,2]"`
Author array: `"[\"CN=mxgo admin/O=ocp\",\"[Admin]\"]"]"`

For more information, see [**Data model metadata attribute**](#data-model-metadata-attribute).| +|RICH TEXT|string|Field values are in Base64-encoded HTML format.

For more information, see [Data model metadata attribute](#data-model-metadata-attribute).| +|ARRAY|string|Field values are "stringified JSON Array"
Example: `"[\"flour\",\"eggs\"]"`

Other data types may also be marked as multi-value, in which case the JSON array contains values of the corresponding type. Examples:
String array: `"[\"flour\",\"eggs\"]"`
Number array: `"[1,2]"`
Author array: `"[\"CN=mxgo admin/O=ocp\",\"[Admin]\"]"]"`

For more information, see [Data model metadata attribute](#data-model-metadata-attribute).| |all others|string| ## Meta fields @@ -108,7 +108,7 @@ x_0040unid - **All `meta-fields` aren't sortable**. - UNID is unique for any set of documents returned on `GET` for a form-based data model. However, UNID isn't necessarily unique for view rows since more than one row in a view may be associated with the same database document. - Meta-fields are included in generated data models by default. The Volt MX Go Foundry developer can modify the generated data model as needed, such as removing `meta-field` if desired. - - `x_0040aliases` doesn't correspond to any attribute in Domino. Documents won't contain any value for this attribute. However, it's for attaching metadata with form name aliases. For more information, see [**Data model metadata attribute**](#data-model-metadata-attribute). + - `x_0040aliases` doesn't correspond to any attribute in Domino. Documents won't contain any value for this attribute. However, it's for attaching metadata with form name aliases. For more information, see [Data model metadata attribute](#data-model-metadata-attribute). - Offline objects require a data model to specify a primary key field. `x_0040unid` needs to be set as the primary key for Domino data models. However, with views, the returning list of data may contain items with no UNID or items with the same UNID.

Items with no UNID occur when querying categorized views. These items with no UNID are top-level category items. To avoid receiving these items, a user must scope the view request to return only the document items using the OData filter parameter `?$filter=x_0040scope eq documents`.

For items with the same UNID, errors may occur when syncing data to the front end. ## Data model metadata attribute diff --git a/docs/topicguides/declvariables.md b/docs/topicguides/declvariables.md index 9a417efb..d59c2007 100644 --- a/docs/topicguides/declvariables.md +++ b/docs/topicguides/declvariables.md @@ -4,10 +4,10 @@ There are two mechanisms by which the Rosetta Converter accepts and converts variables into JavasScript: -- [**LET function**](https://support.microsoft.com/en-us/office/let-function-34842dd8-b92b-4d3f-b325-b8b8f9908999) in Excel[^1] +- [LET function](https://support.microsoft.com/en-us/office/let-function-34842dd8-b92b-4d3f-b325-b8b8f9908999) in Excel[^1] - JSP style syntax (code passthrough) -[^1]: **Excel is a registered trademark or trademark of Microsoft Corporation in the United States and/or other countries.** +[^1]: Excel is a registered trademark or trademark of Microsoft Corporation in the United States and/or other countries. ## Using LET function with OpenFormula @@ -20,7 +20,7 @@ There are two mechanisms by which the Rosetta Converter accepts and converts var ## Using JSP style syntax -The converter uses **JSP expression** syntax in **OpenFormula** formulas to provide capabilities for formula conversion not currently possible with strict OpenFormula syntax. For more information, see [**JSP expression syntax**](https://docs.oracle.com/javaee/5/tutorial/doc/bnaov.html). +The converter uses **JSP expression** syntax in **OpenFormula** formulas to provide capabilities for formula conversion not currently possible with strict OpenFormula syntax. For more information, see [JSP expression syntax](https://docs.oracle.com/javaee/5/tutorial/doc/bnaov.html). Example: @@ -43,4 +43,4 @@ Examples: !!!note - To use JSP expression in formulas, select **Passthrough unrecognized formula language into JavasSript conversion results** checkbox. For more information, see [**Configure VoltFormula's Rosetta API Options**](../howto/configrosetta.md). + To use JSP expression in formulas, select **Passthrough unrecognized formula language into JavasSript conversion results** checkbox. For more information, see [Configure VoltFormula's Rosetta API Options](../howto/configrosetta.md). diff --git a/docs/topicguides/dominoadapter.md b/docs/topicguides/dominoadapter.md index 6e8d26a3..fd78b318 100644 --- a/docs/topicguides/dominoadapter.md +++ b/docs/topicguides/dominoadapter.md @@ -14,7 +14,7 @@ When creating an Object service in Volt MX Go Foundry for Domino, the Volt MX Go The `object` of the Object service essentially has two components: -- [**Data Model**](datamodel.md) - refers to the definition of the fields that comprise the object definition -- [**Methods**](method.md) - verbs for interacting with the data, for example GET, POST +- [Data Model](datamodel.md) - refers to the definition of the fields that comprise the object definition +- [Methods](method.md) - verbs for interacting with the data, for example GET, POST -For more information, see [**Object Services**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_user_guide/Content/Objectservices.html) in the HCL Volt MX documentation. +For more information, see [Object Services](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_user_guide/Content/Objectservices.html) in the HCL Volt MX documentation. diff --git a/docs/topicguides/dominoserver.md b/docs/topicguides/dominoserver.md index 525f0ce0..fc6b1a5f 100644 --- a/docs/topicguides/dominoserver.md +++ b/docs/topicguides/dominoserver.md @@ -2,19 +2,19 @@ --8<-- "devtestenvironment.md" -The [**Volt MX Go installation in a development or test only environment**](../tutorials/containerdeployment.md) offers a Helm chart to run a Domino server enabled with the Domino REST API (DRAPI) in a Kubernetes environment. This topic offers guidance and tips on working with the Domino container. +The [Volt MX Go installation in a development or test only environment](../tutorials/containerdeployment.md) offers a Helm chart to run a Domino server enabled with the Domino REST API (DRAPI) in a Kubernetes environment. This topic offers guidance and tips on working with the Domino container. ## Container basics -When you deploy the Volt MX Go Domino REST API Helm chart, you instruct Kubernetes to create a [**pod**](https://kubernetes.io/docs/concepts/workloads/pods/). The Helm chart provides the specifics for what program (Image) will run when the pod starts, the details around what ports to expose, such as port 80 for Domino HTTP server, port 8880 for Domino REST API, and the memory and CPU allocations among other things. +When you deploy the Volt MX Go Domino REST API Helm chart, you instruct Kubernetes to create a [pod](https://kubernetes.io/docs/concepts/workloads/pods/). The Helm chart provides the specifics for what program (Image) will run when the pod starts, the details around what ports to expose, such as port 80 for Domino HTTP server, port 8880 for Domino REST API, and the memory and CPU allocations among other things. -The chart also tells Kubernetes about [**liveness and readiness probes**](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/). Kubernetes runs these probes periodically to determine container health. If a readiness probe fails more than a specified threshold, the container is marked as unready and won't receive any HTTP traffic. If a liveness probe fails many times, Kubernetes assumes the container has unrecoverable errors and then kills and restarts the container. +The chart also tells Kubernetes about [liveness and readiness probes](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/). Kubernetes runs these probes periodically to determine container health. If a readiness probe fails more than a specified threshold, the container is marked as unready and won't receive any HTTP traffic. If a liveness probe fails many times, Kubernetes assumes the container has unrecoverable errors and then kills and restarts the container. These probes are important to understand as some operations require you to stop and restart Domino. If Domino fails to answer liveness probes more than the specified threshold, such as when Domino is stopped, Kubernetes may remove the container and start a new one. By default, this period is 10 minutes for the Domino container. The Domino data directory resides in `/local/notesdata` within the Domino container. This directory is actually a mount point for a persistent, initially empty file system created by Kubernetes. -For more information, see [**Persistent Volumes**](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) in the Kubernetes documentation. +For more information, see [Persistent Volumes](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) in the Kubernetes documentation. The directory is used to store the Domino server configuration, Notes databases, templates, and other details specific to the Domino server instance. During initial startup, Domino sees the empty directory and triggers the Domino One Touch setup process to populate the directory with databases, templates, and configuration files. Logs are in `/local/notesdata/IBM_TECHNICAL_SUPPORT/`. @@ -50,7 +50,7 @@ Kubernetes uses pods as its fundamental scheduling unit because they provide a w ## Pod names -Pods have names that usually consist of developer defined prefix and runtime defined unique suffix. Together, they make each pod name unique. Because of this, you often have to get a list of the running pods to determine the exact name before taking action on the pod. Use the kubectl command [**`get pods`**](https://kubernetes.io/docs/reference/generated/kubectl/kubectl-commands#get) as shown here: +Pods have names that usually consist of developer defined prefix and runtime defined unique suffix. Together, they make each pod name unique. Because of this, you often have to get a list of the running pods to determine the exact name before taking action on the pod. Use the kubectl command [`get pods`](https://kubernetes.io/docs/reference/generated/kubectl/kubectl-commands#get) as shown here: ```{ .yaml .no-copy } kubectl get pods -n mxgo @@ -75,7 +75,7 @@ Locate the entry that starts with "drapi" and you can see the full pod name is * ## Copy files into and out of Domino container -Using the [**kubectl cp**](https://kubernetes.io/docs/reference/generated/kubectl/kubectl-commands#cp) command, you can copy files into and out of the container. For example, if you want to copy the domino administrative ID out of the Domino data directory, you use a command like this: +Using the [kubectl cp](https://kubernetes.io/docs/reference/generated/kubectl/kubectl-commands#cp) command, you can copy files into and out of the container. For example, if you want to copy the domino administrative ID out of the Domino data directory, you use a command like this: ```{ .yaml .no-copy } kubectl cp domino-drapi-6fc766ccd4-55d9n:/local/notesdata/admin.id domino-id.id -n mxgo -c drapi @@ -89,7 +89,7 @@ Similarly, you could copy the local file `foo.bar` into the container's `/tmp` d kubectl cp foo.bar domino-drapi-6fc766ccd4-55d9n:/tmp/foo.bar -n mxgo -c drapi ``` -Refer to [**Kubernetes documentation**](https://kubernetes.io/docs/reference/generated/kubectl/kubectl-commands#cp) for more details on `cp`. +Refer to [Kubernetes documentation](https://kubernetes.io/docs/reference/generated/kubectl/kubectl-commands#cp) for more details on `cp`. ## Interactive command line access with Domino @@ -106,7 +106,7 @@ The response should look like the following, which indicates you are now in a ba [notes@domino-drapi-6fc766ccd4-55d9n /]$ ``` -You can use the nashcom [**Domino Start Script**](https://nashcom.github.io/domino-startscript/) to interact with the Domino server. This script is already installed and available for use. +You can use the nashcom [Domino Start Script](https://nashcom.github.io/domino-startscript/) to interact with the Domino server. This script is already installed and available for use. You can show the status of the Domino server by using this command: @@ -183,7 +183,7 @@ Load fixup You may disconnect from the console, and leave the Domino Server running, using the command `close`. -For the full set of server commands and syntax, see the [**HCL Domino Documentation**](https://help.hcltechsw.com/domino/14.0.0/admin/admn_servercommandsyntax_c.html). +For the full set of server commands and syntax, see the [HCL Domino Documentation](https://help.hcltechsw.com/domino/14.0.0/admin/admn_servercommandsyntax_c.html). ## Stop and start Domino server process diff --git a/docs/topicguides/extendrosettapi.md b/docs/topicguides/extendrosettapi.md index aff6af9c..c20d97b0 100644 --- a/docs/topicguides/extendrosettapi.md +++ b/docs/topicguides/extendrosettapi.md @@ -76,4 +76,4 @@ In addition to extending via **JavaScript implementations**, when the `code` pro ## Additional information -For more information, see [**Register and unregister custom Rosetta API**](../howto/regunregconfig.md). +For more information, see [Register and unregister custom Rosetta API](../howto/regunregconfig.md). diff --git a/docs/topicguides/introvoltmxgo.md b/docs/topicguides/introvoltmxgo.md index 06f1b361..369255ee 100644 --- a/docs/topicguides/introvoltmxgo.md +++ b/docs/topicguides/introvoltmxgo.md @@ -9,12 +9,12 @@ Volt MX Go modernizes and extends the value of your Domino applications with the Volt MX Go includes the following components: -- [**First Touch**](#first-touch) -- [**Design Import**](#design-import) -- [**VoltFormula**](#voltformula) -- [**Domino Adapter**](#domino-adapter) -- [**Domino REST API**](#domino-rest-api) -- [**VoltScript**](#voltscript) +- [First Touch](#first-touch) +- [Design Import](#design-import) +- [VoltFormula](#voltformula) +- [Domino Adapter](#domino-adapter) +- [Domino REST API](#domino-rest-api) +- [VoltScript](#voltscript) ![Volt MX Go](../assets/images/VoltMXGoDiagram.png) @@ -27,7 +27,7 @@ First Touch walks the administrator through establishing a connection to the Dom - preparing a zip file for import into Volt MX Go Foundry and importing the app - displaying a message informing the user that everything is ready -The [**sample recipe catalog app**](firsttouchapp.md) has features such as: +The [sample recipe catalog app](firsttouchapp.md) has features such as: - displaying recipe cards that are clickable to show list of ingredients and instructions - performing CRUD operations on Domino back end to create, edit, delete a recipe @@ -68,11 +68,11 @@ Domino Adapter makes Domino a core part of the Volt MX Go Foundry Object Service HCL Domino REST API provides secure REST API-based access to HCL Domino servers and databases. Designed to highlight Domino as a world class, modern, standards-compliant, cloud native and enterprise-level collaboration platform, it adds contemporary REST APIs to Notes and Domino, enabling a modern programming experience with the tools of your choice. -For more information, see [**HCL Domino REST API Documentation**](https://opensource.hcltechsw.com/Domino-rest-api/index.html). +For more information, see [HCL Domino REST API Documentation](https://opensource.hcltechsw.com/Domino-rest-api/index.html). ## VoltScript -VoltScript is a [**BASIC**](https://en.wikipedia.org/wiki/BASIC) scripting language evolved from LotusScript®, which was developed for the Lotus Software family of products. The language has been extended for use with HCL Volt MX Go as a server-side scripting language running within the Foundry middleware layer. VoltScript includes: +VoltScript is a [BASIC](https://en.wikipedia.org/wiki/BASIC) scripting language evolved from LotusScript®, which was developed for the Lotus Software family of products. The language has been extended for use with HCL Volt MX Go as a server-side scripting language running within the Foundry middleware layer. VoltScript includes: - Visual Studio Code extension for allowing developers to write code in VS Code - Linux Docker image for allowing Mac developers to use the VS Code extension @@ -81,5 +81,5 @@ VoltScript is a [**BASIC**](https://en.wikipedia.org/wiki/BASIC) scripting langu - A toolkit for scaffolding the various VoltScript extensions and script code and autogenerating starter code and related documentation - Various VoltScript Extensions for supporting various processes, such as data access over HTTP to specific or generic REST services, handling JSON data, interacting with the operating system and files, managing input parameters -To learn more about the **early access version** of VoltScript, see [**VoltScript Documentation**](https://help.hcltechsw.com/docs/voltscript/early-access/index.html). +To learn more about the **early access version** of VoltScript, see [VoltScript Documentation](https://help.hcltechsw.com/docs/voltscript/early-access/index.html). diff --git a/docs/topicguides/method.md b/docs/topicguides/method.md index 1477fd17..4df804bd 100644 --- a/docs/topicguides/method.md +++ b/docs/topicguides/method.md @@ -131,12 +131,12 @@ You may perform the following binary operations: - The field parameter is optional. If the attachment you wish to delete is associated with a field in the Domino database, include the field in the delete request to remove the attachment. !!!warning "Important" - - Large attachment files may cause some performance issues, so limit the attachment size to the minimum possible size. If you have large-sized attachments, increase your Volt MX Go Foundry configured memory resource by [**configuring heap size**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_manual_install_guide/Content/Configuring_Connectors_and_Batch_Files_-_Tomcat.html#configuring-heap-and-permgen-size-for-tomcat) or updating `integration.resourceMemoryLimit` in `values.yaml` for Volt MX Go Foundry on supported Kubernetes platform. - - By default, there is also a limit in the Domino Rest API on how big an attachment it can support. To learn how to change the size limit, see [**Change file size limit**](https://opensource.hcltechsw.com/Domino-rest-api/howto/production/changefilesize.html) in the Domino REST API documentation. + - Large attachment files may cause some performance issues, so limit the attachment size to the minimum possible size. If you have large-sized attachments, increase your Volt MX Go Foundry configured memory resource by [configuring heap size](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_manual_install_guide/Content/Configuring_Connectors_and_Batch_Files_-_Tomcat.html#configuring-heap-and-permgen-size-for-tomcat) or updating `integration.resourceMemoryLimit` in `values.yaml` for Volt MX Go Foundry on supported Kubernetes platform. + - By default, there is also a limit in the Domino Rest API on how big an attachment it can support. To learn how to change the size limit, see [Change file size limit](https://opensource.hcltechsw.com/Domino-rest-api/howto/production/changefilesize.html) in the Domino REST API documentation. ## Using PATCH verb from Volt MX SDK -The Volt MX SDK has CRUD functions allowing an end-user application to use the REST API to interact with the Domino data in the back end. If you want to use the PATCH verb, you need to use the `customVerb` function from the Volt MX SDK. For more information, see [**customVerb method**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_user_guide/Content/ObjectsAPIReference/OnlineObjectService_Class.html#customverb-method) in the HCL Volt MX Documentation. +The Volt MX SDK has CRUD functions allowing an end-user application to use the REST API to interact with the Domino data in the back end. If you want to use the PATCH verb, you need to use the `customVerb` function from the Volt MX SDK. For more information, see [customVerb method](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_user_guide/Content/ObjectsAPIReference/OnlineObjectService_Class.html#customverb-method) in the HCL Volt MX Documentation. ???example "Refer to the code example for using the SDK's `customVerb` function." @@ -166,7 +166,7 @@ The Volt MX SDK has CRUD functions allowing an end-user application to use the R Using the binary APIs with Domino Adapter requires more properties in the functional call. You need to add an object with a `queryParams` key to the options argument of the `createBinaryContent`. The object should contain query parameters required for using the binary APIs with Domino Adapter, including `unid` and `name` parameters. !!!note - - For more information, see the general use of the [**binary APIs from the Volt MX SDK**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_user_guide/Content/ObjectsAPIReference/OnlineObjectService_Class.html#getbinarycontent-method) in the HCL Volt MX documentation. + - For more information, see the general use of the [binary APIs from the Volt MX SDK](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_user_guide/Content/ObjectsAPIReference/OnlineObjectService_Class.html#getbinarycontent-method) in the HCL Volt MX documentation. - There is no function in the Volt MX SDK for calling `deleteBinary`. ???example "Refer to the code examples for using the SDK's binary functions." diff --git a/docs/topicguides/rosettaapi.md b/docs/topicguides/rosettaapi.md index b229eca0..86d272a6 100644 --- a/docs/topicguides/rosettaapi.md +++ b/docs/topicguides/rosettaapi.md @@ -23,7 +23,7 @@ ## Getters, setters, and checkers !!!tip - For more information about a specific API object, see the [**Rosetta API reference documentation**](../javadoc/index.html). + For more information about a specific API object, see the [Rosetta API reference documentation](../javadoc/index.html). ### Implementation @@ -52,4 +52,4 @@ ## Additional information -For more information, see [**Configure VoltFormula's Rosetta API Options**](../howto/configrosetta.md). +For more information, see [Configure VoltFormula's Rosetta API Options](../howto/configrosetta.md). diff --git a/docs/topicguides/rosettaconverterconfig.md b/docs/topicguides/rosettaconverterconfig.md index bc47776e..490bcebf 100644 --- a/docs/topicguides/rosettaconverterconfig.md +++ b/docs/topicguides/rosettaconverterconfig.md @@ -4,9 +4,9 @@ The Rosetta Converter converts formula code (Notes or Excel[^1]/OpenFormula) into a JavaScript equivalent. It takes advantage of the available Rosetta API library implementations as needed. It creates a JavaScript code snippet comprised of the native JavaScript elements as well as calls to the corresponding APIs.  -The Rosetta Converter is an integral part of the VoltFormula process. It allows the developer to write code using formula languages and takes care of providing the JavaScript equivalents. It is written in JavaScript using regex rules and [**ANTLR (ANother Tool for Language Recognition)(antlr4)**](https://www.antlr.org/) rules. +The Rosetta Converter is an integral part of the VoltFormula process. It allows the developer to write code using formula languages and takes care of providing the JavaScript equivalents. It is written in JavaScript using regex rules and [ANTLR (ANother Tool for Language Recognition)(antlr4)](https://www.antlr.org/) rules. -[^1]: **Excel is a registered trademark or trademark of Microsoft Corporation in the United States and/or other countries.** +[^1]: Excel is a registered trademark or trademark of Microsoft Corporation in the United States and/or other countries. ## Configuration options @@ -125,5 +125,5 @@ var yes = rosettajs.Logical.true(); ## Additional information -For more information, see [**Configure VoltFormula's Rosetta API Options**](../howto/configrosetta.md). +For more information, see [Configure VoltFormula's Rosetta API Options](../howto/configrosetta.md). diff --git a/docs/topicguides/vfcodingpractices.md b/docs/topicguides/vfcodingpractices.md index 4e0f4e31..ce23da87 100644 --- a/docs/topicguides/vfcodingpractices.md +++ b/docs/topicguides/vfcodingpractices.md @@ -61,7 +61,7 @@ For VoltFormula, the API implementations of `@GetField` and `@SetField` Notes Fo ### Mixing formula languages with other languages -The Rosetta Converter can process formula language mixed with other language artifacts by making use of the **allowPassthrough** option. This way, a formula snippet of code can be augmented with other code, such as JavaScript, to have the resulting converted code combine the different languages for a desired result. For more information, see [**Using JSP style syntax**](declvariables.md#using-jsp-style-syntax) and **allowPassthrough** option in [**Rosetta Converter configuration options**](rosettaconverterconfig.md#configuration-options). +The Rosetta Converter can process formula language mixed with other language artifacts by making use of the **allowPassthrough** option. This way, a formula snippet of code can be augmented with other code, such as JavaScript, to have the resulting converted code combine the different languages for a desired result. For more information, see [Using JSP style syntax](declvariables.md#using-jsp-style-syntax) and **allowPassthrough** option in [Rosetta Converter configuration options](rosettaconverterconfig.md#configuration-options). ### How does VoltFormula maintain project formulas? diff --git a/docs/topicguides/voltformulaintro.md b/docs/topicguides/voltformulaintro.md index cb7ba174..40fbb3c2 100644 --- a/docs/topicguides/voltformulaintro.md +++ b/docs/topicguides/voltformulaintro.md @@ -2,12 +2,12 @@ What ideas do you think of whenever you hear the word *formula*? It refers to a string of words, a collection of mathematical processes, or an expression with the purpose of producing results as an output. The description of this "formula" and our VoltFormula are the same. VoltFormula is responsible for converting the formula used on other Formula Language platforms into the JavaScript programming language. This is essential for existing users of Notes and Excel[^1] who want to convert their existing formulas into the JavaScript language. -[^1]: **Excel is a registered trademark or trademark of Microsoft Corporation in the United States and/or other countries.** +[^1]: Excel is a registered trademark or trademark of Microsoft Corporation in the United States and/or other countries. ## Two formula languages exposed as one implementation by VoltFormula - - [**OpenFormula**](https://docs.oasis-open.org/office/OpenDocument/v1.3/OpenDocument-v1.3-part4-formula.html) - - [**Notes Formula Language**](https://help.hcltechsw.com/dom_designer/14.0.0/basic/H_NOTES_FORMULA_LANGUAGE.html) + - [OpenFormula](https://docs.oasis-open.org/office/OpenDocument/v1.3/OpenDocument-v1.3-part4-formula.html) + - [Notes Formula Language](https://help.hcltechsw.com/dom_designer/14.0.0/basic/H_NOTES_FORMULA_LANGUAGE.html) These two are wrapped into one parent formula language that encapsulates both implementations. We call this **VoltFormula**, aka RosettaJS. By nature of being a JavaScript exposed API library, the formula language can be extended via helper registration methods. diff --git a/docs/tutorials/adaptertutorial.md b/docs/tutorials/adaptertutorial.md index c3d6d3ce..36e20af9 100644 --- a/docs/tutorials/adaptertutorial.md +++ b/docs/tutorials/adaptertutorial.md @@ -2,14 +2,14 @@ The tutorial guides you through the Domino Adapter process in Volt MX Go. You will create an app in Volt MX Go Foundry and connect the app to your Domino database as an endpoint via the Domino REST API. You will then configure a data model and test the methods, including standard CRUD operations, for interacting with the data model. -For more information, see [**Data models**](../topicguides/datamodel.md) and **[Methods**](../topicguides/method.md). +For more information, see [Data models](../topicguides/datamodel.md) and **[Methods](../topicguides/method.md). At the end of this tutorial, you can manually create an app in Volt MX Go Foundry and create an Identity Service and Object Service to connect your app to your Domino database via Domino REST API. ## Before you begin -- You have completed the [**Volt MX Go installation**](installation.md). -- You have a [**Volt MX Go Foundry admin account**](../howto/foundryadminaccount.md). +- You have completed the [Volt MX Go installation](installation.md). +- You have a [Volt MX Go Foundry admin account](../howto/foundryadminaccount.md). !!!tip The following actions might require certain Domino access rights. Contact your Domino Administrator/Domino REST API Administrator for assistance. @@ -18,10 +18,10 @@ At the end of this tutorial, you can manually create an app in Volt MX Go Foundr - You have at least an *Editor* access to the Domino Keep Configuration database `keepconfig.nsf` to create a scope and OAuth application for the Domino application. - You have the correct access level to the Domino database to test the CRUD operations. - For more information, see [**Access Levels in the ACL**](https://help.hcltechsw.com/domino/14.0.0/admin/conf_accesslevelsintheacl_c.html) in the HCL Domino documentation or contact your Domino/Domino REST API administrator. + For more information, see [Access Levels in the ACL](https://help.hcltechsw.com/domino/14.0.0/admin/conf_accesslevelsintheacl_c.html) in the HCL Domino documentation or contact your Domino/Domino REST API administrator. -- You have added a schema, activated the forms of the schema, and added a `dql` mode similar to the `default` mode to each activated form in Domino REST API. For more information, see [**Schema Management**](https://opensource.hcltechsw.com/Domino-rest-api/references/usingwebui/schemaui.html). -- You have added a scope for your schema in Domino REST API. For more information, see [**Scope Management**](https://opensource.hcltechsw.com/Domino-rest-api/references/usingwebui/scopeui.html). +- You have added a schema, activated the forms of the schema, and added a `dql` mode similar to the `default` mode to each activated form in Domino REST API. For more information, see [Schema Management](https://opensource.hcltechsw.com/Domino-rest-api/references/usingwebui/schemaui.html). +- You have added a scope for your schema in Domino REST API. For more information, see [Scope Management](https://opensource.hcltechsw.com/Domino-rest-api/references/usingwebui/scopeui.html). ## Log in to Volt MX Go Foundry @@ -43,7 +43,7 @@ At the end of this tutorial, you can manually create an app in Volt MX Go Foundr 3. Click the **Edit App Name** icon to give a unique name to your app. !!!tip - For more information, see [**How to Add Applications**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_user_guide/Content/Adding_Applications.html) in the HCL Volt MX documentation. + For more information, see [How to Add Applications](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_user_guide/Content/Adding_Applications.html) in the HCL Volt MX documentation. ## Configure an Identity service @@ -95,7 +95,7 @@ At the end of this tutorial, you can manually create an app in Volt MX Go Foundr 3. Enter the App Secret of your app in Domino REST API in the **Client Secret** text box. !!!tip - The App ID and App Secret are generated when you add an app in Domino REST API. For more information, see [**Application Management**](https://opensource.hcltechsw.com/Domino-rest-api/references/usingwebui/appui.html) in the Domino REST API documentation. + The App ID and App Secret are generated when you add an app in Domino REST API. For more information, see [Application Management](https://opensource.hcltechsw.com/Domino-rest-api/references/usingwebui/appui.html) in the Domino REST API documentation. 6. Under **Advanced**: @@ -150,7 +150,7 @@ At the end of this tutorial, you can manually create an app in Volt MX Go Foundr 3. Enter *true* or *false* in the **Return documents from Bulk Update** text field. By default, the value is set to *true*. !!!note - Entering true in the **Return documents from Bulk Update** text field ensures the return of documents updated using the BULK UPDATE method. For more information, see [**Methods**](../topicguides/method.md). + Entering true in the **Return documents from Bulk Update** text field ensures the return of documents updated using the BULK UPDATE method. For more information, see [Methods](../topicguides/method.md). !!!tip To test the connection parameters, select the environment you added from the **Select an Environment** drop-down list and then click **Test Connection**. You will see a *Connection Successful* message if the configured connection parameters are correct. @@ -182,7 +182,7 @@ At the end of this tutorial, you can manually create an app in Volt MX Go Foundr !!!tip - You can change the data model object names of the selected forms and view entities. - - For more information on naming limitations, see [**Known limitations**](../references/knownlimitation.md#naming). + - For more information on naming limitations, see [Known limitations](../references/knownlimitation.md#naming). 5. Click **Generate**. The forms and view entities are now added to the **Data Model**. @@ -210,7 +210,7 @@ At the end of this tutorial, you can manually create an app in Volt MX Go Foundr 4. Click **Save** after viewing. -For more information on supported parameters, see [**Supported OData query parameters for form-based GET method**](../topicguides/method.md#supported-odata-query-parameters-for-form-based-get-method) and [**Supported OData query parameters for view-based GET method**](../topicguides/method.md#supported-odata-query-parameters-for-view-based-get-method). +For more information on supported parameters, see [Supported OData query parameters for form-based GET method](../topicguides/method.md#supported-odata-query-parameters-for-form-based-get-method) and [Supported OData query parameters for view-based GET method](../topicguides/method.md#supported-odata-query-parameters-for-view-based-get-method). ## Test the POST method by creating a record diff --git a/docs/tutorials/designimport.md b/docs/tutorials/designimport.md index 7a9d6cc5..ad350486 100644 --- a/docs/tutorials/designimport.md +++ b/docs/tutorials/designimport.md @@ -16,36 +16,36 @@ The tutorial implements two user experiences: ### For Volt MX Go Foundry admin -- You must complete the [**Volt MX Go installation**](installfoundry.md). +- You must complete the [Volt MX Go installation](installfoundry.md). - You must create a Volt MX Go Foundry admin account to the Volt MX Go Iris developer. ### For Domino REST API admin -- You have completed the [**Domino REST API installation**](https://opensource.hcltechsw.com/Domino-rest-api/tutorial/installconfig/index.html). +- You have completed the [Domino REST API installation](https://opensource.hcltechsw.com/Domino-rest-api/tutorial/installconfig/index.html). - You have at least an *Editor* access to the *Domino Keep Configuration database* `keepconfig.nsf` to create a scope and Domino REST API application. - You have set up Domino REST API with a specified Domino database `.nsf`, schema, scopes, and application. -- When you configure the `schema`, [**set the views to Active status**](https://opensource.hcltechsw.com/Domino-rest-api/references/usingwebui/schemaui.html#activate-a-view). +- When you configure the `schema`, [set the views to Active status](https://opensource.hcltechsw.com/Domino-rest-api/references/usingwebui/schemaui.html#activate-a-view). -- When you configure the `schema`, include the `$Files` field in the configured form. This is to capture the uploading and downloading of files in the Design Import. For more information, see [**step numer 3 in Change form configuration**](https://opensource.hcltechsw.com/Domino-rest-api/references/usingwebui/schemaui.html#change-form-configuration). +- When you configure the `schema`, include the `$Files` field in the configured form. This is to capture the uploading and downloading of files in the Design Import. For more information, see [step numer 3 in Change form configuration](https://opensource.hcltechsw.com/Domino-rest-api/references/usingwebui/schemaui.html#change-form-configuration). -- When you configure the `schema`, set the **Mode Formula Settings → Formula for Delete Access** to `@True` in `default` and `dql` mode in all the schema forms. For more information, see [**step number 5 in Change form configuration**](https://opensource.hcltechsw.com/Domino-rest-api/references/usingwebui/schemaui.html#change-form-configuration). +- When you configure the `schema`, set the **Mode Formula Settings → Formula for Delete Access** to `@True` in `default` and `dql` mode in all the schema forms. For more information, see [step number 5 in Change form configuration](https://opensource.hcltechsw.com/Domino-rest-api/references/usingwebui/schemaui.html#change-form-configuration). -- When you configure the `schema`, add the `default` and `dql` modes and must have a matching fields. For more information, see [**Cloning modes**](https://opensource.hcltechsw.com/Domino-rest-api/references/usingwebui/schemaui.html#clone-a-mode). +- When you configure the `schema`, add the `default` and `dql` modes and must have a matching fields. For more information, see [Cloning modes](https://opensource.hcltechsw.com/Domino-rest-api/references/usingwebui/schemaui.html#clone-a-mode). - When you configure `scope`, the scope name must be limited to 30 characters. -- When you configure the `scopes`, set the *Maximum Access Level* to **Designer** or **Manager** ACL role. For more information, see [**Add a scope in Domino REST API**](https://opensource.hcltechsw.com/Domino-rest-api/references/usingwebui/scopeui.html#add-a-scope). +- When you configure the `scopes`, set the *Maximum Access Level* to **Designer** or **Manager** ACL role. For more information, see [Add a scope in Domino REST API](https://opensource.hcltechsw.com/Domino-rest-api/references/usingwebui/scopeui.html#add-a-scope). -- When you configure your Domino REST API app, it's mandatory to add `$SETUP` to Scope field. For more information, see [**Application Management**](https://opensource.hcltechsw.com/Domino-rest-api/references/usingwebui/appui.html#add-an-application). +- When you configure your Domino REST API app, it's mandatory to add `$SETUP` to Scope field. For more information, see [Application Management](https://opensource.hcltechsw.com/Domino-rest-api/references/usingwebui/appui.html#add-an-application). - Provide the Domino REST API URL, Client ID, Client Secret and scope to the Volt MX Go Iris developer from your Domino REST API app. ### For Volt MX Go Iris Developer -- You must install [**Volt MX Go Iris**](installiris.md) +- You must install [Volt MX Go Iris](installiris.md) - You must have a Volt MX Go Foundry admin account. - You must have at least a **Designer role** to the Domino database `.nsf` that you are importing and to the **Domino Keep Configuration Database (`keepconfig.nsf`)**. - You must have your Domino REST API URL, Client ID, Client Secret and scope which comes from the Domino REST API admin. @@ -88,7 +88,7 @@ The tutorial implements two user experiences: 1. On the top menu, select **Project** → **New Project**. 2. On the **What do you want to start with now?** dialog, select **Web App** and click **Next**. - For other platforms, please see [**Native App**]( ../howto/dicreatenativeapp.md). + For other platforms, please see [Native App]( ../howto/dicreatenativeapp.md). ![Design Import Wizard dialog](../assets/images/didevice.png){: style="height:80%;width:80%"} @@ -147,7 +147,7 @@ You can now see your project name in the upper-left corner of the **Volt MX Go I 3. Click **Next**. !!!warning "Important" - If the wizard is terminated, you may proceed with [**Import a Domino Application using existing identity service from existing Volt MX Go Foundry app**](#import-a-domino-application-using-existing-identity-service-from-existing-volt-mx-go-foundry-app). + If the wizard is terminated, you may proceed with [Import a Domino Application using existing identity service from existing Volt MX Go Foundry app](#import-a-domino-application-using-existing-identity-service-from-existing-volt-mx-go-foundry-app). 4. Login with your **Domino credentials** within this wizard dialog and click **Allow**. @@ -159,7 +159,7 @@ You can now see your project name in the upper-left corner of the **Volt MX Go I ![Design Import Wizard dialog](../assets/images/difoundry.png) !!!warning "Important" - The wizard expects to stop if your login credentials don't have *Designer* access in Domino REST API on your scope, or if your Domino database ACL doesn't give you a *Designer* role. For more information, see [**Troubleshooting**](../references/troubleshoot.md#design-import). + The wizard expects to stop if your login credentials don't have *Designer* access in Domino REST API on your scope, or if your Domino database ACL doesn't give you a *Designer* role. For more information, see [Troubleshooting](../references/troubleshoot.md#design-import). 5. On **Scope and Forms** @@ -169,11 +169,11 @@ You can now see your project name in the upper-left corner of the **Volt MX Go I 1. Select the **scope** that you’ve configured in Domino REST API. !!!warning "Important" - The scope name should be no more than 30 characters. If it exceeds this limit, a prompt will appear. In this case, contact your Domino REST API admin to configure your scope. Please take note of the prerequisites required for [**importing Domino Application**](../tutorials/designimport.md#before-you-begin). + The scope name should be no more than 30 characters. If it exceeds this limit, a prompt will appear. In this case, contact your Domino REST API admin to configure your scope. Please take note of the prerequisites required for [importing Domino Application](../tutorials/designimport.md#before-you-begin). ![Design Import Wizard dialog](../assets/images/discope.png) - When a **Domino REST API Issues Report** prompt appears, check [**Domino REST API schema issues**](../references/troubleshoot.md#design-import). + When a **Domino REST API Issues Report** prompt appears, check [Domino REST API schema issues](../references/troubleshoot.md#design-import). 2. **Select** or **deselect** the active `forms`, `fields` in each form, `views`, `agents`, `actions` and click **Next**. @@ -193,7 +193,7 @@ You can now see your project name in the upper-left corner of the **Volt MX Go I ![Design Import Wizard dialog](../assets/images/diagents.png) - Follow this link to learn more on [**showing Domino Agents as part of the Design Import app**](../howto/diagents.md) + Follow this link to learn more on [showing Domino Agents as part of the Design Import app](../howto/diagents.md) 6. On **Summary**, review the final `forms`, `fields` in each form, `views` and `agent`, and then click **Build Iris Application**. @@ -255,7 +255,7 @@ Once you click **Done**, each of the selected forms, views, and agents are impor ![Design Import Wizard dialog](../assets/images/didrapi.png) !!!warning "Important" - - It's important to get your **callback URL** in Volt MX Go Foundry and send it to Domino REST API admin. Form more information. see [**copy callback URL in Volt MX Go Foundry**](#copy-callback-url-in-volt-mx-go-foundry). Be sure that your Domino REST API admin updated the callback URL in your Domino REST API application immediately without closing the wizard. Otherwise, the wizard will close. + - It's important to get your **callback URL** in Volt MX Go Foundry and send it to Domino REST API admin. Form more information. see [copy callback URL in Volt MX Go Foundry](#copy-callback-url-in-volt-mx-go-foundry). Be sure that your Domino REST API admin updated the callback URL in your Domino REST API application immediately without closing the wizard. Otherwise, the wizard will close. 2. Click **Next**. @@ -268,7 +268,7 @@ Once you click **Done**, each of the selected forms, views, and agents are impor ![Design Import Wizard dialog](../assets/images/difoundry.png) !!!warning "Important" - The wizard expects to stop if your login credentials don't have *Designer* access in Domino REST API on your scope, or if your Domino database ACL doesn't give you a *Designer* role. For more information, see [**Troubleshooting**](../references/troubleshoot.md#design-import) + The wizard expects to stop if your login credentials don't have *Designer* access in Domino REST API on your scope, or if your Domino database ACL doesn't give you a *Designer* role. For more information, see [Troubleshooting](../references/troubleshoot.md#design-import) 5. On **Scope and Forms** @@ -278,11 +278,11 @@ Once you click **Done**, each of the selected forms, views, and agents are impor 1. Select the **scope** that you’ve configured in Domino REST API. !!!warning "Important" - The scope name should be no more than 30 characters. If it exceeds this limit, a prompt will appear. In this case, contact your Domino REST API admin to configure your scope. Please take note of the prerequisites required for [**importing Domino Application**](../tutorials/designimport.md#before-you-begin). + The scope name should be no more than 30 characters. If it exceeds this limit, a prompt will appear. In this case, contact your Domino REST API admin to configure your scope. Please take note of the prerequisites required for [importing Domino Application](../tutorials/designimport.md#before-you-begin). ![Design Import Wizard dialog](../assets/images/discope.png) - When a **Domino REST API Issues Report** prompt appears, check [**Domino REST API schema issues**](../references/troubleshoot.md#design-import). + When a **Domino REST API Issues Report** prompt appears, check [Domino REST API schema issues](../references/troubleshoot.md#design-import). 2. **Select** or **deselect** the active `forms`, `views`, `agents` and `actions` and click **Next**. @@ -302,7 +302,7 @@ Once you click **Done**, each of the selected forms, views, and agents are impor ![Agents tab](../assets/images/diagents.png) - Follow this link to learn more on [**showing Domino Agents as part of the Design Import app**](../howto/diagents.md). + Follow this link to learn more on [showing Domino Agents as part of the Design Import app](../howto/diagents.md). 6. On **Summary**, review the final `forms`, `views` and `agents` you want to import, and then click **Build Iris Application**. @@ -336,18 +336,18 @@ Once you click **Done**, each of the selected forms, views, and agents have impo The Domino REST API admin updates the **Domino Application callback URL** in Domino Application. !!!warning "Important" - You may continue the procedure in **step 4.b** in the [**Import a Domino Application using the new Volt MX Go Foundry app**](#import-a-domino-application-using-a-new-volt-mx-go-foundry-app). If the wizard was terminated, you may proceed with [**Import a Domino Application using existing identity service from existing Volt MX Go Foundry app**](#import-a-domino-application-using-existing-identity-service-from-existing-volt-mx-go-foundry-app). + You may continue the procedure in **step 4.b** in the [Import a Domino Application using the new Volt MX Go Foundry app](#import-a-domino-application-using-a-new-volt-mx-go-foundry-app). If the wizard was terminated, you may proceed with [Import a Domino Application using existing identity service from existing Volt MX Go Foundry app](#import-a-domino-application-using-existing-identity-service-from-existing-volt-mx-go-foundry-app). ## CRUD operation upon importing the Domino database `.nsf` !!!note "Published the web app and native app in Volt MX Go Iris" - Before you can do the CRUD operation in your imported Domino app, you must first build and publish the web and native app in Volt MX Go Iris. - - If your app is a **Web App**, see [**Building a Web App**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_microapps/Content/WebPublish.html#publish-a-web-app) in the HCL Volt MX documentation. + - If your app is a **Web App**, see [Building a Web App](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_microapps/Content/WebPublish.html#publish-a-web-app) in the HCL Volt MX documentation. - If your app is a **Native App:** - 1. [**Configure your mobile app browser**](../howto/configmobile.md). - 2. After configuring your mobile app browser, see [**Building a Native App**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_user_guide/Content/LocalBuildStarter.html) in the HCL Volt MX documentation to view the mobile app. + 1. [Configure your mobile app browser](../howto/configmobile.md). + 2. After configuring your mobile app browser, see [Building a Native App](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_user_guide/Content/LocalBuildStarter.html) in the HCL Volt MX documentation to view the mobile app. - Log in to your account in Domino REST API using the newly published imported Domino application. Your configuration in Domino REST API decides what operations you can include in the **design import** form. @@ -368,7 +368,7 @@ Once you click **Done**, each of the selected forms, views, and agents have impo 1. Select the file you want to upload. You can select more than one file to upload. !!!notes - To see the details of uploading size limit, see [**HCL Notes and DOMINO file limits**](https://help.hcltechsw.com/dom_designer/14.0.0/basic/H_NOTES_AND_DOMINO_KNOWN_LIMITS.html) in the HCL Domino documentation. + To see the details of uploading size limit, see [HCL Notes and DOMINO file limits](https://help.hcltechsw.com/dom_designer/14.0.0/basic/H_NOTES_AND_DOMINO_KNOWN_LIMITS.html) in the HCL Domino documentation. 2. Click **Open**. If the file is pre-existing, a dialog prompt appears with the option to overwrite it. @@ -403,7 +403,7 @@ Once you click **Done**, each of the selected forms, views, and agents have impo 2. In the **Dashboard/AllCustomers_Leads** page, search the customer, click the name and select **Edit**. !!!note - If the detail view **DOESN'T show**, check the [**Database Views in Domino Rest API**](https://opensource.hcltechsw.com/Domino-rest-api/references/usingwebui/schemaui.html#list-available-database-views) under schema, to confirm that the **Database View** is **active** and the columns in the view are added during the import. + If the detail view **DOESN'T show**, check the [Database Views in Domino Rest API](https://opensource.hcltechsw.com/Domino-rest-api/references/usingwebui/schemaui.html#list-available-database-views) under schema, to confirm that the **Database View** is **active** and the columns in the view are added during the import. ![Screenshot](../assets/images/dieditdata.png) @@ -417,7 +417,7 @@ Once you click **Done**, each of the selected forms, views, and agents have impo 1. Select the file you want to upload. You can select more than one file to upload. !!!notes - To see the details of uploading size limit, see [**HCL Notes and DOMINO file limits**](https://help.hcltechsw.com/dom_designer/14.0.0/basic/H_NOTES_AND_DOMINO_KNOWN_LIMITS.html) + To see the details of uploading size limit, see [HCL Notes and DOMINO file limits](https://help.hcltechsw.com/dom_designer/14.0.0/basic/H_NOTES_AND_DOMINO_KNOWN_LIMITS.html) 2. Click **Open**. If the file is pre-existing, a dialog prompt will appear with the option to overwrite it. diff --git a/docs/tutorials/downloadhelmchart.md b/docs/tutorials/downloadhelmchart.md index 0d1ffde9..d749e1a1 100644 --- a/docs/tutorials/downloadhelmchart.md +++ b/docs/tutorials/downloadhelmchart.md @@ -33,7 +33,7 @@ The procedure guides you in downloading the Domino REST API Helm chart and deplo 4. Edit the `values.yaml` file using your preferred editor to update the file with your HCL Container Repository credentials, and the DNS name settings. - 1. Locate the following lines in the file and replace `your-email` and `your-authentication-token` with your [**email and authentication token**](obtainauthenticationtoken.md) used with the HCL Container Repository: + 1. Locate the following lines in the file and replace `your-email` and `your-authentication-token` with your [email and authentication token](obtainauthenticationtoken.md) used with the HCL Container Repository: ```{ .yaml .no-copy } imageCredentials: @@ -42,7 +42,7 @@ The procedure guides you in downloading the Domino REST API Helm chart and deplo ``` !!!note - Use the **CLI secret** value you saved from [**obtaining authentication token from HCL Container Repository**](obtainauthenticationtoken.md) as your authentication token or password. + Use the **CLI secret** value you saved from [obtaining authentication token from HCL Container Repository](obtainauthenticationtoken.md) as your authentication token or password. 2. Locate the following lines in the file and add your DNS hostname settings: @@ -51,12 +51,12 @@ The procedure guides you in downloading the Domino REST API Helm chart and deplo drapiDnsName: drapiManagementDnsName: ``` - Whatever hostnames you specify here and later in the Volt MX Go Foundry install, you need to ensure that the hostnames are resolvable. There is no additional work if you have already registered the hostnames in DNS. However, if you haven't registered them, you must add the hostnames to the server's /etc/hosts file as described in [**Ensure Foundry Hostnames are resolvable**](prereq.md#3-ensure-foundry-hostnames-are-resolvable), substituting your hostnames. Additionally, you must make the same updates in k3s's coredns config map as described in [**For K3s only**](prereq.md#for-k3s-only) again substituting your hostnames. + Whatever hostnames you specify here and later in the Volt MX Go Foundry install, you need to ensure that the hostnames are resolvable. There is no additional work if you have already registered the hostnames in DNS. However, if you haven't registered them, you must add the hostnames to the server's /etc/hosts file as described in [Ensure Foundry Hostnames are resolvable](prereq.md#3-ensure-foundry-hostnames-are-resolvable), substituting your hostnames. Additionally, you must make the same updates in k3s's coredns config map as described in [For K3s only](prereq.md#for-k3s-only) again substituting your hostnames. !!!note The example names used are `drapi.mymxgo.com` and `drapi-management.mymxgo.com` respectively. - 3. Locate the following lines in the file for the Administrator's first name, last name, and password. Set values for each of these settings. In our example we're using "mxgo", "admin" and "password". However, if you use your own values, remember the values and use them when required such as when you [**Run First Touch**](firsttouch.md#run-first-touch), and [**Access Domino REST API**](../howto/accessdrapi.md#access-domino-rest-api). Remember that the values of `dominoAdminFirstName` and `dominoAdminLastName` are combined, but separated by a space, to form the **username**. + 3. Locate the following lines in the file for the Administrator's first name, last name, and password. Set values for each of these settings. In our example we're using "mxgo", "admin" and "password". However, if you use your own values, remember the values and use them when required such as when you [Run First Touch](firsttouch.md#run-first-touch), and [Access Domino REST API](../howto/accessdrapi.md#access-domino-rest-api). Remember that the values of `dominoAdminFirstName` and `dominoAdminLastName` are combined, but separated by a space, to form the **username**. ```{ .yaml .no-copy } dominoAdminFirstName: "mxgo" @@ -73,7 +73,7 @@ The procedure guides you in downloading the Domino REST API Helm chart and deplo dominoNetworkHostname: "" ``` - Consult the [**Table of variables**](https://opensource.hcltechsw.com/Domino-rest-api/tutorial/installconfig/docker.html#table-of-variables) in *Run Domino REST API with a Docker image* in the [**Domino REST API documentation**](https://opensource.hcltechsw.com/Domino-rest-api/index.html) to determine if you need to update these fields as well. The mapping of `values.yaml` settings to variables is as follows: + Consult the [Table of variables](https://opensource.hcltechsw.com/Domino-rest-api/tutorial/installconfig/docker.html#table-of-variables) in *Run Domino REST API with a Docker image* in the [Domino REST API documentation](https://opensource.hcltechsw.com/Domino-rest-api/index.html) to determine if you need to update these fields as well. The mapping of `values.yaml` settings to variables is as follows: - `dominoServerDomainName = SERVERSETUP_SERVER_DOMAINNAME` - `dominoOrgName = SERVERSETUP_ORG_ORGNAME` @@ -84,13 +84,13 @@ The procedure guides you in downloading the Domino REST API Helm chart and deplo - `do-not-expose`: Set this value to prevent exposure of TCP port 1352 to the network. - `HostPort`: Set this value to use TCP port 1352 on your machine for the Notes client to communicate with Domino using the Notes Remote Procedure Call (NRPC) protocol. **This is only recommended when using Rancher Desktop for Kubernetes**. - - `NodePort`: Set this value if you want Kubernetes to allocate a random port in a specified range, by default 30000 to 32767, that's available on every worker node in the cluster. Kubernetes automatically routes traffic on this port from the Kubernetes node to the back-end Domino pod. **This is the recommended option if you want to expose NRPC to your Notes Clients when deploying into a non Rancher Desktop cluster**. See [**Create a new server connection under Procedure**](../howto/connectdominofromnotes.md#procedure) for instructions on how to obtain the random port number. + - `NodePort`: Set this value if you want Kubernetes to allocate a random port in a specified range, by default 30000 to 32767, that's available on every worker node in the cluster. Kubernetes automatically routes traffic on this port from the Kubernetes node to the back-end Domino pod. **This is the recommended option if you want to expose NRPC to your Notes Clients when deploying into a non Rancher Desktop cluster**. See [Create a new server connection under Procedure](../howto/connectdominofromnotes.md#procedure) for instructions on how to obtain the random port number. - `LoadBalancer`: Set this value if you want an external load balancer to be provisioned by a cloud provider which supports external load balancers. Traffic from the external load balancer is directed at the Domino pod, and the cloud provider decides how it is load balanced. Kubernetes typically starts off by making the changes that are equivalent to you requesting NodePort. The cloud-controller-manager component then configures the external load balancer to forward traffic to that assigned node port. - You can read more about these options in the [**Service**](https://kubernetes.io/docs/concepts/services-networking/service/) topic in the Kubernetes documentation. + You can read more about these options in the [Service](https://kubernetes.io/docs/concepts/services-networking/service/) topic in the Kubernetes documentation. -5. **(Optional)** If you would like to configure Ingress for Domino REST API, proceed to [**Configure Kubernetes Ingress for Domino REST API**](../howto/drapiingress.md). +5. **(Optional)** If you would like to configure Ingress for Domino REST API, proceed to [Configure Kubernetes Ingress for Domino REST API](../howto/drapiingress.md). 6. Save the file and exit. @@ -126,9 +126,9 @@ The procedure guides you in downloading the Domino REST API Helm chart and deplo ## Additional information -- To know how to manually update your Domino container if you obtain a new version of *FirstTouchRecipes.nsf*, see [**Update FirstTouchRecipes.nsf**](../howto/FTnsfupdate.md). -- To know more about Domino server processes within a Domino container, see [**Interacting with Domino server process within Domino container**](../topicguides/dominoserver.md). +- To know how to manually update your Domino container if you obtain a new version of *FirstTouchRecipes.nsf*, see [Update FirstTouchRecipes.nsf](../howto/FTnsfupdate.md). +- To know more about Domino server processes within a Domino container, see [Interacting with Domino server process within Domino container](../topicguides/dominoserver.md). ## Next step -Proceed to [**Install MySql for Volt MX Go Foundry**](installmysqlfoundry.md). +Proceed to [Install MySql for Volt MX Go Foundry](installmysqlfoundry.md). diff --git a/docs/tutorials/firsttouch.md b/docs/tutorials/firsttouch.md index 78fb607e..aece3df1 100644 --- a/docs/tutorials/firsttouch.md +++ b/docs/tutorials/firsttouch.md @@ -8,9 +8,9 @@ This tutorial guides you in accessing and running the First Touch Recipe Catalog **For Volt MX Go install to a production environment** - - You have completed the [**Volt MX Go installation in a production environment**](prerequisite.md). - - You have created your [**Volt MX Go Foundry admin account**](../howto/foundryadminaccount.md). - - If using MySQL, make sure that the maximum allowed packet size is at least 16 MB. For more information, see **First Touch or Custom Application Fails to Install on Volt MX Go Foundry** issue in [**Troubleshooting**](../references/troubleshoot.md). + - You have completed the [Volt MX Go installation in a production environment](prerequisite.md). + - You have created your [Volt MX Go Foundry admin account](../howto/foundryadminaccount.md). + - If using MySQL, make sure that the maximum allowed packet size is at least 16 MB. For more information, see **First Touch or Custom Application Fails to Install on Volt MX Go Foundry** issue in [Troubleshooting](../references/troubleshoot.md). @@ -18,16 +18,16 @@ This tutorial guides you in accessing and running the First Touch Recipe Catalog !!!tip The following actions might require certain Domino access rights. Contact your Domino Administrator/Domino REST API Administrator for assistance. - - You have [**set up an oauth.nsf**](https://opensource.hcltechsw.com/Domino-rest-api/howto/VoltMX/setupoauthnsf.html). - - You have [**set up Domino REST API**](https://opensource.hcltechsw.com/Domino-rest-api/howto/IdP/configuredrapiIdP.html). - - You have [**downloaded the FirstTouchRecipes.nsf.zip**](portaldownload.md) file, extracted the NSF file from the zip file, and copied the NSF file to the root of the data directory of your Domino server. + - You have [set up an oauth.nsf](https://opensource.hcltechsw.com/Domino-rest-api/howto/VoltMX/setupoauthnsf.html). + - You have [set up Domino REST API](https://opensource.hcltechsw.com/Domino-rest-api/howto/IdP/configuredrapiIdP.html). + - You have [downloaded the FirstTouchRecipes.nsf.zip](portaldownload.md) file, extracted the NSF file from the zip file, and copied the NSF file to the root of the data directory of your Domino server. === "For development or test-only environment" **For Volt MX Go install to a development or test-only environment** - - You have completed the [**Volt MX Go installation in a development or test-only environment**](containerdeployment.md). - - You have created your [**Volt MX Go Foundry admin account**](../howto/foundryadminaccount.md). + - You have completed the [Volt MX Go installation in a development or test-only environment](containerdeployment.md). + - You have created your [Volt MX Go Foundry admin account](../howto/foundryadminaccount.md). ## Log in to Volt MX Go Foundry @@ -98,6 +98,6 @@ You can now view and explore the First Touch Recipe Catalog app. ## Additional information -- To learn more about the app, see [**First Touch Recipe Catalog app**](../topicguides/firsttouchapp.md). -- To know how to import the First Touch Recipe app project to Volt MX Go Iris, see [**Import First Touch into Volt MX Go Iris**](../howto/importft.md). -- To know how to manually update your Domino container if you obtain a new version of *FirstTouchRecipes.nsf*, see [**Update FirstTouchRecipes.nsf**](../howto/FTnsfupdate.md). \ No newline at end of file +- To learn more about the app, see [First Touch Recipe Catalog app](../topicguides/firsttouchapp.md). +- To know how to import the First Touch Recipe app project to Volt MX Go Iris, see [Import First Touch into Volt MX Go Iris](../howto/importft.md). +- To know how to manually update your Domino container if you obtain a new version of *FirstTouchRecipes.nsf*, see [Update FirstTouchRecipes.nsf](../howto/FTnsfupdate.md). \ No newline at end of file diff --git a/docs/tutorials/installation.md b/docs/tutorials/installation.md index 0935efb5..727457a8 100644 --- a/docs/tutorials/installation.md +++ b/docs/tutorials/installation.md @@ -6,17 +6,17 @@ Guides you through the procedures for installing and upgrading Volt MX Go. In case you would like to deploy Volt MX Go in a **development or test only environment**, you can do so with Kubernetes using the following options: -- using [**K3s**](https://docs.k3s.io) on an Ubuntu, RHEL, SLES machine or VM -- using [**Rancher Desktop**](https://docs.rancherdesktop.io) running on Windows +- using [K3s](https://docs.k3s.io) on an Ubuntu, RHEL, SLES machine or VM +- using [Rancher Desktop](https://docs.rancherdesktop.io) running on Windows ## System requirements -Before starting the installation, make sure to verify that you meet the [**System requirements**](sysreq.md). +Before starting the installation, make sure to verify that you meet the [System requirements](sysreq.md). ## Installation and upgrade guide -To install and upgrade the server components of Volt MX Go, proceed to [**Install and upgrade Volt MX Go in a production environment**](prerequisite.md). +To install and upgrade the server components of Volt MX Go, proceed to [Install and upgrade Volt MX Go in a production environment](prerequisite.md). -To install and upgrade the server components of Volt MX Go in a development or test only environment, proceed to [**Install and upgrade Volt MX Go in development or test only environment**](containerdeployment.md). +To install and upgrade the server components of Volt MX Go in a development or test only environment, proceed to [Install and upgrade Volt MX Go in development or test only environment](containerdeployment.md). -After installing the server components, proceed to [**Install and upgrade Volt MX Go Iris**](installiris.md). +After installing the server components, proceed to [Install and upgrade Volt MX Go Iris](installiris.md). diff --git a/docs/tutorials/installiris.md b/docs/tutorials/installiris.md index da81a1f7..f91f2168 100644 --- a/docs/tutorials/installiris.md +++ b/docs/tutorials/installiris.md @@ -8,14 +8,14 @@ ### Prerequisite -- You have [**downloaded the HCL Volt MX Go Release package**](portaldownload.md). +- You have [downloaded the HCL Volt MX Go Release package](portaldownload.md). ### Procedure Install Volt MX Go Iris. -- [**For Mac**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_starter_install_mac/Content/Installing%20VoltMX%20Iris.html#installing) -- [**For Windows**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_starter_install_win/Content/Installing%20VoltMX%20Iris.html#installing) +- [For Mac](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_starter_install_mac/Content/Installing%20VoltMX%20Iris.html#installing) +- [For Windows](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_starter_install_win/Content/Installing%20VoltMX%20Iris.html#installing) ## Upgrade Volt MX Go Iris diff --git a/docs/tutorials/k3sinstall.md b/docs/tutorials/k3sinstall.md index 4738cf15..fa6f5d95 100644 --- a/docs/tutorials/k3sinstall.md +++ b/docs/tutorials/k3sinstall.md @@ -2,21 +2,21 @@ --8<-- "devtestenvironment.md" -K3s is a fully compliant Kubernetes distribution. For more information, see [**K3s - Lightweight Kubernetes**](https://docs.k3s.io/). +K3s is a fully compliant Kubernetes distribution. For more information, see [K3s - Lightweight Kubernetes](https://docs.k3s.io/). !!!warning "Caution" - In all the following instructions, it's assumed you are running commands as a **non-root user**. However, there are certain commands that must with sudo permissions. For these commands, you need to configure your non-root user with sudo. To do this, see [**Using sudo to allow non-root users to perform root level functions**](https://www.suse.com/support/kb/doc/?id=000016906). + In all the following instructions, it's assumed you are running commands as a **non-root user**. However, there are certain commands that must with sudo permissions. For these commands, you need to configure your non-root user with sudo. To do this, see [Using sudo to allow non-root users to perform root level functions](https://www.suse.com/support/kb/doc/?id=000016906). ## Before you begin !!!note If you will use Rancher Desktop in deploying Volt MX Go, you don't need to install K3s. -Before starting with the procedure, make sure that you have checked and verified that all system requirements [**for deploying MX Go using K3s on an Ubuntu, RHEL, SLES machine, or VM**](sysreq.md#for-deploying-volt-mx-go-using-k3s-on-an-ubuntu-rhel-sles-machine-or-vm) are met. +Before starting with the procedure, make sure that you have checked and verified that all system requirements [for deploying MX Go using K3s on an Ubuntu, RHEL, SLES machine, or VM](sysreq.md#for-deploying-volt-mx-go-using-k3s-on-an-ubuntu-rhel-sles-machine-or-vm) are met. ## 1. Install K3s -Before installing K3s, make sure you have met any operating system configuration required by K3s, specifically for [**RHEL and CENTOS**](https://docs.k3s.io/advanced#red-hat-enterprise-linux--centos). +Before installing K3s, make sure you have met any operating system configuration required by K3s, specifically for [RHEL and CENTOS](https://docs.k3s.io/advanced#red-hat-enterprise-linux--centos). 1. Run the following command: @@ -63,7 +63,7 @@ export KUBECONFIG=~/.kube/config ## 4. Install Helm -Helm is the package manager for Kubernetes and is used to install Volt MX Go. For more information, see [**Helm**](https://helm.sh/). +Helm is the package manager for Kubernetes and is used to install Volt MX Go. For more information, see [Helm](https://helm.sh/). To install Helm, run the following commands: @@ -74,7 +74,7 @@ sudo mv linux-386/helm /usr/local/bin/helm sudo rm -rf helm-v3.11.2-linux-386.tar.gz linux-386 ``` -For more information, see [**Installing Helm**](https://helm.sh/docs/intro/install/) and [**Helm releases**](https://github.com/helm/helm/releases). +For more information, see [Installing Helm](https://helm.sh/docs/intro/install/) and [Helm releases](https://github.com/helm/helm/releases). ## 5. Ensure K3s is active and ready @@ -104,4 +104,4 @@ For more information, see [**Installing Helm**](https://helm.sh/docs/intro/insta ## Next step -Proceed to [**Complete preparatory procedure**](prereq.md). \ No newline at end of file +Proceed to [Complete preparatory procedure](prereq.md). \ No newline at end of file diff --git a/docs/tutorials/nativeinstallers.md b/docs/tutorials/nativeinstallers.md index 958298e4..dbab86ed 100644 --- a/docs/tutorials/nativeinstallers.md +++ b/docs/tutorials/nativeinstallers.md @@ -8,7 +8,7 @@ The procedures guide you in installing the following server components of Volt M !!!warning "Important" - Using this installation option would require you to use your own Domino server. - - Before starting the installation, make sure to verify that you meet the [**System requirements**](sysreq.md). + - Before starting the installation, make sure to verify that you meet the [System requirements](sysreq.md). --8<-- "browsertab.md" @@ -16,15 +16,15 @@ The procedures guide you in installing the following server components of Volt M --8<-- "drapiversion.md" -1. Downloaded the Domino REST API installer. For more information, see [**Download the Domino REST API**](https://opensource.hcltechsw.com/Domino-rest-api/tutorial/installconfig/index.html#download-the-domino-rest-api) in the HCL Domino REST API documentation. +1. Downloaded the Domino REST API installer. For more information, see [Download the Domino REST API](https://opensource.hcltechsw.com/Domino-rest-api/tutorial/installconfig/index.html#download-the-domino-rest-api) in the HCL Domino REST API documentation. 2. Follow the links to the installation procedure based on your preferred installation platform: - - [**For Windows**](https://opensource.hcltechsw.com/Domino-rest-api/tutorial/installconfig/win.html) - - [**For Linux**](https://opensource.hcltechsw.com/Domino-rest-api/tutorial/installconfig/linux.html) + - [For Windows](https://opensource.hcltechsw.com/Domino-rest-api/tutorial/installconfig/win.html) + - [For Linux](https://opensource.hcltechsw.com/Domino-rest-api/tutorial/installconfig/linux.html) -3. Complete all the [**post-installation tasks**](https://opensource.hcltechsw.com/Domino-rest-api/tutorial/installconfig/postinstallation.html). +3. Complete all the [post-installation tasks](https://opensource.hcltechsw.com/Domino-rest-api/tutorial/installconfig/postinstallation.html). -For more information, see the [**Installation and configuration**](https://opensource.hcltechsw.com/Domino-rest-api/tutorial/installconfig/index.html) page in the HCL Domino REST API documentation. +For more information, see the [Installation and configuration](https://opensource.hcltechsw.com/Domino-rest-api/tutorial/installconfig/index.html) page in the HCL Domino REST API documentation. ## Install Volt MX Go Foundry @@ -39,7 +39,7 @@ Volt MX Go Foundry supports the following installation mechanisms: 1. Download the Volt MX Go Foundry installer based on your preferred installation platform/option. - For more information, see [**Download HCL Volt MX Go Release package**](portaldownload.md). + For more information, see [Download HCL Volt MX Go Release package](portaldownload.md). 2. Extract the installer from the downloaded ZIP file. 3. Follow the links to the installation guides based on your preferred installation platform/option: @@ -48,9 +48,9 @@ Volt MX Go Foundry supports the following installation mechanisms: - The installation guides will indicate installation files and installation file download locations. **You must use the installer you downloaded in Step 1.** - Make sure to check all the details and complete all the applicable procedures indicated in the sections in the installation guides. - - [**For Windows**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_windows_install_guide/Content/Introduction.html) - - [**For Linux**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_linux_install_guide/Content/Introduction.html) - - [**For command line installer**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/VoltMX_Foundry_CLI/Content/installer_cli.html) + - [For Windows](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_windows_install_guide/Content/Introduction.html) + - [For Linux](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_linux_install_guide/Content/Introduction.html) + - [For command line installer](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/VoltMX_Foundry_CLI/Content/installer_cli.html) ### For using helm charts on a supported Kubernetes platform @@ -64,7 +64,7 @@ Volt MX Go Foundry supports the following installation mechanisms: ``` !!!note "Prerequisite" - [**Obtain authentication token from HCL Container Repository**](obtainauthenticationtoken.md) before proceeding. + [Obtain authentication token from HCL Container Repository](obtainauthenticationtoken.md) before proceeding. #### 1. Create a namespace and a temp directory for the charts @@ -81,7 +81,7 @@ cd ~/mxgo #### 2. Configure Helm to pull from HCL Container Repository -The procedure sets up Helm with the details necessary to authenticate with the HCL Container Repository. You will need your [**email and authentication token**](obtainauthenticationtoken.md) used with the HCL Container Repository. +The procedure sets up Helm with the details necessary to authenticate with the HCL Container Repository. You will need your [email and authentication token](obtainauthenticationtoken.md) used with the HCL Container Repository. - Run the following command to set up Helm: @@ -94,7 +94,7 @@ The procedure sets up Helm with the details necessary to authenticate with the H !!!note - Use the **CLI secret** value you saved from [**obtaining authentication token from HCL Container Repository**](obtainauthenticationtoken.md) as your authentication token or password. + Use the **CLI secret** value you saved from [obtaining authentication token from HCL Container Repository](obtainauthenticationtoken.md) as your authentication token or password. If you get an error message similar to the following: @@ -136,7 +136,7 @@ The procedure sets up Helm with the details necessary to authenticate with the H ./init-guids.sh --new ``` -4. Edit the `values.yaml` file to update the `imageCredentials` by replacing `your-email` and `your-authentication-token` with your [**email and authentication token**](obtainauthenticationtoken.md) used with the HCL Container Repository. +4. Edit the `values.yaml` file to update the `imageCredentials` by replacing `your-email` and `your-authentication-token` with your [email and authentication token](obtainauthenticationtoken.md) used with the HCL Container Repository. ```{ .yaml .no-copy } imageCredentials: @@ -145,14 +145,14 @@ The procedure sets up Helm with the details necessary to authenticate with the H ``` !!!note - Use the **CLI secret** value you saved from [**obtaining authentication token from HCL Container Repository**](obtainauthenticationtoken.md) as your authentication token or password. + Use the **CLI secret** value you saved from [obtaining authentication token from HCL Container Repository](obtainauthenticationtoken.md) as your authentication token or password. 5. Locate the following line in the file and add your Volt MX Go Foundry server domain name setting: ```{ .yaml .no-copy } serverDomainName: ``` - Whatever server domain name you specify here, you need to ensure that it's resolvable. There is no additional work if you have already registered your server domain name in DNS. However, if you haven't registered it, you must add it to the server's /etc/hosts file [**Ensure Foundry Hostnames are resolvable**](prereq.md#3-ensure-foundry-hostnames-are-resolvable), substituting your server domain name. Additionally, you must make the same updates in k3s's coredns config map as described in [**For K3s only**](prereq.md#for-k3s-only) again substituting your server domain name. + Whatever server domain name you specify here, you need to ensure that it's resolvable. There is no additional work if you have already registered your server domain name in DNS. However, if you haven't registered it, you must add it to the server's /etc/hosts file [Ensure Foundry Hostnames are resolvable](prereq.md#3-ensure-foundry-hostnames-are-resolvable), substituting your server domain name. Additionally, you must make the same updates in k3s's coredns config map as described in [For K3s only](prereq.md#for-k3s-only) again substituting your server domain name. 6. Locate the following lines in the file and add your Volt MX Go Foundry database details: @@ -183,13 +183,13 @@ The procedure sets up Helm with the details necessary to authenticate with the H dbPass: ``` -7. For more advanced configuration options, see [**Configuration**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmxfoundry_containers_helm/Content/Installing_Containers_With_Helm.html#configuration) in the *Installation Guide for Volt MX Foundry Containers Helm Installation*. +7. For more advanced configuration options, see [Configuration](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmxfoundry_containers_helm/Content/Installing_Containers_With_Helm.html#configuration) in the *Installation Guide for Volt MX Foundry Containers Helm Installation*. 8. Save the file and exit. #### 4. (Optional) Perform advanced scenario procedures -- Perform the procedures under [**Advanced Scenarios**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmxfoundry_containers_helm/Content/Installing_Containers_With_Helm_Advanced_Scenarios.html). +- Perform the procedures under [Advanced Scenarios](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmxfoundry_containers_helm/Content/Installing_Containers_With_Helm_Advanced_Scenarios.html). #### 5. Deploy Foundry's dbupdate to create the databases @@ -247,23 +247,23 @@ The procedure sets up Helm with the details necessary to authenticate with the H !!!note - If you defined a different Volt MX Go Foundry hostname, the Foundry URL would be the defined Foundry hostname concatenated with `/mfconsole/`. - If you want to access this deployment from a remote machine, you most likely need to update the `/etc/hosts` file on the remote machine as well. - - To create an account, see [**Create a Volt MX Go Foundry administrator account**](../howto/foundryadminaccount.md). - - To connect to Domino server from your Notes client, see [**Connect to Domino server from your Notes client**](../howto/connectdominofromnotes.md). + - To create an account, see [Create a Volt MX Go Foundry administrator account](../howto/foundryadminaccount.md). + - To connect to Domino server from your Notes client, see [Connect to Domino server from your Notes client](../howto/connectdominofromnotes.md). #### 7. (Optional) Perform monitoring procedures -- Perform the procedures under [**Monitoring**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmxfoundry_containers_helm/Content/Installing_Containers_With_Helm_Monitoring.html) in the HCL Volt MX documentation. +- Perform the procedures under [Monitoring](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmxfoundry_containers_helm/Content/Installing_Containers_With_Helm_Monitoring.html) in the HCL Volt MX documentation. !!!note The procedures are for enabling important monitoring features such as Metrics Server, Elastic Stack, Kuberhealthy. #### 8. (Optional) Perform post installation tasks -- Perform the procedures under the [**Post Installation Tasks**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmxfoundry_containers_helm/Content/Installing_Containers_With_Helm_PostInstallation.html) in the HCL Volt MX documentation. +- Perform the procedures under the [Post Installation Tasks](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmxfoundry_containers_helm/Content/Installing_Containers_With_Helm_PostInstallation.html) in the HCL Volt MX documentation. ## Additional information -After completing the installation of **Domino REST API** and **Volt MX Go Foundry**, proceed to [**Install Volt MX Go Iris**](installiris.md). +After completing the installation of **Domino REST API** and **Volt MX Go Foundry**, proceed to [Install Volt MX Go Iris](installiris.md). diff --git a/docs/tutorials/obtainauthenticationtoken.md b/docs/tutorials/obtainauthenticationtoken.md index 6a2f4aec..b314dd96 100644 --- a/docs/tutorials/obtainauthenticationtoken.md +++ b/docs/tutorials/obtainauthenticationtoken.md @@ -6,7 +6,7 @@ The binary images and Helm charts for Volt MX Go server components are pulled fr ## To obtain your authentication token -1. Go to the [**HCL Container Repository**](https://hclcr.io "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"} ![link image](../assets/images/external-link.svg){: style="height:15px;width:15px"}. +1. Go to the [HCL Container Repository](https://hclcr.io "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"} ![link image](../assets/images/external-link.svg){: style="height:15px;width:15px"}. 2. On the login page, click **LOGIN VIA OIDC Provider**, and then login using your corporate email address. 3. On the **Projects** page, click your username and select **User Profile**. @@ -25,6 +25,6 @@ The binary images and Helm charts for Volt MX Go server components are pulled fr ## Next step -For installing Volt MX Go using helm charts on a supported Kubernetes platform for a production environment, proceed to [**Configure Helm to pull from HCL Container Repository**](nativeinstallers.md#1-create-a-namespace-and-a-temp-directory-for-the-charts). +For installing Volt MX Go using helm charts on a supported Kubernetes platform for a production environment, proceed to [Configure Helm to pull from HCL Container Repository](nativeinstallers.md#1-create-a-namespace-and-a-temp-directory-for-the-charts). -For installing Volt MX Go to **development or test only environment**, proceed to [**Deploy Kubernetes**](deploykubernetes.md). \ No newline at end of file +For installing Volt MX Go to **development or test only environment**, proceed to [Deploy Kubernetes](deploykubernetes.md). \ No newline at end of file diff --git a/docs/tutorials/portaldownload.md b/docs/tutorials/portaldownload.md index a2a44234..33bf58d2 100644 --- a/docs/tutorials/portaldownload.md +++ b/docs/tutorials/portaldownload.md @@ -5,13 +5,13 @@ Guides you on how to search and download the HCL Volt MX Go Release package from the **HCL License & Download Portal**. !!!tip - To learn more about **HCL License & Download Portal**, see [**What is the HCL Software License & Download Portal?**](https://support.hcltechsw.com/csm?id=kb_article&sysparm_article=KB0073344). + To learn more about **HCL License & Download Portal**, see [What is the HCL Software License & Download Portal?](https://support.hcltechsw.com/csm?id=kb_article&sysparm_article=KB0073344). ## Procedure **To search and download the HCL Volt MX Go Release package** -1. Go to [**HCL License & Download Portal**](https://hclsoftware.flexnetoperations.com/ "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"} ![link image](../assets/images/external-link.svg){: style="height:15px;width:15px"}. +1. Go to [HCL License & Download Portal](https://hclsoftware.flexnetoperations.com/ "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"} ![link image](../assets/images/external-link.svg){: style="height:15px;width:15px"}. 2. On the sign in page, enter your username and click **Next**. The **License & Download Portal** home page opens. 3. On the **License & Download Portal** home page, go to **Downloads** → **List Downloads**. 4. On the **Downloads** page, search for and click **HCL Volt MX**. @@ -32,6 +32,6 @@ Guides you on how to search and download the HCL Volt MX Go Release package from ## Next step -For a new installation, proceed to [**Install Volt MX Go server components**](nativeinstallers.md). +For a new installation, proceed to [Install Volt MX Go server components](nativeinstallers.md). -For an upgrade installation, proceed to [**Upgrade Volt MX Go server components**](versionupgrade.md) +For an upgrade installation, proceed to [Upgrade Volt MX Go server components](versionupgrade.md) diff --git a/docs/tutorials/sysreq.md b/docs/tutorials/sysreq.md index 1f057fda..ef438944 100644 --- a/docs/tutorials/sysreq.md +++ b/docs/tutorials/sysreq.md @@ -5,35 +5,35 @@ This section describes the minimum system requirements for deploying Volt MX Go. ## For installing Volt MX Go Foundry ### Software requirements -Check the [**Supported OS, Application Servers, and Database Guide**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmxfoundry_supported_devices_os_browsers/Content/Introduction.html) to know the software requirements for installing Volt MX Go Foundry using installers. +Check the [Supported OS, Application Servers, and Database Guide](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmxfoundry_supported_devices_os_browsers/Content/Introduction.html) to know the software requirements for installing Volt MX Go Foundry using installers. ### Hardware requirements -- [**For Windows**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_windows_install_guide/Content/Prerequisites.html#hardware-requirements) -- [**For Linux**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_linux_install_guide/Content/Prerequisites.html#hardware-requirements) +- [For Windows](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_windows_install_guide/Content/Prerequisites.html#hardware-requirements) +- [For Linux](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_linux_install_guide/Content/Prerequisites.html#hardware-requirements) ### Network settings -- [**For Windows**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_windows_install_guide/Content/Prerequisites.html#network-settings) -- [**For Linux**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_linux_install_guide/Content/Prerequisites.html#network-settings) +- [For Windows](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_windows_install_guide/Content/Prerequisites.html#network-settings) +- [For Linux](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_linux_install_guide/Content/Prerequisites.html#network-settings) ### Supported browsers -Check the [**supported browsers**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmxfoundry_supported_devices_os_browsers/Content/Supported_Browsers.html) for the Volt MX Go Foundry Console. +Check the [supported browsers](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmxfoundry_supported_devices_os_browsers/Content/Supported_Browsers.html) for the Volt MX Go Foundry Console. ### Prerequisites for Volt MX Go Foundry command line installer -Check the additional [**prerequisites**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/VoltMX_Foundry_CLI/Content/installer_cli.html#prerequisites) when using the Foundry command line installer. +Check the additional [prerequisites](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/VoltMX_Foundry_CLI/Content/installer_cli.html#prerequisites) when using the Foundry command line installer. ### Prerequisites for Volt MX Foundry Containers Helm Installation -Check the [**prerequisites**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmxfoundry_containers_helm/Content/Installing_Containers_With_Helm.html#prerequisites) when using the Volt MX Go Foundry Containers Helm Installation. +Check the [prerequisites](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmxfoundry_containers_helm/Content/Installing_Containers_With_Helm.html#prerequisites) when using the Volt MX Go Foundry Containers Helm Installation. ## For installing Domino REST API --8<-- "drapiversion.md" -Check the [**system requirements**](https://support.hcltechsw.com/csm?id=kb_article&sysparm_article=KB0101789) for installing Domino REST API using the installer. +Check the [system requirements](https://support.hcltechsw.com/csm?id=kb_article&sysparm_article=KB0101789) for installing Domino REST API using the installer. ## For installing Volt MX Go Iris on Windows @@ -83,8 +83,8 @@ Mac OS X 10.9 and above | RAM | 16 GB | !!!note - - For more information on K3s, see [**K3s - Lightweight Kubernetes**](https://docs.k3s.io/). - - For more information on the installation requirements for K3s, see [**K3s Installation Requirements**](https://docs.k3s.io/installation/requirements). + - For more information on K3s, see [K3s - Lightweight Kubernetes](https://docs.k3s.io/). + - For more information on the installation requirements for K3s, see [K3s Installation Requirements](https://docs.k3s.io/installation/requirements). ## For deploying Volt MX Go using Rancher Desktop running on Windows @@ -111,9 +111,9 @@ Rancher Desktop requires the following on Windows: - Windows Subsystem for Linux on Windows. This will automatically be installed as part of the Rancher Desktop setup. Manually downloading a distribution isn't necessary. !!!note - - For more information on Rancher Desktop, see [**Introduction**](https://docs.rancherdesktop.io/) in the Rancher Desktop documentation. - - For more information on Rancher Desktop installation requirements, see [**Installation**](https://docs.rancherdesktop.io/getting-started/installation/#windows) in the Rancher Desktop documentation. + - For more information on Rancher Desktop, see [Introduction](https://docs.rancherdesktop.io/) in the Rancher Desktop documentation. + - For more information on Rancher Desktop installation requirements, see [Installation](https://docs.rancherdesktop.io/getting-started/installation/#windows) in the Rancher Desktop documentation. ## Next step -Proceed to [**Installation**](../tutorials/installation.md). \ No newline at end of file +Proceed to [Installation](../tutorials/installation.md). \ No newline at end of file diff --git a/docs/tutorials/versionupgrade.md b/docs/tutorials/versionupgrade.md index 8bbc9e29..5bf0fef8 100644 --- a/docs/tutorials/versionupgrade.md +++ b/docs/tutorials/versionupgrade.md @@ -8,8 +8,8 @@ The following procedures guide you in upgrading the server components of Volt MX --8<-- "drapiversion.md" -1. Downloaded the required version of the Domino REST API installer. For more information, see [**Download the Domino REST API**](https://opensource.hcltechsw.com/Domino-rest-api/tutorial/installconfig/index.html#download-the-domino-rest-api) in the HCL Domino REST API documentation. -2. Follow the relevant steps in the [**upgrade procedure**](https://opensource.hcltechsw.com/Domino-rest-api/howto/production/versionupdate.html) in the HCL Domino REST API documentation based on your installation platform. +1. Downloaded the required version of the Domino REST API installer. For more information, see [Download the Domino REST API](https://opensource.hcltechsw.com/Domino-rest-api/tutorial/installconfig/index.html#download-the-domino-rest-api) in the HCL Domino REST API documentation. +2. Follow the relevant steps in the [upgrade procedure](https://opensource.hcltechsw.com/Domino-rest-api/howto/production/versionupdate.html) in the HCL Domino REST API documentation based on your installation platform. ## Upgrade Volt MX Go Foundry @@ -26,7 +26,7 @@ As Volt MX Go Foundry supports various installation mechanisms, refer to the rel #### Before you begin - Back up your databases and server artifacts. -- You have downloaded the latest Volt MX Go Foundry installer based on your used installation platform/option. For more information, see [**Download HCL Volt MX Go Release package**](portaldownload.md). +- You have downloaded the latest Volt MX Go Foundry installer based on your used installation platform/option. For more information, see [Download HCL Volt MX Go Release package](portaldownload.md). - Ensure that the installer has execute permission. - Ensure that you have the path of your previous installation directory. - Ensure that you stop the application server of your existing Volt MX Go Foundry instance, which you want to upgrade. @@ -66,7 +66,7 @@ As Volt MX Go Foundry supports various installation mechanisms, refer to the rel 2. Configure Helm to pull from HCL Container Repository. - You will need your [**email and authentication token**](obtainauthenticationtoken.md) used with the HCL Container Repository. + You will need your [email and authentication token](obtainauthenticationtoken.md) used with the HCL Container Repository. 1. Run the following command to check if `hclcr` is already defined: @@ -90,7 +90,7 @@ As Volt MX Go Foundry supports various installation mechanisms, refer to the rel !!!note - Use the **CLI secret** value you saved from [**obtaining authentication token from HCL Container Repository**](obtainauthenticationtoken.md) as your authentication token or password. + Use the **CLI secret** value you saved from [obtaining authentication token from HCL Container Repository](obtainauthenticationtoken.md) as your authentication token or password. If you get an error message similar to the following: @@ -141,5 +141,5 @@ As Volt MX Go Foundry supports various installation mechanisms, refer to the rel ## Additional information -After completing the upgrade installation of **Domino REST API** and **Volt MX Go Foundry**, proceed to [**Install and upgrade Volt MX Go Iris**](installiris.md). +After completing the upgrade installation of **Domino REST API** and **Volt MX Go Foundry**, proceed to [Install and upgrade Volt MX Go Iris](installiris.md). diff --git a/docs/tutorials/voltformula.md b/docs/tutorials/voltformula.md index 16e2e495..3b4352d9 100644 --- a/docs/tutorials/voltformula.md +++ b/docs/tutorials/voltformula.md @@ -1,12 +1,12 @@ # VoltFormula tutorial -This tutorial shows you how to use VoltFormula in Volt MX Go Iris to convert formulas from OpenFormula and NotesFormula into Volt MX Go Rosetta JavaScript. This feature in Volt MX Go Iris allows you to enter into source [**OpenFormula**](https://docs.oasis-open.org/office/OpenDocument/v1.3/OpenDocument-v1.3-part4-formula.html) and [**Notes Formula Language**](https://help.hcltechsw.com/dom_designer/10.0.1/basic/H_NOTES_FORMULA_LANGUAGE.html) and have it translated automatically into JavaScript code. +This tutorial shows you how to use VoltFormula in Volt MX Go Iris to convert formulas from OpenFormula and NotesFormula into Volt MX Go Rosetta JavaScript. This feature in Volt MX Go Iris allows you to enter into source [OpenFormula](https://docs.oasis-open.org/office/OpenDocument/v1.3/OpenDocument-v1.3-part4-formula.html) and [Notes Formula Language](https://help.hcltechsw.com/dom_designer/10.0.1/basic/H_NOTES_FORMULA_LANGUAGE.html) and have it translated automatically into JavaScript code. ## Before you begin -- You have completed the [**Volt MX Go installation**](installation.md). -- You have created your [**Volt MX Go Foundry admin account**](../howto/foundryadminaccount.md). -- You know how to use [**Actions**](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_user_guide/Content/working_with_Action_Editor.html#search-for-an-action-in-action-editor). +- You have completed the [Volt MX Go installation](installation.md). +- You have created your [Volt MX Go Foundry admin account](../howto/foundryadminaccount.md). +- You know how to use [Actions](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_user_guide/Content/working_with_Action_Editor.html#search-for-an-action-in-action-editor). ## Launch Volt MX Go Iris @@ -160,6 +160,6 @@ This tutorial shows you how to use VoltFormula in Volt MX Go Iris to convert for ![Edit Rosetta JS](../assets/images/vfjavaedit.png) !!!Info - - The default Rosetta VoltFormula setting can be modified according to your need for your app. To change the configuration, see [**Configure VoltFormula's Rosetta API Options**](../howto/configrosetta.md). - - To know more about the proper way of handling codes, see [**VoltFormula coding exercise examples in Volt MX Go Iris**](../topicguides/vfcodingguides.md). + - The default Rosetta VoltFormula setting can be modified according to your need for your app. To change the configuration, see [Configure VoltFormula's Rosetta API Options](../howto/configrosetta.md). + - To know more about the proper way of handling codes, see [VoltFormula coding exercise examples in Volt MX Go Iris](../topicguides/vfcodingguides.md). diff --git a/docs/tutorials/webinar.md b/docs/tutorials/webinar.md index 5c57ab2d..c8e6e0d4 100644 --- a/docs/tutorials/webinar.md +++ b/docs/tutorials/webinar.md @@ -5,13 +5,13 @@ Check the following platforms to learn how to modernize your Domino applications ## HCLSoftware U !!!info "Embark On Your Journey" - Realize the power of possibility for you and your business. Visit [**HCLSoftware U**](https://hclsoftwareu.hcltechsw.com/ "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"} ![link image](../assets/images/external-link.svg){: style="height:15px;width:15px"} for technical education on all products in the HCL Software portfolio. Start learning today! + Realize the power of possibility for you and your business. Visit [HCLSoftware U](https://hclsoftwareu.hcltechsw.com/ "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"} ![link image](../assets/images/external-link.svg){: style="height:15px;width:15px"} for technical education on all products in the HCL Software portfolio. Start learning today! -Get hands-on development experience modernizing a Domino application with Volt MX Go and learn how to install and configure HCL Volt MX Go as an administrator. Check out the [**Volt MX Go learning journey in HCLSoftware U**](https://hclsoftwareu.hcltechsw.com/volt-mx-go "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"} ![link image](../assets/images/external-link.svg){: style="height:15px;width:15px"}. +Get hands-on development experience modernizing a Domino application with Volt MX Go and learn how to install and configure HCL Volt MX Go as an administrator. Check out the [Volt MX Go learning journey in HCLSoftware U](https://hclsoftwareu.hcltechsw.com/volt-mx-go "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"} ![link image](../assets/images/external-link.svg){: style="height:15px;width:15px"}. ## Volt MX Go Webinar Series -Watch the [**Volt MX Go Webinar series**](https://www.youtube.com/playlist?list=PLEjl4yzB6ckEi3PDf0UKyotYpojLzUIDF "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"} ![link image](../assets/images/external-link.svg){: style="height:15px;width:15px"} to better understand how to modernize your Domino apps while avoiding the cost, time, and risk of a total rewrite. The webinar series shows you how to: +Watch the [Volt MX Go Webinar series](https://www.youtube.com/playlist?list=PLEjl4yzB6ckEi3PDf0UKyotYpojLzUIDF "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"} ![link image](../assets/images/external-link.svg){: style="height:15px;width:15px"} to better understand how to modernize your Domino apps while avoiding the cost, time, and risk of a total rewrite. The webinar series shows you how to: - extend existing Domino apps with multi-experience capabilities and advanced UX while retaining existing business logic - maximize your years of investment in Domino apps and skills @@ -30,7 +30,7 @@ The webinar series includes the following webinars: ## Volt MX Go on HCL SoFy -Explore everything Volt MX Go can do in a free, hosted trial environment on [**HCL SoFy**](https://hclsofy.com/ "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"}. Your sandbox will be up and running in 10 minutes and provides access to a hosted Domino server (where you can copy or replicate your own Domino applications), the Domino REST API, Volt MX Go Foundry, and Volt MX Go Iris, a step-by-step wizard to connect Volt MX to Domino, Design Import, and VoltFormula. Check the following links for more information: +Explore everything Volt MX Go can do in a free, hosted trial environment on [HCL SoFy](https://hclsofy.com/ "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"}. Your sandbox will be up and running in 10 minutes and provides access to a hosted Domino server (where you can copy or replicate your own Domino applications), the Domino REST API, Volt MX Go Foundry, and Volt MX Go Iris, a step-by-step wizard to connect Volt MX to Domino, Design Import, and VoltFormula. Check the following links for more information: - [Overview of Volt MX Go](https://hclsofy.com/sofy/catalog/hcl-voltmxgo-small?view=doc&file=documentation.md "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"} ![link image](../assets/images/external-link.svg){: style="height:15px;width:15px"} - [Using Volt MX Go on Sofy](https://hclsofy.com/sofy/catalog/hcl-voltmxgo-small?view=doc&file=using-voltmxgo.md "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"} ![link image](../assets/images/external-link.svg){: style="height:15px;width:15px"} From 3355e74ab9390396db6a8d4b769c6e3e8fb9051e Mon Sep 17 00:00:00 2001 From: Zerlord Santiago Date: Mon, 22 Jul 2024 17:42:04 +0800 Subject: [PATCH 3/4] Accessibility improvements --- docs/assets/css/voltmxgo.css | 14 +++++--- docs/howto/FTnsfupdate.md | 3 +- docs/howto/accessdrapi.md | 1 + docs/howto/codegen.md | 5 +++ docs/howto/deleteform.md | 2 ++ docs/howto/diagents.md | 6 ++-- docs/howto/drapiingress.md | 9 ++--- docs/howto/foundryadminaccount.md | 4 +-- docs/howto/importft.md | 3 +- docs/howto/importvoltformula.md | 8 +++-- docs/howto/insertattachments.md | 1 + docs/index.md | 8 ++--- docs/references/knownlimitation.md | 4 +-- docs/references/whatsnew/v204.md | 5 ++- docs/topicguides/datamodel.md | 3 +- docs/topicguides/designimportintro.md | 2 ++ docs/tutorials/adaptertutorial.md | 6 +++- docs/tutorials/containerdeployment.md | 37 ++++++++++----------- docs/tutorials/deploykubernetes.md | 1 + docs/tutorials/designimport.md | 8 +++-- docs/tutorials/downloadhelmchart.md | 4 +++ docs/tutorials/firsttouch.md | 7 ++++ docs/tutorials/installation.md | 1 + docs/tutorials/installfoundry.md | 2 ++ docs/tutorials/installiris.md | 2 +- docs/tutorials/nativeinstallers.md | 16 ++++----- docs/tutorials/obtainauthenticationtoken.md | 1 + docs/tutorials/portaldownload.md | 1 + docs/tutorials/versionupgrade.md | 3 ++ docs/tutorials/voltformula.md | 2 ++ 30 files changed, 108 insertions(+), 61 deletions(-) diff --git a/docs/assets/css/voltmxgo.css b/docs/assets/css/voltmxgo.css index f2837ef9..275196fc 100644 --- a/docs/assets/css/voltmxgo.css +++ b/docs/assets/css/voltmxgo.css @@ -84,10 +84,6 @@ pre { background-color: #eeeeee; } - .newpageicon { - font-size: x-small; - } - /* the following css is for increasing the font size and changing the font and font color of the copyright */ @@ -149,5 +145,13 @@ pre { table th{ font-size: medium; } + + /* + the following css is for underlining the link in the table + */ + table td a{ + text-decoration: underline; + } + - \ No newline at end of file + diff --git a/docs/howto/FTnsfupdate.md b/docs/howto/FTnsfupdate.md index 29f47db7..8d5f359c 100644 --- a/docs/howto/FTnsfupdate.md +++ b/docs/howto/FTnsfupdate.md @@ -8,7 +8,8 @@ Guides you in manually updating your Domino container if you obtain a new versio ## Procedure -1. [Uninstall the First Touch app](uninstallfirsttouch.md) from Volt MX Go Foundry. +1. [Uninstall the First Touch app](uninstallfirsttouch.md) from Volt MX Go Foundry. + 2. Identify the name of the Domino container by running the following command: ``` diff --git a/docs/howto/accessdrapi.md b/docs/howto/accessdrapi.md index e7e8afa3..dd69f3be 100644 --- a/docs/howto/accessdrapi.md +++ b/docs/howto/accessdrapi.md @@ -13,6 +13,7 @@ You must complete the [Volt MX Go installation](../tutorials/installation.md). ### For Domino REST API installed via an installer - Check how to login to [Domino REST API Admin UI](https://opensource.hcltechsw.com/Domino-rest-api/tutorial/adminui.html#login) in the HCL Domino REST API documentation. + - Use your Domino server administrator username and password to log in. ### For Domino REST API installed as part of the installation on a development or test only environment diff --git a/docs/howto/codegen.md b/docs/howto/codegen.md index e0b9abbb..f97570c4 100644 --- a/docs/howto/codegen.md +++ b/docs/howto/codegen.md @@ -7,10 +7,15 @@ The procedure guides you in generating CRUD forms and associated form-navigation ## Before you begin - You have [created an app in Volt MX Go Foundry](https://opensource.hcltechsw.com/voltmxgo-documentation/tutorials/adaptertutorial.html#create-an-app-in-volt-mx-foundry). + - You have [configured an Identity Service for your app in Volt MX Go Foundry](https://opensource.hcltechsw.com/voltmxgo-documentation/tutorials/adaptertutorial.html#configure-an-identity-service). + - You have [added an environment for your app](https://opensource.hcltechsw.com/voltmxgo-documentation/tutorials/adaptertutorial.html#add-an-environment). + - You have [configured an Object Service for your app in Volt MX Go Foundry](https://opensource.hcltechsw.com/voltmxgo-documentation/tutorials/adaptertutorial.html#configure-an-object-service). + - You have [configured the data model for the Object Service](https://opensource.hcltechsw.com/voltmxgo-documentation/tutorials/adaptertutorial.html#configure-a-data-model). + - You have [created a project in Volt MX Go Iris](https://opensource.hcltechsw.com/voltmxgo-documentation/tutorials/designimport.html#create-a-new-project). ## Procedure diff --git a/docs/howto/deleteform.md b/docs/howto/deleteform.md index e7553103..6a442f73 100644 --- a/docs/howto/deleteform.md +++ b/docs/howto/deleteform.md @@ -9,7 +9,9 @@ Guides you on how to delete forms when importing a Domino application into an ex ## Before you begin - You must complete the [Volt MX Go installation](../tutorials/installation.md). + - You already imported a Domino application on your project. + - You must create a Domino application on your existing project. diff --git a/docs/howto/diagents.md b/docs/howto/diagents.md index cdbf1f1a..5b092924 100644 --- a/docs/howto/diagents.md +++ b/docs/howto/diagents.md @@ -16,7 +16,7 @@ Shows you how the **Agents** are imported to the Volt MX Iris Go Design Import. ## Procedure -1. You must finish the procedure [importing Domino Application](../tutorials/designimport.md#import-a-domino-application-using-a-new-volt-mx-go-foundry-app). +You must finish the procedure [importing Domino Application](../tutorials/designimport.md#import-a-domino-application-using-a-new-volt-mx-go-foundry-app). !!!important - For the Volt MX Go release v2.0.4, only limited Agents are supported. @@ -26,7 +26,7 @@ Shows you how the **Agents** are imported to the Volt MX Iris Go Design Import. **Importing Agents in Volt MX Go Iris using the Design Import capability** -- The **Domino Agent** will be imported as **actions**. These will available on **Views** for all the configured `views` on the imported Domino app. +- The **Domino Agent** will be imported as **actions**. These will be available on **Views** for all the configured `views` on the imported Domino app. ## Expected result @@ -37,8 +37,6 @@ Shows you how the **Agents** are imported to the Volt MX Iris Go Design Import. 1. On the **Views**, click the **Customers B ByRegion**. ![Dashboard](../assets/images/diviewagent.png) - - The **Customers B ByRegion** will open. diff --git a/docs/howto/drapiingress.md b/docs/howto/drapiingress.md index 6e4ba2f6..3f2cdea7 100644 --- a/docs/howto/drapiingress.md +++ b/docs/howto/drapiingress.md @@ -60,9 +60,12 @@ If you configure your Kubernetes Ingress to use a self-signed SSL certificate or You can use any of the following options: -- Purchase a certificate from a trusted Certificate Authority +- Purchase a certificate from a trusted Certificate Authority. + - Obtain a free certificate from [Let's Encrypt](https://letsencrypt.org/) or [ZeroSSL](https://zerossl.com). + - For test purposes, [create a self-signed certificate](#create-a-self-signed-certificate). + - Use the [Kubernetes default cluster certificate](#obtain-default-cluster-certificate) by pulling it from your cluster. #### Create a self-signed certificate @@ -157,9 +160,7 @@ For more information about `keytool`, see [Java Keytool documentation](https://d ### 4. Update the Helm `values.yaml` -- Update your `values.yaml` with the following configuration details to properly configure SSL. - - Check the notes for specific use cases and refer to Kubernetes Ingress details in [Before you begin](#before-you-begin) for more details on each parameter. +Update your `values.yaml` with the following configuration details to properly configure SSL. Check the notes for specific use cases and refer to Kubernetes Ingress details in [Before you begin](#before-you-begin) for more details on each parameter. ``` bash diff --git a/docs/howto/foundryadminaccount.md b/docs/howto/foundryadminaccount.md index 2160a335..7bed5d29 100644 --- a/docs/howto/foundryadminaccount.md +++ b/docs/howto/foundryadminaccount.md @@ -12,9 +12,7 @@ You must complete the [Volt MX Go installation](../tutorials/installation.md). ### For Volt MX Go Foundry installed via installers -- Check the procedure on [how to get started with Volt MX Foundry Console](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_user_guide/Content/How_to_access_VoltMX_Foundry_Portal_on-Prem.html). - -You can also contact the Volt MX Go Foundry administrator to request for an administrator account. +Check the procedure on [how to get started with Volt MX Foundry Console](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_user_guide/Content/How_to_access_VoltMX_Foundry_Portal_on-Prem.html). You can also contact the Volt MX Go Foundry administrator to request for an administrator account. ### For Volt MX Go Foundry installed as part of the installation on a development or test only environment diff --git a/docs/howto/importft.md b/docs/howto/importft.md index 40cef2a1..b1d5f522 100644 --- a/docs/howto/importft.md +++ b/docs/howto/importft.md @@ -6,7 +6,8 @@ Imports the First Touch Recipes app into Volt MX Go Iris so that you can try out ## Before you begin -- You have installed the First Touch app in Volt MX Go Foundry. For more information, see [First Touch tutorial](../tutorials/firsttouch.md). +- You have installed the First Touch app in Volt MX Go Foundry. For more information, see [First Touch tutorial](../tutorials/firsttouch.md). + - You have downloaded the First Touch Recipes project (*FirstTouchRecipe.zip*) from the HCL License & Download Portal. For more information, see [Download HCL Volt MX Go Release package](../tutorials/portaldownload.md). ## Procedure diff --git a/docs/howto/importvoltformula.md b/docs/howto/importvoltformula.md index 1c5295f7..66f9ef98 100644 --- a/docs/howto/importvoltformula.md +++ b/docs/howto/importvoltformula.md @@ -8,9 +8,11 @@ Guides you through the process of importing the **Domino app** and integrating t ## Before you begin -- You must complete the [Design Import tutorial](../tutorials/designimport.md) -- You need to have **actions** on your Domino view configuration -- You need to configure your Domino view as **Active** +- You must complete the [Design Import tutorial](../tutorials/designimport.md). + +- You need to have **actions** on your Domino view configuration. + +- You need to configure your Domino view as **Active**. ## Procedure diff --git a/docs/howto/insertattachments.md b/docs/howto/insertattachments.md index e8bdc02f..0e4c5552 100644 --- a/docs/howto/insertattachments.md +++ b/docs/howto/insertattachments.md @@ -7,6 +7,7 @@ Guides you on how to insert attachments via the [Summernote Editor](../reference ## Before you begin - You have [generated CRUD forms for Object Service](codegen.md). + - You have [built and published your app in Volt MX Go Iris](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_user_guide/Content/Cloud_Build_in_VoltMX_Iris.html#post-successful-build). !!!note "Important" diff --git a/docs/index.md b/docs/index.md index a9ee0d51..05760308 100644 --- a/docs/index.md +++ b/docs/index.md @@ -43,13 +43,13 @@ For the latest release information about Volt MX Go, see [What's new](references The Volt MX Go documentation is based on the [Diátaxis framework](https://diataxis.fr/), which organizes documentation into the following modes to address users' documentation needs at different times and in different circumstances. Below shows an overview that guides you on where to look for needed information: -**[Tutorials](tutorials/index.md)** - Hands-on introduction to Volt MX Go +[Tutorials](tutorials/index.md) - Hands-on introduction to Volt MX Go -**[How-to guides](howto/index.md)** - Practical step-by-step guides for performing tasks and operation +[How-to guides](howto/index.md) - Practical step-by-step guides for performing tasks and operation -**[Topic guides](topicguides/index.md)** - High-level discussion and explanation of key topics and concepts to give background information +[Topic guides](topicguides/index.md) - High-level discussion and explanation of key topics and concepts to give background information -**[References](references/index.md)** - Technical references and descriptions on using Volt MX Go +[References](references/index.md) - Technical references and descriptions on using Volt MX Go !!!tip For more information on using the Volt MX Go documentation, see [Guide to documentation](references/docguide.md). diff --git a/docs/references/knownlimitation.md b/docs/references/knownlimitation.md index d13d6125..600b94be 100644 --- a/docs/references/knownlimitation.md +++ b/docs/references/knownlimitation.md @@ -41,7 +41,7 @@ Disabling document deletion on the Domino DB if using it with an offline-enabled ## VoltFormula -Date APIs for Notes implementations return JavaScript Date Objects, which differ from Notes Date Objects. +- Date APIs for Notes implementations return JavaScript Date Objects, which differ from Notes Date Objects. -Prompt `[LocalBrowse]` and `[ChooseDatabase]` for Volt MX Go Iris application don't have a filter setting for file type since only [registered file types](https://www.iana.org/assignments/media-types/media-types.xhtml) are allowed in [voltmx.io.FileSystem](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_api_dev_guide/content/voltmx.io.filesystem_functions.html). +- Prompt `[LocalBrowse]` and `[ChooseDatabase]` for Volt MX Go Iris application don't have a filter setting for file type since only [registered file types](https://www.iana.org/assignments/media-types/media-types.xhtml) are allowed in [voltmx.io.FileSystem](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Iris/iris_api_dev_guide/content/voltmx.io.filesystem_functions.html). diff --git a/docs/references/whatsnew/v204.md b/docs/references/whatsnew/v204.md index c3c526a1..ba120cb6 100644 --- a/docs/references/whatsnew/v204.md +++ b/docs/references/whatsnew/v204.md @@ -5,7 +5,10 @@ ### Domino Adapter -- Added `Other Metadata` entity type that enables a user to access additional Domino information not included in Domino data documents. The `Other Metadata` entity type currently supports an endpoint for getting Domino user information. For more information, see [Other Metadata](../../topicguides/datamodel.md#other-metadata). +- Added `Other Metadata` entity type that enables a user to access additional Domino information not included in Domino data documents. The `Other Metadata` entity type currently supports an endpoint for getting Domino user information. + + For more information, see [Other Metadata](../../topicguides/datamodel.md#other-metadata). + - Added capability for checking duplicate fields when generating a data model from a Domino view, and returning an error message to warn a user that there are duplicate fields. ### VoltFormula diff --git a/docs/topicguides/datamodel.md b/docs/topicguides/datamodel.md index 042ff79e..86572791 100644 --- a/docs/topicguides/datamodel.md +++ b/docs/topicguides/datamodel.md @@ -12,7 +12,8 @@ In addition to some [Meta fields](#meta-fields), generated data models include: - **Form** data models include all fields defined by the associated Domino REST API `schema`. - **View** data models include all view columns defined in the NSF design. -- [Other Metadata](#other-metadata) data models include fields that pertain to the requested information. + +- [Other Metadata](#other-metadata) data models include fields that pertain to the requested information. Volt MX Go Foundry data models are in sync with the Domino REST API `schema` at the time of data model generation. The data models may be out of sync with the `schema`, which may lead to undesired or unexpected results, because of the following: diff --git a/docs/topicguides/designimportintro.md b/docs/topicguides/designimportintro.md index 0250b735..9124c28e 100644 --- a/docs/topicguides/designimportintro.md +++ b/docs/topicguides/designimportintro.md @@ -1,5 +1,7 @@ # Design Import +## Overview + This new feature in Volt MX Go Iris allows users to import all the **`.NSF`** data in accordance with the format provided by the Domino REST API. All the forms, views, and agents are imported into Volt MX Go Iris forms, along with the possibility of performing **CRUD** operations. When the project is put into production, you will have access to the `NSF` file, and you will be able to do the **CRUD** operations in each of the forms. **Notes Designer** and this information are in sync with one another. ## Objective diff --git a/docs/tutorials/adaptertutorial.md b/docs/tutorials/adaptertutorial.md index 36e20af9..9b16aa20 100644 --- a/docs/tutorials/adaptertutorial.md +++ b/docs/tutorials/adaptertutorial.md @@ -2,13 +2,14 @@ The tutorial guides you through the Domino Adapter process in Volt MX Go. You will create an app in Volt MX Go Foundry and connect the app to your Domino database as an endpoint via the Domino REST API. You will then configure a data model and test the methods, including standard CRUD operations, for interacting with the data model. -For more information, see [Data models](../topicguides/datamodel.md) and **[Methods](../topicguides/method.md). +For more information, see [Data models](../topicguides/datamodel.md) and [Methods](../topicguides/method.md). At the end of this tutorial, you can manually create an app in Volt MX Go Foundry and create an Identity Service and Object Service to connect your app to your Domino database via Domino REST API. ## Before you begin - You have completed the [Volt MX Go installation](installation.md). + - You have a [Volt MX Go Foundry admin account](../howto/foundryadminaccount.md). !!!tip @@ -21,6 +22,7 @@ At the end of this tutorial, you can manually create an app in Volt MX Go Foundr For more information, see [Access Levels in the ACL](https://help.hcltechsw.com/domino/14.0.0/admin/conf_accesslevelsintheacl_c.html) in the HCL Domino documentation or contact your Domino/Domino REST API administrator. - You have added a schema, activated the forms of the schema, and added a `dql` mode similar to the `default` mode to each activated form in Domino REST API. For more information, see [Schema Management](https://opensource.hcltechsw.com/Domino-rest-api/references/usingwebui/schemaui.html). + - You have added a scope for your schema in Domino REST API. For more information, see [Scope Management](https://opensource.hcltechsw.com/Domino-rest-api/references/usingwebui/scopeui.html). ## Log in to Volt MX Go Foundry @@ -68,7 +70,9 @@ At the end of this tutorial, you can manually create an app in Volt MX Go Foundr You need to **pause** the execution of the **Configure an Identity Service** procedure without saving your initial changes and complete the creation and configuration of an app in Domino REST API before proceeding. ??? "To create and configure an application in Domino REST API" + 1. Log in to Domino REST API. For more details, see [Access Domino REST API](../howto/accessdrapi.md). + 2. Select **Application Management - OAuth** from the home page. 3. On the **Application Management** page, click **Add Application**. 4. Under **Add New Application**, fill in the form: diff --git a/docs/tutorials/containerdeployment.md b/docs/tutorials/containerdeployment.md index b76926c2..85f1ae7f 100644 --- a/docs/tutorials/containerdeployment.md +++ b/docs/tutorials/containerdeployment.md @@ -16,27 +16,26 @@ Follow the order for completing the procedures according to your preferred deplo **When using K3s on an Ubuntu, RHEL, SLES machine or VM:** -1. [Obtain authentication token from HCL Container Repository](obtainauthenticationtoken.md) -1. [Install and configure K3s](k3sinstall.md) -2. [Complete preparatory procedure for installation of Volt MX Go](prereq.md) -3. [Install Domino REST API](downloadhelmchart.md) -4. [Install MySql for Volt MX Go Foundry](installmysqlfoundry.md) -5. [Install Volt MX Go Foundry](installfoundry.md) - +1. [Obtain authentication token from HCL Container Repository](obtainauthenticationtoken.md). +2. [Install and configure K3s](k3sinstall.md). +3. [Complete preparatory procedure for installation of Volt MX Go](prereq.md). +4. [Install Domino REST API](downloadhelmchart.md). +5. [Install MySql for Volt MX Go Foundry](installmysqlfoundry.md). +6. [Install Volt MX Go Foundry](installfoundry.md). **When using Rancher Desktop running on Windows:** -1. [Obtain authentication token from HCL Container Repository](obtainauthenticationtoken.md) -1. [Install Rancher Desktop](installrancher.md) -2. [Complete preparatory procedure for installation of Volt MX Go](prereq.md) -3. [Install Domino REST API](downloadhelmchart.md) -4. [Install MySql for Volt MX Go Foundry](installmysqlfoundry.md) -5. [Install Volt MX Go Foundry](installfoundry.md) +1. [Obtain authentication token from HCL Container Repository](obtainauthenticationtoken.md). +1. [Install Rancher Desktop](installrancher.md). +2. [Complete preparatory procedure for installation of Volt MX Go](prereq.md). +3. [Install Domino REST API](downloadhelmchart.md). +4. [Install MySql for Volt MX Go Foundry](installmysqlfoundry.md). +5. [Install Volt MX Go Foundry](installfoundry.md). ## For upgrading an existing installation of Volt MX Go -1. [Complete preparatory procedure for upgrading an existing installation of Volt MX Go](prereqnew.md) -2. [Upgrade Volt MX Go server components](versionupgrade1.md) +1. [Complete preparatory procedure for upgrading an existing installation of Volt MX Go](prereqnew.md). +2. [Upgrade Volt MX Go server components](versionupgrade1.md). ## For moving from early access version to GA version of Volt MX Go @@ -45,10 +44,10 @@ If you participated in the Early Access (EA) program, you need to perform the pr !!!note The Early Access release doesn't support actual upgrades. You must remove the prior release deployment and install a new deployment to upgrade. This removes all the data from the prior release deployment. -1. [Complete preparatory procedure for moving from early access version to GA version of Volt MX Go](eatogamove.md) -2. [Install Domino REST API](downloadhelmchart.md) -3. [Install MySql for Volt MX Go Foundry](installmysqlfoundry.md) -4. [Install Volt MX Go Foundry](installfoundry.md) +1. [Complete preparatory procedure for moving from early access version to GA version of Volt MX Go](eatogamove.md). +2. [Install Domino REST API](downloadhelmchart.md). +3. [Install MySql for Volt MX Go Foundry](installmysqlfoundry.md). +4. [Install Volt MX Go Foundry](installfoundry.md). ## Additional information diff --git a/docs/tutorials/deploykubernetes.md b/docs/tutorials/deploykubernetes.md index a98ee4bc..a5ef9189 100644 --- a/docs/tutorials/deploykubernetes.md +++ b/docs/tutorials/deploykubernetes.md @@ -5,6 +5,7 @@ Volt MX Go is deployable with Kubernetes via the following options: - using [K3s](https://docs.k3s.io) on an Ubuntu, RHEL, SLES machine or VM + - using [Rancher Desktop](https://docs.rancherdesktop.io) running on Windows To deploy Kubernetes, **perform only one procedure** from the list: diff --git a/docs/tutorials/designimport.md b/docs/tutorials/designimport.md index ad350486..f1f949d5 100644 --- a/docs/tutorials/designimport.md +++ b/docs/tutorials/designimport.md @@ -17,6 +17,7 @@ The tutorial implements two user experiences: ### For Volt MX Go Foundry admin - You must complete the [Volt MX Go installation](installfoundry.md). + - You must create a Volt MX Go Foundry admin account to the Volt MX Go Iris developer. ### For Domino REST API admin @@ -45,7 +46,8 @@ The tutorial implements two user experiences: ### For Volt MX Go Iris Developer -- You must install [Volt MX Go Iris](installiris.md) +- You must install [Volt MX Go Iris](installiris.md). + - You must have a Volt MX Go Foundry admin account. - You must have at least a **Designer role** to the Domino database `.nsf` that you are importing and to the **Domino Keep Configuration Database (`keepconfig.nsf`)**. - You must have your Domino REST API URL, Client ID, Client Secret and scope which comes from the Domino REST API admin. @@ -417,7 +419,7 @@ Once you click **Done**, each of the selected forms, views, and agents have impo 1. Select the file you want to upload. You can select more than one file to upload. !!!notes - To see the details of uploading size limit, see [HCL Notes and DOMINO file limits](https://help.hcltechsw.com/dom_designer/14.0.0/basic/H_NOTES_AND_DOMINO_KNOWN_LIMITS.html) + To see the details of uploading size limit, see [HCL Notes and DOMINO file limits](https://help.hcltechsw.com/dom_designer/14.0.0/basic/H_NOTES_AND_DOMINO_KNOWN_LIMITS.html). 2. Click **Open**. If the file is pre-existing, a dialog prompt will appear with the option to overwrite it. @@ -428,7 +430,7 @@ Once you click **Done**, each of the selected forms, views, and agents have impo ### Delete entry !!!note - - Before you delete any of the data, you must set **Formula for Delete Access** to `@True` in **default** and **dql** `mode` during your schema configuration. + Before you delete any of the data, you must set **Formula for Delete Access** to `@True` in **default** and **dql** `mode` during your schema configuration. 1. On the **Dashboard**, go to the **Views** section, click your preferred document -for example: AllCustomers_Leads. diff --git a/docs/tutorials/downloadhelmchart.md b/docs/tutorials/downloadhelmchart.md index d749e1a1..eaf722b4 100644 --- a/docs/tutorials/downloadhelmchart.md +++ b/docs/tutorials/downloadhelmchart.md @@ -51,6 +51,7 @@ The procedure guides you in downloading the Domino REST API Helm chart and deplo drapiDnsName: drapiManagementDnsName: ``` + Whatever hostnames you specify here and later in the Volt MX Go Foundry install, you need to ensure that the hostnames are resolvable. There is no additional work if you have already registered the hostnames in DNS. However, if you haven't registered them, you must add the hostnames to the server's /etc/hosts file as described in [Ensure Foundry Hostnames are resolvable](prereq.md#3-ensure-foundry-hostnames-are-resolvable), substituting your hostnames. Additionally, you must make the same updates in k3s's coredns config map as described in [For K3s only](prereq.md#for-k3s-only) again substituting your hostnames. !!!note @@ -84,7 +85,9 @@ The procedure guides you in downloading the Domino REST API Helm chart and deplo - `do-not-expose`: Set this value to prevent exposure of TCP port 1352 to the network. - `HostPort`: Set this value to use TCP port 1352 on your machine for the Notes client to communicate with Domino using the Notes Remote Procedure Call (NRPC) protocol. **This is only recommended when using Rancher Desktop for Kubernetes**. + - `NodePort`: Set this value if you want Kubernetes to allocate a random port in a specified range, by default 30000 to 32767, that's available on every worker node in the cluster. Kubernetes automatically routes traffic on this port from the Kubernetes node to the back-end Domino pod. **This is the recommended option if you want to expose NRPC to your Notes Clients when deploying into a non Rancher Desktop cluster**. See [Create a new server connection under Procedure](../howto/connectdominofromnotes.md#procedure) for instructions on how to obtain the random port number. + - `LoadBalancer`: Set this value if you want an external load balancer to be provisioned by a cloud provider which supports external load balancers. Traffic from the external load balancer is directed at the Domino pod, and the cloud provider decides how it is load balanced. Kubernetes typically starts off by making the changes that are equivalent to you requesting NodePort. The cloud-controller-manager component then configures the external load balancer to forward traffic to that assigned node port. You can read more about these options in the [Service](https://kubernetes.io/docs/concepts/services-networking/service/) topic in the Kubernetes documentation. @@ -127,6 +130,7 @@ The procedure guides you in downloading the Domino REST API Helm chart and deplo ## Additional information - To know how to manually update your Domino container if you obtain a new version of *FirstTouchRecipes.nsf*, see [Update FirstTouchRecipes.nsf](../howto/FTnsfupdate.md). + - To know more about Domino server processes within a Domino container, see [Interacting with Domino server process within Domino container](../topicguides/dominoserver.md). ## Next step diff --git a/docs/tutorials/firsttouch.md b/docs/tutorials/firsttouch.md index aece3df1..710b99ab 100644 --- a/docs/tutorials/firsttouch.md +++ b/docs/tutorials/firsttouch.md @@ -9,7 +9,9 @@ This tutorial guides you in accessing and running the First Touch Recipe Catalog **For Volt MX Go install to a production environment** - You have completed the [Volt MX Go installation in a production environment](prerequisite.md). + - You have created your [Volt MX Go Foundry admin account](../howto/foundryadminaccount.md). + - If using MySQL, make sure that the maximum allowed packet size is at least 16 MB. For more information, see **First Touch or Custom Application Fails to Install on Volt MX Go Foundry** issue in [Troubleshooting](../references/troubleshoot.md). +- An issue occurred with the SELECT conversion. ## Others diff --git a/docs/references/whatsnew/v203.md b/docs/references/whatsnew/v203.md index 6754e589..bbd1204a 100644 --- a/docs/references/whatsnew/v203.md +++ b/docs/references/whatsnew/v203.md @@ -5,7 +5,9 @@ ### Domino Adapter -- Added BULK UPDATE method that enables updating an existing collection of documents by replacing only the specified fields in those documents. For more information, see [Methods (Verbs)](../../topicguides/method.md). +- Added BULK UPDATE method that enables updating an existing collection of documents by replacing only the specified fields in those documents. + + For more information, see [Methods (Verbs)](../../topicguides/method.md). ### Design Import @@ -17,7 +19,10 @@ ### VoltFormula -- Implemented new APIs for the *text*, *date-time*, *formula*, *document*, *user-environment*, *logical*, and *information* categories. For more details, see the [Rosetta API reference documentation](../../javadoc/index.html). +- Implemented new APIs for the *text*, *date-time*, *formula*, *document*, *user-environment*, *logical*, and *information* categories. + + For more details, see the [Rosetta API reference documentation](../../javadoc/index.html). + - Implemented Notes math operators as callable APIs. - Added a new formula evaluation results tab panel that displays formula outputs. @@ -30,15 +35,23 @@ ### Domino Adapter -- Supports uploading and downloading of attachments up to 1 GB in size via Volt MX Go Foundry binary APIs. For more information, see [Attachments](../../topicguides/method.md#attachments). -- Summernote Editor, which is automatically applied on Rich Text fields of CREATE and UPDATE forms when generating CRUD forms for Object Service, now supports inserting attachments. For more information, see [Insert attachments via Summernote Editor](../../howto/insertattachments.md). +- Supports uploading and downloading of attachments up to 1 GB in size via Volt MX Go Foundry binary APIs. + + For more information, see [Attachments](../../topicguides/method.md#attachments). + +- Summernote Editor, which is automatically applied on Rich Text fields of CREATE and UPDATE forms when generating CRUD forms for Object Service, now supports inserting attachments. + + For more information, see [Insert attachments via Summernote Editor](../../howto/insertattachments.md). ### Design Import - Enhances user experience by providing more information related to the import process at different steps of the **Design Import Wizard**. - Supports Hierarchical View in imported Domino applications. - Improvements in Rich Text import introduced with Domino Adapter enhancements. -- Added an option in the **Design Import Wizard** for deleting existing forms. For more information, see [Delete existing forms while using the Design Import wizard](../../howto/deleteform.md). +- Added an option in the **Design Import Wizard** for deleting existing forms. + + For more information, see [Delete existing forms while using the Design Import wizard](../../howto/deleteform.md). + - Added a refresh feature in the **Design Import Wizard** to update the scope in case there are changes in the Domino REST API schema without exiting the wizard. ### VoltFormula @@ -63,7 +76,10 @@ #### Rosetta Converter - Implemented Formula to JavaScript conversion improvements in the areas of async usage, anonymous functions, parameter groupings, and variable definitions. -- Implemented improvements in the conversion handling definition rules for converting formula functions into native JavaScript versus API calls. For more information, see [VoltFormula options in the Volt MX Go Iris Project Settings](../../howto/configrosetta.md) dialog. +- Implemented improvements in the conversion handling definition rules for converting formula functions into native JavaScript versus API calls. + + For more information, see [VoltFormula options in the Volt MX Go Iris Project Settings](../../howto/configrosetta.md) dialog. + - Rosetta sample formulas are now part of the converters. - Supports passthrough setting in OpenFormula. - Supports OpenFormula parameter separator semicolon. @@ -131,21 +147,27 @@ ## Others - Updated [Compatibility matrix](../compatibilitymatrix.md). + - Updated [Summernote Editor](../summernotewidget.md) to include more information about its usage and how to configure its methods and properties. + - Updated [Install Rancher Desktop](../../tutorials/installrancher.md) to recommend installing the latest Rancher Desktop version and remove the port forwarding enabling procedure.  ### Domino Adapter -- Updated [Configure an Object service](../../tutorials/adaptertutorial.md#configure-an-object-service) procedure to include a step for completing the **Return documents from Bulk Update** text field, and added the [Test the BULK UPDATE method for updating a collection of records](../../tutorials/adaptertutorial.md#test-the-bulk-update-method-for-updating-a-collection-of-records) procedure in the [Domino Adapter tutorial](../../tutorials/adaptertutorial.md). +- Updated [Configure an Object service](../../tutorials/adaptertutorial.md#configure-an-object-service) procedure to include a step for completing the **Return documents from Bulk Update** text field. + +- Added the [Test the BULK UPDATE method for updating a collection of records](../../tutorials/adaptertutorial.md#test-the-bulk-update-method-for-updating-a-collection-of-records) procedure in the [Domino Adapter tutorial](../../tutorials/adaptertutorial.md). ### Design Import -- Updated the [Design Import tutorial](../../tutorials/designimport.md) to incorporate enhancements in the **Design Import Wizard**. +- Updated the [Design Import tutorial](../../tutorials/designimport.md) to incorporate enhancements in the **Design Import Wizard**. + - Updated [Troubleshooting](../troubleshoot.md) to include Domino REST API schema issues and resolutions related to validating forms and fields to be imported using **Design Import Wizard**. ### VoltFormula -- Updated the [Rosetta API reference documentation](../../javadoc/index.html). Documentation links use the latest Domino Design docs. +- Updated the [Rosetta API reference documentation](../../javadoc/index.html). Documentation links use the latest Domino Design docs. + - Added an **API Implementation Status Table** button on [Rosetta API reference documentation](../../javadoc/index.html) for tracking the implementation status of Notes and OpenFormula. ## VoltScript Early Access diff --git a/docs/references/whatsnew/v204.md b/docs/references/whatsnew/v204.md index ba120cb6..b31d7b85 100644 --- a/docs/references/whatsnew/v204.md +++ b/docs/references/whatsnew/v204.md @@ -29,7 +29,10 @@ #### Volt MX Go Iris -- Added a **Clear** button to the Formula Editor to enable a user to delete the shown formula, and a context menu option to delete a formula when right-clicking the formula in JavaScript code in the Formula Editor. For more information, see [Clear formulas in Controller and Action Editor](../../howto/clearfunction.md). +- Added a **Clear** button to the Formula Editor to enable a user to delete the shown formula, and a context menu option to delete a formula when right-clicking the formula in JavaScript code in the Formula Editor. + + For more information, see [Clear formulas in Controller and Action Editor](../../howto/clearfunction.md). + - Added support for overriding download site and plugin feature site URLs via environment variables. Contact [Customer Support](../index.md#support) for assistance. ## Improvements @@ -100,7 +103,11 @@ ### Domino Adapter -- Added details for handling offline objects for views. For more information, see the note in [Meta Fields](../../topicguides/datamodel.md#meta-fields). + +- Added details for handling offline objects for views. + + For more information, see the note in [Meta Fields](../../topicguides/datamodel.md#meta-fields). + ### VoltFormula diff --git a/docs/topicguides/declvariables.md b/docs/topicguides/declvariables.md index d59c2007..00d56b6e 100644 --- a/docs/topicguides/declvariables.md +++ b/docs/topicguides/declvariables.md @@ -5,6 +5,7 @@ There are two mechanisms by which the Rosetta Converter accepts and converts variables into JavasScript: - [LET function](https://support.microsoft.com/en-us/office/let-function-34842dd8-b92b-4d3f-b325-b8b8f9908999) in Excel[^1] + - JSP style syntax (code passthrough) [^1]: Excel is a registered trademark or trademark of Microsoft Corporation in the United States and/or other countries. diff --git a/docs/topicguides/dominoadapter.md b/docs/topicguides/dominoadapter.md index fd78b318..e0773bf7 100644 --- a/docs/topicguides/dominoadapter.md +++ b/docs/topicguides/dominoadapter.md @@ -14,7 +14,8 @@ When creating an Object service in Volt MX Go Foundry for Domino, the Volt MX Go The `object` of the Object service essentially has two components: -- [Data Model](datamodel.md) - refers to the definition of the fields that comprise the object definition -- [Methods](method.md) - verbs for interacting with the data, for example GET, POST +- [Data Model](datamodel.md) refers to the definition of the fields that comprise the object definition. + +- [Methods](method.md) refers verbs for interacting with the data, for example GET, POST. For more information, see [Object Services](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_user_guide/Content/Objectservices.html) in the HCL Volt MX documentation. diff --git a/docs/tutorials/containerdeployment.md b/docs/tutorials/containerdeployment.md index 85f1ae7f..b8e9a675 100644 --- a/docs/tutorials/containerdeployment.md +++ b/docs/tutorials/containerdeployment.md @@ -17,24 +17,35 @@ Follow the order for completing the procedures according to your preferred deplo **When using K3s on an Ubuntu, RHEL, SLES machine or VM:** 1. [Obtain authentication token from HCL Container Repository](obtainauthenticationtoken.md). + 2. [Install and configure K3s](k3sinstall.md). + 3. [Complete preparatory procedure for installation of Volt MX Go](prereq.md). + 4. [Install Domino REST API](downloadhelmchart.md). + 5. [Install MySql for Volt MX Go Foundry](installmysqlfoundry.md). + 6. [Install Volt MX Go Foundry](installfoundry.md). **When using Rancher Desktop running on Windows:** 1. [Obtain authentication token from HCL Container Repository](obtainauthenticationtoken.md). -1. [Install Rancher Desktop](installrancher.md). -2. [Complete preparatory procedure for installation of Volt MX Go](prereq.md). -3. [Install Domino REST API](downloadhelmchart.md). -4. [Install MySql for Volt MX Go Foundry](installmysqlfoundry.md). -5. [Install Volt MX Go Foundry](installfoundry.md). + +2. [Install Rancher Desktop](installrancher.md). + +3. [Complete preparatory procedure for installation of Volt MX Go](prereq.md). + +4. [Install Domino REST API](downloadhelmchart.md). + +5. [Install MySql for Volt MX Go Foundry](installmysqlfoundry.md). + +6. [Install Volt MX Go Foundry](installfoundry.md). ## For upgrading an existing installation of Volt MX Go 1. [Complete preparatory procedure for upgrading an existing installation of Volt MX Go](prereqnew.md). + 2. [Upgrade Volt MX Go server components](versionupgrade1.md). ## For moving from early access version to GA version of Volt MX Go @@ -45,8 +56,11 @@ If you participated in the Early Access (EA) program, you need to perform the pr The Early Access release doesn't support actual upgrades. You must remove the prior release deployment and install a new deployment to upgrade. This removes all the data from the prior release deployment. 1. [Complete preparatory procedure for moving from early access version to GA version of Volt MX Go](eatogamove.md). + 2. [Install Domino REST API](downloadhelmchart.md). + 3. [Install MySql for Volt MX Go Foundry](installmysqlfoundry.md). + 4. [Install Volt MX Go Foundry](installfoundry.md). ## Additional information diff --git a/docs/tutorials/designimport.md b/docs/tutorials/designimport.md index f1f949d5..d4a34d31 100644 --- a/docs/tutorials/designimport.md +++ b/docs/tutorials/designimport.md @@ -200,7 +200,7 @@ You can now see your project name in the upper-left corner of the **Volt MX Go I 6. On **Summary**, review the final `forms`, `fields` in each form, `views` and `agent`, and then click **Build Iris Application**. !!!note - - It may take a while to complete the publishing of the imported Domino app. + It may take a while to complete the publishing of the imported Domino app. ![Design Import Wizard dialog](../assets/images/disummary.png) diff --git a/docs/tutorials/installrancher.md b/docs/tutorials/installrancher.md index 6e557184..5ee3fc2f 100644 --- a/docs/tutorials/installrancher.md +++ b/docs/tutorials/installrancher.md @@ -35,7 +35,7 @@ Follow any instructions given by the WSL update process. Afterward, from a Windo wsl --set-default Ubuntu-22.04 ``` -Proceed [to install Rancher Desktop](#install-rancher-desktop). +Proceed to [install Rancher Desktop](#install-rancher-desktop). ### Install WSL2 diff --git a/docs/tutorials/portaldownload.md b/docs/tutorials/portaldownload.md index 1026a323..fc79fb65 100644 --- a/docs/tutorials/portaldownload.md +++ b/docs/tutorials/portaldownload.md @@ -35,4 +35,4 @@ Guides you on how to search and download the HCL Volt MX Go Release package from For a new installation, proceed to [Install Volt MX Go server components](nativeinstallers.md). -For an upgrade installation, proceed to [Upgrade Volt MX Go server components](versionupgrade.md) +For an upgrade installation, proceed to [Upgrade Volt MX Go server components](versionupgrade.md). diff --git a/docs/tutorials/prerequisite.md b/docs/tutorials/prerequisite.md index f6437e96..f771d7fe 100644 --- a/docs/tutorials/prerequisite.md +++ b/docs/tutorials/prerequisite.md @@ -5,11 +5,13 @@ Perform a new or an upgrade installation of Volt MX Go in a production environme For a new install, complete the following procedures: 1. [Download HCL Volt MX Go Release package](portaldownload.md) + 2. [Install Volt MX Go server components](nativeinstallers.md) For an upgrade install, complete the following procedures: 1. [Download HCL Volt MX Go Release package](portaldownload.md) + 2. [Upgrade Volt MX Go server components](versionupgrade.md) After completing the relevant procedures, proceed to [Install and upgrade Volt MX Go Iris](installiris.md). diff --git a/docs/tutorials/webinar.md b/docs/tutorials/webinar.md index c8e6e0d4..89aa767d 100644 --- a/docs/tutorials/webinar.md +++ b/docs/tutorials/webinar.md @@ -30,7 +30,7 @@ The webinar series includes the following webinars: ## Volt MX Go on HCL SoFy -Explore everything Volt MX Go can do in a free, hosted trial environment on [HCL SoFy](https://hclsofy.com/ "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"}. Your sandbox will be up and running in 10 minutes and provides access to a hosted Domino server (where you can copy or replicate your own Domino applications), the Domino REST API, Volt MX Go Foundry, and Volt MX Go Iris, a step-by-step wizard to connect Volt MX to Domino, Design Import, and VoltFormula. Check the following links for more information: +Explore everything Volt MX Go can do in a free, hosted trial environment on [HCL SoFy](https://hclsofy.com/ "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"} ![link image](../assets/images/external-link.svg){: style="height:15px;width:15px"}. Your sandbox will be up and running in 10 minutes and provides access to a hosted Domino server (where you can copy or replicate your own Domino applications), the Domino REST API, Volt MX Go Foundry, and Volt MX Go Iris, a step-by-step wizard to connect Volt MX to Domino, Design Import, and VoltFormula. Check the following links for more information: - [Overview of Volt MX Go](https://hclsofy.com/sofy/catalog/hcl-voltmxgo-small?view=doc&file=documentation.md "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"} ![link image](../assets/images/external-link.svg){: style="height:15px;width:15px"} - [Using Volt MX Go on Sofy](https://hclsofy.com/sofy/catalog/hcl-voltmxgo-small?view=doc&file=using-voltmxgo.md "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"} ![link image](../assets/images/external-link.svg){: style="height:15px;width:15px"} diff --git a/theme_overrides/partials/consent.html b/theme_overrides/partials/consent.html new file mode 100644 index 00000000..9ddb1df0 --- /dev/null +++ b/theme_overrides/partials/consent.html @@ -0,0 +1,30 @@ + +

Cookie consent

+

We use cookies to recognize your repeated visits and preferences, as well as to measure the effectiveness of our documentation and whether users find what they're searching for. With your consent, you're helping us to make our documentation better.

+ +
+
    +
  • +
    • +
  • +
    • + +
+
+
+ + + + +
+