Skip to content

Commit 3b123e5

Browse files
Roopan-MicrosoftRoopan-Microsoft
authored
Merge pull request #309 from microsoft/psl-add-release
docs: Added release and missed image file and path in all the docs
2 parents e846e1e + 4579a2b commit 3b123e5

22 files changed

+132
-5
lines changed

‎.github/workflows/create-release.yml‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
on:
2+
push:
3+
branches:
4+
- main
5+
6+
permissions:
7+
contents: write
8+
pull-requests: write
9+
10+
name: Create-Release
11+
12+
jobs:
13+
create-release:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- name: Checkout
17+
uses: actions/checkout@v4
18+
with:
19+
ref: ${{ github.event.workflow_run.head_sha }}
20+
21+
- uses: codfish/semantic-release-action@v3
22+
id: semantic
23+
with:
24+
tag-format: 'v${version}'
25+
additional-packages: |
26+
['conventional-changelog-conventionalcommits@7']
27+
plugins: |
28+
[
29+
[
30+
"@semantic-release/commit-analyzer",
31+
{
32+
"preset": "conventionalcommits"
33+
}
34+
],
35+
[
36+
"@semantic-release/release-notes-generator",
37+
{
38+
"preset": "conventionalcommits",
39+
"presetConfig": {
40+
"types": [
41+
{ type: 'feat', section: 'Features', hidden: false },
42+
{ type: 'fix', section: 'Bug Fixes', hidden: false },
43+
{ type: 'perf', section: 'Performance Improvements', hidden: false },
44+
{ type: 'revert', section: 'Reverts', hidden: false },
45+
{ type: 'docs', section: 'Other Updates', hidden: false },
46+
{ type: 'style', section: 'Other Updates', hidden: false },
47+
{ type: 'chore', section: 'Other Updates', hidden: false },
48+
{ type: 'refactor', section: 'Other Updates', hidden: false },
49+
{ type: 'test', section: 'Other Updates', hidden: false },
50+
{ type: 'build', section: 'Other Updates', hidden: false },
51+
{ type: 'ci', section: 'Other Updates', hidden: false }
52+
]
53+
}
54+
}
55+
],
56+
'@semantic-release/github'
57+
]
58+
env:
59+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
60+
- run: echo ${{ steps.semantic.outputs.release-version }}
61+
62+
- run: echo "$OUTPUTS"
63+
env:
64+
OUTPUTS: ${{ toJson(steps.semantic.outputs) }}

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ When you start the deployment, most parameters will have **default values**, but
7575
|------------|----------------| ------------|
7676
| **Azure Region** | The region where resources will be created. | eastus |
7777
| **Environment Name** | A **3-20 character alphanumeric value** used to generate a unique ID to prefix the resources. | byctemplate |
78-
| **Secondary Location** | A **less busy** region for **Azure SQL and CosmosDB**, useful in case of availability constraints. | eastus2 |
78+
| **Secondary Location** | A **less busy** region for **CosmosDB**, useful in case of availability constraints. | eastus2 |
7979
| **Deployment Type** | Select from a drop-down list. | Global Standard |
8080
| **GPT Model** | Choose from **gpt-4, gpt-4o** | gpt-4o |
8181
| **GPT Model Deployment Capacity** | Configure capacity for **GPT models**. | 30k |

