Skip to content

Commit 3ce42a7

Browse files
Minor content/text updates
1 parent 0a408ef commit 3ce42a7

File tree

4 files changed

+22
-24
lines changed

4 files changed

+22
-24
lines changed

articles/static-web-apps/apis.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,7 @@ Azure Static Web Apps provides serverless API endpoints via [Azure Functions](..
2020

2121
## Configuration
2222

23-
API endpoints are available to the web app through the _api_ route. While this route is fixed, you have control over the folder where you locate the associated Azure Functions app. You can change this location by editing the workflow YAML file located in your repository's _.github/workflows_ folder.
24-
25-
Set the the following location's value to the desired folder location for the API app in your repository.
26-
27-
```schema
28-
jobs
29-
└── steps
30-
└── with
31-
└── api_location
32-
```
23+
API endpoints are available to the web app through the _api_ route. While this route is fixed, you have control over the folder where you locate the associated Azure Functions app. You can change this location by [editing the workflow YAML file](github-actions-workflow.md#build-and-deploy) located in your repository's _.github/workflows_ folder.
3324

3425
## Constraints
3526

@@ -38,6 +29,7 @@ Azure Static Web Apps provides an API through Azure Functions. The capabilities
3829
- The API route prefix is must be _api_.
3930
- Triggers and bindings are limited to [HTTP](../azure-functions/functions-bindings-http-webhook.md).
4031
- All other [Azure Functions triggers and bindings](../azure-functions/functions-triggers-bindings.md#supported-bindings) except for output bindings are restricted.
32+
- Logs are only available if you add [Application Insights](../azure-functions/functions-monitoring.md) to your Functions app.
4133

4234
## Next steps
4335

articles/static-web-apps/github-actions-workflow.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ The `repo_token`, `action`, and `azure_static_web_apps_api_token` values are set
139139

140140
## Customizations
141141

142-
There are few additional configuration settings available that are not generated in the workflow file by default.
142+
There are few additional configuration settings available that are not generated in the workflow file by default. The following customizations can be defined under a job's `with` section.
143143

144144
### Custom build commands
145145

@@ -149,7 +149,7 @@ The deployment always calls `npm install` before any custom command.
149149

150150
| Command | Description |
151151
|---------------------|-------------|
152-
| `app_build_command` | Defines a custom command to run during deployment of the static content application.<br><br>For example, to configure a production build for an Angular application enter `ng build -prod`. |
152+
| `app_build_command` | Defines a custom command to run during deployment of the static content application.<br><br>For example, to configure a production build for an Angular application enter `ng build -prod`. If left blank, the workflow tries to run the `build` or `build:Azure` commands. |
153153
| `api_build_command` | Defines a custom command to run during deployment of the Azure Functions API application. |
154154

155155
### Route file location

articles/static-web-apps/review-publish-pull-requests.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,19 +13,22 @@ ms.author: yolasors
1313

1414
This article demonstrates how to use pre-production environments to review changes to applications deployed with [Azure Static Web Apps](overview.md).
1515

16-
17-
A pre-production (staging) environment is a fully-functional staged version of your application that includes changes not available in production.
16+
A pre-production (staging) environment is a fully-functional staged version of your application that includes changes not available in production.
1817

1918
Azure Static Web Apps generates a GitHub Actions workflow in the repository. When a a pull request is created against a branch that the workflow watches, the pre-production environment is built. The pre-production environment stages the app, enables you to perform reviews before pushing to production.
2019

2120
Multiple pre-production environments can co-exist at the same time when using Azure Static Web Apps. Each time you create a pull request against the watched branch, a staged version with your changes is deployed to a distinct pre-production environment.
2221

2322
There are many benefits of using pre-production environments. For example, you can:
24-
- Review visual changes between production and staging - for example, updates to content and layout
25-
- Demonstrate the changes to your team
26-
- Compare different versions of your application
27-
- Validate changes using acceptance tests
28-
- Perform sanity checks before deploying to production
23+
24+
- Review visual changes between production and staging. For example, viewing updates to content and layout.
25+
- Demonstrate the changes to your team.
26+
- Compare different versions of your application.
27+
- Validate changes using acceptance tests.
28+
- Perform sanity checks before deploying to production.
29+
30+
> [!NOTE]
31+
> During preview, a [maximum of only one staging environment](quotas.md) is allowed at a time.
2932
3033
## Prerequisites
3134

@@ -42,7 +45,7 @@ Begin by making a change in your repository. You can do it directly on GitHub as
4245
Type a branch name and click on **Create branch**.
4346

4447
1. Go to your _app_ folder and change some text content. For example, you can change a title or paragraph. Once you found the file you want to edit, click on **Edit** to make the change.
45-
48+
4649
:::image type="content" source="./media/review-publish-pull-requests/edit-file.png" alt-text="Edit file button in GitHub interface":::
4750

4851
1. After you make the changes, click on **Commit changes** to commit your changes to the branch.
@@ -54,18 +57,20 @@ Begin by making a change in your repository. You can do it directly on GitHub as
5457
Next, create a pull request from this change.
5558

5659
1. Open the **Pull request** tab of your project on GitHub:
60+
5761
:::image type="content" source="./media/review-publish-pull-requests/tab.png" alt-text="Pull request tab in a GitHub repository":::
5862

5963
1. Click on the **Compare & pull request** button of your branch.
6064

6165
1. You can optionally fill-in some details about your changes, then click on **Create pull request**.
66+
6267
:::image type="content" source="./media/review-publish-pull-requests/open.png" alt-text="Pull request creation in GitHub":::
6368

6469
You can assign reviewers and add comments to discuss your changes if needed.
6570

6671
> [!NOTE]
6772
> You can make multiple changes by pushing new commits to your branch. The pull request is then automatically updated to reflect all changes.
68-
73+
6974
## Review changes
7075

7176
After the pull request is created, the [GitHub Actions](https://github.com/features/actions) deployment workflow runs and deploys your changes to a pre-production environment.
@@ -80,7 +85,7 @@ If you take a closer look at the URL, you can see that it's composed like this:
8085

8186
For a given pull request, the URL remains the same even if you push new updates. In addition to the URL staying constant, the same pre-production environment is reused for the life of the pull request.
8287

83-
## Publish changes
88+
## Publish changes
8489

8590
Once changes are approved, you can publish your changes to production by merging the pull request.
8691

@@ -103,6 +108,5 @@ The number of pre-production environments available for each app deployed with S
103108

104109
## Next steps
105110

106-
107111
> [!div class="nextstepaction"]
108112
> [Setup a custom domain](custom-domain.md)

articles/static-web-apps/routes.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,9 @@ The following table lists the appropriate location to put your _routes.json_ fil
3636

3737
### Angular
3838

39-
Angular apps do not copy files in the _src_ folder to the artifact folder by default. Use the following steps to ensure the _routes.json_ is copied to the appropriate location.
39+
Angular apps do not copy files in the _src_ folder to the artifact folder by default. You can point the GitHub Actions workflow directly to your _routes.json_ file via the [`routes_location` workflow customization](github-actions-workflow.md#route-file-location), or you can update the _angular.json_ file to copy the file.
40+
41+
Using the `routes_location` customization is preferred, but you can also use the following steps update the _angular.json_ file.
4042

4143
1. In Visual Studio Code, open the _angular.json_ file
4244
1. Go to the property at:

0 commit comments

Comments
 (0)