Skip to content

Commit

Permalink
add suggested changes from Mike
Browse files Browse the repository at this point in the history
  • Loading branch information
nginx-jack committed Jul 24, 2024
1 parent 5611e8d commit 03a9a38
Showing 1 changed file with 8 additions and 11 deletions.
19 changes: 8 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,18 @@ The action pushes to an Azure Storage Container, and assumed an existing reverse

By default, it will also purge the provided CDN path.

## How to

1. Head to the actions section of your repository, for example https://github.com/yourOrg/yourRepo/actions

1. On the left side, click on Build and deploy (docs)
## How-to
These instructions apply only to NGINX GitHub doc repositories.
1. Navigate to the actions section of your repository, for example https://github.com/yourOrg/yourRepo/actions
1. On the left side of the page, select Build and deploy (docs). If you don't see this option, follow the [Caller Example](#caller-example).
![Build and deploy (docs)](/images/build-and-deploy.png "Build and deploy (docs)")
1. On the right side, you should now see a Run workflow button
1. On the right side, you will see a Run workflow button.
![Run Workflow](/images/run-workflow.png "Run Workflow")
1. Clicking this will open a menu which lets you select the branch you want to build, and which environment you'd like to deploy to
1. Preview will generate a custom url for any branch you want, and will be available in the workflow output.
All builds, regardless of environment, will print a url to the summary.
1. Select Run workflow. This opens a menu which lets you select the branch you want to build, and which environment you'd like to deploy to
1. The preview environment generates a custom URL for your preferred branch, and will be available in the workflow output.
All builds, regardless of environment, prints an URL to the summary.
![Summary](/images/summary.png "Summary")

Preview URLs wil be added as a comment to PRs automatically.

_note: autodeploy from branch is currently in progress. This docs will be updated when available._

## Usage
Expand Down

0 comments on commit 03a9a38

Please sign in to comment.