chore: docs review #46
Conversation
charts/dial-core/README.md
Outdated
There was a problem hiding this comment.
This file automatically generated by helm-docs. Don't edit it manually
charts/dial-extension/README.md
Outdated
There was a problem hiding this comment.
This file automatically generated by helm-docs. Don't edit it manually
charts/dial/README.md
Outdated
There was a problem hiding this comment.
This file automatically generated by helm-docs. Don't edit it manually
| If you had already added this repo earlier, run `helm repo update` to retrieve the latest versions of the packages. You can then run `helm search repo dial` to see the charts. | ||
| If you had already added this repo earlier, run `helm repo update` to retrieve the latest versions of the packages. | ||
|
|
||
| You can then run `helm search repo dial` to see the charts. |
There was a problem hiding this comment.
If we have section Charts we should move this string to it
| @@ -3,9 +3,10 @@ | |||
| - [AI DIAL AKS Installation Simple Guide](#ai-dial-aks-installation-simple-guide) | |||
| - [Prerequisites](#prerequisites) | |||
| - [Expected Outcome](#expected-outcome) | |||
| - [What's next?](#whats-next) | |||
There was a problem hiding this comment.
This section is for additional application configuration. It seems odd to place it above the installation section.
| @@ -22,10 +23,30 @@ | |||
|
|
|||
| ## Expected Outcome | |||
|
|
|||
| By following the instructions in this guide, you will successfully install the AI DIAL system with configured connection to the Azure GPT-3.5 API.\ | |||
| **Important Warning** | |||
There was a problem hiding this comment.
This is internal documentation in GitHub. Therefore, let's use GitHub syntax here. > [!WARNING]
| @@ -3,9 +3,10 @@ | |||
| - [AI DIAL GCP Installation Simple Guide](#ai-dial-gcp-installation-simple-guide) | |||
| - [Prerequisites](#prerequisites) | |||
| - [Expected Outcome](#expected-outcome) | |||
| - [What's next?](#whats-next) | |||
There was a problem hiding this comment.
This section is for additional application configuration. It seems odd to place it above the installation section.
| @@ -22,10 +23,30 @@ | |||
|
|
|||
| ## Expected Outcome | |||
|
|
|||
| By following the instructions in this guide, you will successfully install the AI DIAL system with configured connection to the VertexAI API.\ | |||
| **Important Warning** | |||
There was a problem hiding this comment.
This is internal documentation in GitHub. Therefore, let's use GitHub syntax here. > [!WARNING]
| @@ -20,14 +21,35 @@ | |||
|
|
|||
| ## Expected Outcome | |||
|
|
|||
| By following the instructions in this guide, you will successfully install the AI DIAL system with configured connection to the Azure GPT-3.5 API.\ | |||
| **Important Warning** | |||
There was a problem hiding this comment.
This is internal documentation in GitHub. Therefore, let's use GitHub syntax here. > [!WARNING]
| @@ -3,9 +3,10 @@ | |||
| - [AI DIAL Generic Installation Simple Guide](#ai-dial-generic-installation-simple-guide) | |||
| - [Prerequisites](#prerequisites) | |||
| - [Expected Outcome](#expected-outcome) | |||
| - [What's next?](#whats-next) | |||
There was a problem hiding this comment.
This section is for additional application configuration. It seems odd to place it above the installation section.
…to charts/dial/examples/generic/simple/img/generic-simple-schema.png
Description of changes
Review of README docs
Checklist
Chart.yamlaccording to semverappVersionbumped inChart.yamlif it'sdialchart and any application version changedvalues.yamland added to theREADME.mdusing helm-docsBy submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.