Skip to content

Commit 0238960

Browse files
committed
Documentation fixes
1 parent dc5cd03 commit 0238960

File tree

12 files changed

+13
-10
lines changed

12 files changed

+13
-10
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,9 @@ __pycache__/
5656
!clientApp/untrusted.png
5757
!/vbcs_oda_archives/vbcs_apps/vbcs-askdata/webApps/nl2sqlbot/resources/images/*
5858
!deployment-docs/docs/deployment/function/*
59+
!deployment-docs/docs/deployment/trust-api-gw/*
60+
!deployment-docs/docs/deployment/adw/*
61+
!deployment-docs/docs/deployment/oda/*
5962

6063
# Added images for documentation (redacted)
6164
!deployment-docs/docs/deployment/business_media/media/*
88.5 KB
Loading

deployment-docs/docs/deployment/adw_private_config.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -139,9 +139,7 @@ END;
139139
from
140140
<https://support.oracle.com/knowledge/Oracle%20Cloud/2950076_1.html>
141141

142-
![Create Workspace](../deployment/adw/image.png)
143-
144-
![Alt text](../deployment/adw/image-3.png)
142+
![Create Workspace](../deployment/adw/image-3.png)
145143

146144
```sql
147145
BEGIN

deployment-docs/docs/deployment/apex-trust.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This page assumes the following resources are configured:
1414

1515
### Step 2: Download the latest APEX app
1616

17-
[APEX App](../../../sql/apex/AskData_Trust.sql)
17+
[APEX App](../../../sql/apex/AskData_Trust_v3.2.sql)
1818

1919
### Step 2.1 Upload this latest export file here and click Next.
2020

@@ -119,7 +119,7 @@ If your application is not displaying, double check the following
119119
- Logout URL set correctly
120120
- Trust API working
121121

122-
If the APEX app stops working/lags after uploading a sample prompt file, try restarting the trust server.
122+
If the APEX app stops working/lags after uploading a sample prompt file, try refreshing the cache/browser; the session likely expired. If it still occurs try restarting the trust server.
123123
See [Trust Deployment](../deployment/trust-service.c.md#11-setup-the-nl2sql-service)
124124

125125
**NOTE** APEX does not support calling external APIs with self-signed certificates. If your Trust LB is using a self-signed cert, the APEX app will fail. For now we are using the API Gateway to get around this. This will fail with redirect errors when invoking the API Gateway/load balancer endpoint from APEX.

deployment-docs/docs/deployment/business_idcs.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,11 @@ Client type: Confidential
6666

6767
<br>
6868

69-
![ ](./business_media/media/config-conf-app.png)
69+
![Config](./business_media/media/config-conf-app.png)
7070

7171
Add the resource server (idcs server) as the resource
72-
![ ](./business_media/media/add-resource.png)
72+
73+
![Add Resource](./business_media/media/add-resource.png)
7374

7475
> **Note** If the resource server isn't appearing on the list, try submitting the configuration as is, editing the oauth config, and adding again.
7576

deployment-docs/docs/deployment/function.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,7 @@ We will use Cloud Shell for deploying functions
105105
1. Open Cloud Shell
106106

107107
![Cloud Shell](../deployment/function/cloud-shell.png)
108+
108109
![Cloud Shell](../deployment/function/cloud-shell-2.png)
109110

110111
2. Download Oracle function custom component code from code repository

deployment-docs/docs/deployment/information_sheet.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ As needed per components.
3434
|nl2sql_env value | nl2sql_env is a freeform tag used to be able to query all resources used in a single nl2sql deployment. ||
3535
|Trust Application Users | Need to gather the names and emails of the expert users to use the trust application. They need to be part of XXX group. The users need to receive an email telling them how to authenticate with the application in their environment.||
3636
| Business User Identity Integration| We need to define how the business users will have their identity serviced. ||
37-
| Customer Readyness |The customer requirement and information pertaining to this system needs to be defined and documented prior to any deployment.(Refer to customer facing configuration) ||
37+
| Customer Readiness |The customer requirement and information pertaining to this system needs to be defined and documented prior to any deployment.(Refer to customer facing configuration) ||
3838

3939
# Validation
4040

deployment-docs/docs/deployment/nl2sql_engine.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,13 @@ This section assumes the following resources are configured:
2424
>**Note** It can be helpful to use a VS Code extension like 'SSH - Remote' to connect to your instance in your private subnet. This assumes you have an ssh config entry in your local .ssh/config file such as below:
2525
2626
```
27-
Host a2c-askdata-dev2-host
27+
Host askdata-dev-host
2828
HostName <private-engine-host-ip>
2929
User opc
3030
IdentityFile <path-to-engine-key>
3131
ProxyJump askdata-dev-jump
3232
33-
Host a2c-askdata-dev
33+
Host askdata-dev-jump
3434
HostName <askdata-jump-public-ip>
3535
User opc
3636
IdentityFile <path-to-jump-host-key>
201 KB
Loading
421 KB
Loading

0 commit comments

Comments
 (0)