Skip to content

Commit

Permalink
Accessibility improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
zerlordsantiago committed Jul 23, 2024
1 parent 3355e74 commit 2b7903e
Show file tree
Hide file tree
Showing 16 changed files with 151 additions and 43 deletions.
29 changes: 27 additions & 2 deletions docs/assets/css/voltmxgo.css
Original file line number Diff line number Diff line change
Expand Up @@ -75,25 +75,49 @@ pre {
font-family:"HCLTech Roobert";
text-transform: capitalize;
font-size: medium;
color: #5b666d;
color:#000000
}
.md-typeset h6{
font-family:"HCLTech Roobert";
color: #000000;
}
tr.lostLinkItem:nth-child(even) {
background-color: #eeeeee;
}

/*
the following css is for increasing the font size and changing the font and font color of the copyright
the css includes making the color of the link white and changing the font weight and text decoration on hover
*/

.md-copyright {
font-family:"HCLTech Roobert";
font-size:medium;
font-size: 15px;
color: #FFFFFF;
}

.md-copyright a:link {
color: #FFFFFF;
}

.md-copyright a:hover {
font-weight: bold;
text-decoration: underline;
}

.md-copyright div a:link {
color: #FFFFFF;
}

.md-copyright div {
color: #FFFFFF;
}

.md-copyright div a:hover {
font-weight: bold;
text-decoration: underline;
}
/*
the following css is for increasing the font size of the admonition
*/
Expand Down Expand Up @@ -154,4 +178,5 @@ pre {
}




32 changes: 15 additions & 17 deletions docs/howto/drapiingress.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,37 +8,35 @@ Configures Kubernetes Ingress for Domino REST API. Ingress provides and manages

## Before you begin

Familiarize yourself with the various properties and parameters related to Kubernetes Ingress. Expand the following to learn more:
Familiarize yourself with the following properties and parameters related to Kubernetes Ingress.

???info "Kubernetes Ingress details"
- **ingress.enabled**: Set to `true` to enable Ingress. Ingress must be enabled for Domino REST API to function properly. Kindly note that there are certain conditions where you may want to temporarily disable Ingress.
- **ingress.enabled**: Set to `true` to enable Ingress. Ingress must be enabled for Domino REST API to function properly. Kindly note that there are certain conditions where you may want to temporarily disable Ingress.

- **ingress.className**: This property sets the class name on the Ingress object. The default is empty string, which enables the processing of Ingress objects by your cluster default Ingress controller. If your cluster does not have a default Ingress controller or if you want to override that, set the class name. Common values you might use include "nginx", "traefik", and "openshift-default". When utilizing Azure Application Gateway in AKS, specify "azure/application-gateway".
- **ingress.className**: This property sets the class name on the Ingress object. The default is empty string, which enables the processing of Ingress objects by your cluster default Ingress controller. If your cluster does not have a default Ingress controller or if you want to override that, set the class name. Common values you might use include "nginx", "traefik", and "openshift-default". When utilizing Azure Application Gateway in AKS, specify "azure/application-gateway".

- **ingress.drapiDnsName**: The DNS host name that users will use to access the Domino REST API. The default setting is `drapi.mymxgo.com`.
- **ingress.drapiDnsName**: The DNS host name that users will use to access the Domino REST API. The default setting is `drapi.mymxgo.com`.

- **ingress.drapiManagementDnsName**: The DNS host name that administrators will use to access the Domino REST API. The default setting is `drapi-management.mymxgo.com`.
- **ingress.drapiManagementDnsName**: The DNS host name that administrators will use to access the Domino REST API. The default setting is `drapi-management.mymxgo.com`.

- **ingress.protocol**: The communication protocol for accessing Volt MX Go Foundry. Its value can be either http or https. This should reflect the type of traffic you want the Ingress or Load Balancer to accept. *If `ingress.tls` is enabled, this setting must be https*.
- **ingress.protocol**: The communication protocol for accessing Volt MX Go Foundry. Its value can be either http or https. This should reflect the type of traffic you want the Ingress or Load Balancer to accept. *If `ingress.tls` is enabled, this setting must be https*.

- **ingress.tls**: Use this property to configure Ingress with either a Cluster or a Custom SSL certificate.
- **ingress.tls**: Use this property to configure Ingress with either a Cluster or a Custom SSL certificate.

- **ingress.tls.enabled**: Set to `true` to configure Ingress to use the Cluster SSL Certificate or the specified Custom SSL certificate.
- **ingress.tls.enabled**: Set to `true` to configure Ingress to use the Cluster SSL Certificate or the specified Custom SSL certificate.

- **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**: 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**: 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.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.
- **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.

## Additional information

Expand Down
2 changes: 1 addition & 1 deletion docs/references/whatsnew/v200.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ HCL Volt MX Go v2.0 allows you to extend the value of your Domino applications u
- *VoltFormula* for expanding who can code applications built in Domino and allowing app modernization without a complete code rewrite
- *Design Import* for importing existing Domino views, forms, and fields into Volt MX Go Foundry, giving you a head start on modernizing or creating new multi-experience applications in Volt MX Go Iris that are connected to your Domino back-end data and applications
- *Domino Adapter* and *Domino REST API* for connecting Volt MX Go Foundry to your Domino applications
- *First Touch* for guiding users in establishing connections and importing sample apps into Volt MX Go Foundry
- *First Touch* for guiding users in establishing connections and importing sample apps into Volt MX Go Foundry
6 changes: 6 additions & 0 deletions docs/references/whatsnew/v201.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ and User environment category on the Notes Formula.
- New default for API Context: `'all'`; for use by `GetField`/`SetField`
- `FileSave` enhancements
- Exposed Volt MX-specific functions in API.

- Updates to [API Reference Documentation](../../javadoc/index.html)


Expand Down Expand Up @@ -74,15 +75,20 @@ and User environment category on the Notes Formula.
## Others

- Added details related to kubectl commands failing in [Troubleshooting](../troubleshoot.md).

- Added details related to using helm charts on supported Kubernetes platform in [Known limitations](../knownlimitation.md).

- Added upgrade procedures in [Installation and upgrade](../../tutorials/installation.md).

### First Touch

- Added procedure for [importing First Touch into Volt MX Go Iris](../../howto/importft.md).

### Domino Adapter
- Added procedure for [generating CRUD forms for an Object Service](../../howto/codegen.md).

- Added details related to deleting offline documents in [Known limitations](../knownlimitation.md).

- Added known limitation related to deleting offline documents.

## VoltScript Early Access
Expand Down
4 changes: 3 additions & 1 deletion docs/references/whatsnew/v202.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,13 @@
### VoltFormula

- Added feature to [register and unregister custom Rosetta APIs](../../howto/regunregconfig.md).

- Displays filename of custom formula extension in VoltFormula settings.

## 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) 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
Expand Down Expand Up @@ -63,7 +65,7 @@

- Issues occurred with date-time conversion parameters when using the `@Explode` formula function. 
- The `=` sign was removed during OpenFormula conversion. 
- An issue occurred with the SELECT conversion. <!--by addressing the statements or category before and after.-->
- An issue occurred with the SELECT conversion.

## Others

Expand Down
40 changes: 31 additions & 9 deletions docs/references/whatsnew/v203.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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.

Expand All @@ -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
Expand All @@ -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.
Expand Down Expand Up @@ -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
Expand Down
Loading

0 comments on commit 2b7903e

Please sign in to comment.