Accessibility improvements

HCL-TECH-SOFTWARE · Jul 22, 2024 · 3355e74 · 3355e74
1 parent 8723a83
commit 3355e74
Show file tree

Hide file tree

Showing 30 changed files with 108 additions and 61 deletions.
diff --git 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;
+  }
+
 
-  
+
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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: