Add a quip about branches to doc, correct comments in appsettings and… (

#656) ### Motivation and Context Be clear. ### Description - Add a quip about branches to main README - Correct comments in appsettings to reference KernelMemory - Change text when we load website so that it is less odd ### Contribution Checklist - [ ] The code builds clean without any errors or warnings - [ ] The PR follows the [Contribution Guidelines](https://github.com/microsoft/chat-copilot/blob/main/CONTRIBUTING.md) and the [pre-submission formatting script](https://github.com/microsoft/chat-copilot/blob/main/CONTRIBUTING.md#development-scripts) raises no violations - [ ] All unit tests pass, and I have added new tests where possible - [ ] I didn't break anyone 😄 --------- Co-authored-by: Gina Triolo <51341242+gitri-ms@users.noreply.github.com>
microsoft · Nov 27, 2023 · b3146d2 · b3146d2
1 parent 0cf4dce
commit b3146d2
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 16 deletions.
diff --git a/README.md b/README.md
@@ -329,6 +329,12 @@ By default, Chat Copilot runs locally without authentication, using a guest user
    sudo apt install --assume-yes dotnet-sdk-7.0;
    ```
 
+# A note on branches
+
+Every release is associated with a release branch. For instance, release [v0.9](https://github.com/microsoft/chat-copilot/releases/tag/v0.9) is on a branch called [0.9](https://github.com/microsoft/chat-copilot/tree/0.9).
+Once a release is out, its branch will no longer be updated. The exception to this is the latest release branch, which will only receive bug fixes.
+This is to provide some stability to those for whom breaking changes and being on the bleeding edge (with the bugs it can entail) is not a desirable option.
+
 # Check out our other repos!
 
 If you would like to learn more about Semantic Kernel and AI, you may also be interested in other repos the Semantic Kernel team supports:

diff --git a/webapi/appsettings.json b/webapi/appsettings.json
@@ -243,7 +243,7 @@
     },
     //
     // Configuration for the various services used by kernel memory and semantic kernel.
-    // Section names correspond to type specified in SemanticMemory section.  All supported
+    // Section names correspond to type specified in KernelMemory section.  All supported
     // sections are listed below for reference.  Only referenced sections are required.
     //
     "Services": {
@@ -280,7 +280,7 @@
       //
       "AzureBlobs": {
         "Auth": "ConnectionString",
-        //"ConnectionString": "", // dotnet user-secrets set "SemanticMemory:Services:AzureBlobs:ConnectionString" "MY_AZUREBLOB_CONNECTIONSTRING"
+        //"ConnectionString": "", // dotnet user-secrets set "KernelMemory:Services:AzureBlobs:ConnectionString" "MY_AZUREBLOB_CONNECTIONSTRING"
         //"Account": "",
         "Container": "memorypipeline"
         //"EndpointSuffix": "core.windows.net"
@@ -294,7 +294,7 @@
       //
       "AzureQueue": {
         "Auth": "ConnectionString"
-        //"ConnectionString": "", // dotnet user-secrets set "SemanticMemory:Services:AzureQueue:ConnectionString" "MY_AZUREQUEUE_CONNECTIONSTRING"
+        //"ConnectionString": "", // dotnet user-secrets set "KernelMemory:Services:AzureQueue:ConnectionString" "MY_AZUREQUEUE_CONNECTIONSTRING"
         //"Account": "",
         //"EndpointSuffix": "core.windows.net"
       },
@@ -306,8 +306,8 @@
       // - Port is the RabbitMq service port.
       //
       "RabbitMq": {
-        //"Username": "user", // dotnet user-secrets set "SemanticMemory:Services:RabbitMq:Username" "MY_RABBITMQ_USER"
-        //"Password": "", // dotnet user-secrets set "SemanticMemory:Services:RabbitMq:Password" "MY_RABBITMQ_KEY"
+        //"Username": "user", // dotnet user-secrets set "KernelMemory:Services:RabbitMq:Username" "MY_RABBITMQ_USER"
+        //"Password": "", // dotnet user-secrets set "KernelMemory:Services:RabbitMq:Password" "MY_RABBITMQ_KEY"
         "Host": "127.0.0.1",
         "Port": "5672"
       },
@@ -319,7 +319,7 @@
       //
       "AzureCognitiveSearch": {
         "Auth": "ApiKey",
-        //"APIKey": "", // dotnet user-secrets set "SemanticMemory:Services:AzureCognitiveSearch:APIKey" "MY_ACS_KEY"
+        //"APIKey": "", // dotnet user-secrets set "KernelMemory:Services:AzureCognitiveSearch:APIKey" "MY_ACS_KEY"
         "Endpoint": ""
       },
       //
@@ -328,7 +328,7 @@
       // - Endpoint is the service endpoint url.
       //
       "Qdrant": {
-        //"APIKey": "", // dotnet user-secrets set "SemanticMemory:Services:Qdrant:APIKey" "MY_QDRANT_KEY"
+        //"APIKey": "", // dotnet user-secrets set "KernelMemory:Services:Qdrant:APIKey" "MY_QDRANT_KEY"
         "Endpoint": "http://127.0.0.1:6333"
       },
       //
@@ -342,7 +342,7 @@
       //
       "AzureOpenAIText": {
         "Auth": "ApiKey",
-        // "APIKey": "", // dotnet user-secrets set "SemanticMemory:Services:AzureOpenAIText:APIKey" "MY_AZUREOPENAI_KEY"
+        // "APIKey": "", // dotnet user-secrets set "KernelMemory:Services:AzureOpenAIText:APIKey" "MY_AZUREOPENAI_KEY"
         "Endpoint": "",
         "Deployment": "gpt-35-turbo",
         "APIType": "ChatCompletion",
@@ -357,7 +357,7 @@
       //
       "AzureOpenAIEmbedding": {
         "Auth": "ApiKey",
-        // "APIKey": "", // dotnet user-secrets set "SemanticMemory:Services:AzureOpenAIEmbedding:APIKey" "MY_AZUREOPENAI_KEY"
+        // "APIKey": "", // dotnet user-secrets set "KernelMemory:Services:AzureOpenAIEmbedding:APIKey" "MY_AZUREOPENAI_KEY"
         "Endpoint": "",
         "Deployment": "text-embedding-ada-002"
       },
@@ -372,7 +372,7 @@
       "OpenAI": {
         "TextModel": "gpt-3.5-turbo",
         "EmbeddingModel": "text-embedding-ada-002",
-        //"APIKey": "", // dotnet user-secrets set "SemanticMemory:Services:OpenAI:APIKey" "MY_OPENAI_KEY"
+        //"APIKey": "", // dotnet user-secrets set "KernelMemory:Services:OpenAI:APIKey" "MY_OPENAI_KEY"
         "OrgId": "",
         "MaxRetries": 10
       },
@@ -384,7 +384,7 @@
       //
       "AzureFormRecognizer": {
         "Auth": "APIKey",
-        //"APIKey": "", // dotnet user-secrets set "SemanticMemory:Services:AzureFormRecognizer:APIKey" "MY_AZUREFORMRECOGNIZER_KEY"
+        //"APIKey": "", // dotnet user-secrets set "KernelMemory:Services:AzureFormRecognizer:APIKey" "MY_AZUREFORMRECOGNIZER_KEY"
         "Endpoint": ""
       },
       //

diff --git a/webapp/src/components/views/BackendProbe.tsx b/webapp/src/components/views/BackendProbe.tsx
@@ -84,15 +84,13 @@ export const BackendProbe: FC<IData> = ({ onBackendFound }) => {
                 </div>
             ) : (
                 <div className={classes.informativeView}>
-                    <Title3>Looking for your backend</Title3>
+                    <Title3>Connecting...</Title3>
                     <Spinner />
                     <Body1>
-                        This sample expects to find a Semantic Kernel service from <strong>webapi/</strong> running at{' '}
-                        <strong>{BackendServiceUrl}</strong>
+                        This app expects to find a server running at <strong>{BackendServiceUrl}</strong>
                     </Body1>
                     <Body1>
-                        Run your Semantic Kernel service locally using Visual Studio, Visual Studio Code or by typing
-                        the following command:{' '}
+                        To run the server locally, use Visual Studio, Visual Studio Code, or type the following command:{' '}
                         <code>
                             <strong>dotnet run</strong>
                         </code>