search

microsoft / react-component-toolkit

React Component Toolkit, a complete toolkit for creating React / Typescript Functional Components.
MIT License
11 stars 7 forks source link

.env.empty sample file - add documentation #3

Open danielkon96 opened 1 year ago

danielkon96 commented 1 year ago

Add additional documentation about the env.empty fields (or add comments about what each line refers to in the sample .env, adding comments will require testing to be sure nothing broke)

Update: Remove all OI and OP values as the toolkit only uses Azure Open AI

danielkon96 commented 1 year ago

Documentation is being added to official azure docs. We can include it in the readme somewhere as well documenting all the env variables

danielkon96 commented 1 year ago

Update: Azure Docs will not have documentation for the env variables so we will need to do the following.

TODO: 1) Change the env.empty file to contain the following fields:

APIM_OPENURL=
APIM_RESOURCEID=
AOI_ENDPOINT=
AOI_APIKEY=
AOI_DEPLOYMENT=
AOI_ENABLED=false
DEBUG_DIR=

2) Add the following documentation to the README for additional context about the env.empty file:

  • The following values are in your environment file (if you don't plan to use Azure OpenAI, you may leave those values blank):
    • APIM_OPENURL - APIM developer portal URL for widget development and testing (e.g. https://contoso.developer.azure-api.net/)
    • APIM_RESOURCEID - Azure API Management resource ID (e.g. subscriptions//resourceGroups//providers/Microsoft.ApiManagement/service/).
    • AOI_ENDPOINT - Azure OpenAI Endpoint (e.g. https://contoso.openai.azure.com/).
    • AOI_APIKEY - Azure OpenAI API Key.
    • AOI_DEPLOYMENT - Azure OpenAI Model Deployment Name (e.g. contoso-deployment).
    • AOI_ENABLED - Set to true if you plan generate components using Azure OpenAI.
    • DEBUG_DIR - The path where the prompt and the response from Azure OpenAI will be stored. The path is OS specific (e.g. Windows: C:\Users\contoso\Desktop\Debug, Linux/Mac: home\user\contoso\debug).

3) We may have to add one more field for tenant ID after the fix in APIM.