‎docs/AppAuthentication.md‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
## Add Authentication in Azure App Service configuration
2+
1. Click on `Authentication` from left menu.
3+
4+
![Authentication](images/AppAuthentication.png)
5+
6+
2. Click on `+ Add Provider` to see a list of identity providers.
7+
8+
![Authentication Identity](images/AppAuthenticationIdentity.png)
9+
10+
3. Click on `+ Add Provider` to see a list of identity providers.
11+
12+
![Add Provider](images/AppAuthIdentityProvider.png)
13+
14+
4. Select the first option `Microsoft Entra Id` from the drop-down list.
15+
16+
![Add Provider](images/AppAuthIdentityProviderAdd.png)
17+
18+
5. Accept the default values and click on `Add` button to go back to the previous page with the identity provider added.
19+
20+
![Add Provider](images/AppAuthIdentityProviderAdded.png)
21+
22+
### Creating a new App Registration
23+
1. Click on `Home` and select `Microsoft Entra ID`.
24+
25+
![Microsoft Entra ID](images/MicrosoftEntraID.png)
26+
27+
2. Click on `App registrations`.
28+
29+
![App registrations](images/Appregistrations.png)
30+
31+
3. Click on `+ New registration`.
32+
33+
![New Registrations](images/NewRegistration.png)
34+
35+
4. Provide the `Name`, select supported account types as `Accounts in this organizational directory only(Contoso only - Single tenant)`, select platform as `Web`, enter/select the `URL` and register.
36+
37+
![Add Details](images/AddDetails.png)
38+
39+
5. After application is created sucessfully, then click on `Add a Redirect URL`.
40+
41+
![Redirect URL](images/AddRedirectURL.png)
42+
43+
6. Click on `+ Add a platform`.
44+
45+
![+ Add platform](images/AddPlatform.png)
46+
47+
7. Click on `Web`.
48+
49+
![Web](images/Web.png)
50+
51+
8. Enter the `web app URL` (Provide the app service name in place of XXXX) and Save. Then go back to [Step 4] and follow from _Point 4_ choose `Pick an existing app registration in this directory` from the Add an Identity Provider page and provide the newly registered App Name.
52+
53+
![Add Details](images/WebAppURL.png)

‎docs/AzureGPTQuotaSettings.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
## How to Check & Update Quota
2+
3+
1. **Navigate** to the [Azure AI Foundry portal](https://ai.azure.com/).
4+
2. **Select** the AI Project associated with this accelerator.
5+
3. **Go to** the `Management Center` from the bottom-left navigation menu.
6+
4. Select `Quota`
7+
- Click on the `GlobalStandard` dropdown.
8+
- Select the required **GPT model** (`GPT-4, GPT-4o`) or **Embeddings model** (`text-embedding-ada-002`).
9+
- Choose the **region** where the deployment is hosted.
10+
5. Request More Quota or delete any unused model deployments as needed.

‎docs/DeleteResourceGroup.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,17 @@ If your deployment fails and you need to clean up the resources manually, follow
1414
1. In the search bar at the top, type **"Resource groups"** and select it.
1515
2. Locate the **resource group** associated with the failed deployment.
1616

17-
![Resource Groups](Images/resourcegroup.png)
17+
![Resource Groups](images/resourcegroup.png)
1818

19-
![Resource Groups](Images/resource-groups.png)
19+
![Resource Groups](images/resource-groups.png)
2020

2121
---
2222

2323
## **3. Delete the Resource Group**
2424
1. Click on the **resource group name** to open it.
2525
2. Click the **Delete resource group** button at the top.
2626

27-
![Delete Resource Group](Images/DeleteRG.png)
27+
![Delete Resource Group](images/DeleteRG.png)
2828

2929
3. Type the resource group name in the confirmation box and click **Delete**.
3030

@@ -40,7 +40,7 @@ If you don’t want to delete the entire resource group, follow these steps:
4040
3. Select the **resource** you want to delete (e.g., App Service, Storage Account).
4141
4. Click **Delete** at the top.
4242

43-
![Delete Individual Resource](Images/deleteservices.png)
43+
![Delete Individual Resource](images/deleteservices.png)
4444

4545
---
4646

‎docs/images/AddDetails.png‎

350 KB
Loading

‎docs/images/AddPlatform.png‎

194 KB
Loading

‎docs/images/AddRedirectURL.png‎

41.6 KB
Loading

‎docs/images/AppAuthIdentityProvider.png‎

48 KB
Loading

‎docs/images/AppAuthIdentityProviderAdd.png‎

72.4 KB
Loading

0 commit comments

Comments
 (0)