Skip to content

Commit

Permalink
Update setup instructions in README and module files
Browse files Browse the repository at this point in the history
  • Loading branch information
manodyaSenevirathne committed Aug 7, 2024
1 parent 66e7232 commit 3cb62ff
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 9 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,16 @@ To use the OpenAI Connector, you must have access to the OpenAI API through a [O


2. Navigate to **Dashboard** -> **API keys**.
<img src=/docs/setup/resources/api-key-dashboard.png alt="OpenAI Dashbaord | API keys" style="width: 70%;">
<img src=/docs/setup/resources/navigate-api-key-dashboard.png alt="Navigate to API key section" style="width: 70%;">

3. Click on the **Create new secret key** button.
<img src=/docs/setup/resources/create-new-secrete-key.png alt="Create New API key" style="width: 70%;">
<img src=/docs/setup/resources/api-key-dashboard.png alt="OpenAI Dashbaord | API keys" style="width: 70%;">

4. Fill the details and click on Create secret key.
<img src=/docs/setup/resources/saved-key.png alt="Generated New API key" style="width: 70%;">
<img src=/docs/setup/resources/create-new-secrete-key.png alt="Create New API key" style="width: 70%;">

5. Store the API key securely to use in your application.
<img src=/docs/setup/resources/saved-key.png alt="Generated New API key" style="width: 70%;">


## Quickstart
Expand Down
8 changes: 6 additions & 2 deletions ballerina/Module.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,16 @@ To use the OpenAI Connector, you must have access to the OpenAI API through a [O


2. Navigate to **Dashboard** -> **API keys**.
<img src=/docs/setup/resources/api-key-dashboard.png alt="OpenAI Dashbaord | API keys" style="width: 70%;">
<img src=/docs/setup/resources/navigate-api-key-dashboard.png alt="Navigate to API key section" style="width: 70%;">

3. Click on the **Create new secret key** button.
<img src=/docs/setup/resources/create-new-secrete-key.png alt="Create New API key" style="width: 70%;">
<img src=/docs/setup/resources/api-key-dashboard.png alt="OpenAI Dashbaord | API keys" style="width: 70%;">

4. Fill the details and click on Create secret key.
<img src=/docs/setup/resources/create-new-secrete-key.png alt="Create New API key" style="width: 70%;">

5. Store the API key securely to use in your application.
<img src=/docs/setup/resources/saved-key.png alt="Generated New API key" style="width: 70%;">on Create secret key.
<img src=/docs/setup/resources/saved-key.png alt="Generated New API key" style="width: 70%;">

5. Store the API key securely to use in your application.
Expand Down
8 changes: 4 additions & 4 deletions ballerina/Package.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,16 @@ To use the OpenAI Connector, you must have access to the OpenAI API through a [O


2. Navigate to **Dashboard** -> **API keys**.
<img src=/docs/setup/resources/api-key-dashboard.png alt="OpenAI Dashbaord | API keys" style="width: 70%;">
<img src=/docs/setup/resources/navigate-api-key-dashboard.png alt="Navigate to API key section" style="width: 70%;">

3. Click on the **Create new secret key** button.
<img src=/docs/setup/resources/create-new-secrete-key.png alt="Create New API key" style="width: 70%;">
<img src=/docs/setup/resources/api-key-dashboard.png alt="OpenAI Dashbaord | API keys" style="width: 70%;">

4. Fill the details and click on Create secret key.
<img src=/docs/setup/resources/saved-key.png alt="Generated New API key" style="width: 70%;">
<img src=/docs/setup/resources/create-new-secrete-key.png alt="Create New API key" style="width: 70%;">

5. Store the API key securely to use in your application.

<img src=/docs/setup/resources/saved-key.png alt="Generated New API key" style="width: 70%;">

## Quickstart

Expand Down

0 comments on commit 3cb62ff

Please sign in to comment.