From 03a9a3808fcb77cd0c19d7fa5d59b25565dd1d6d Mon Sep 17 00:00:00 2001 From: Jack Hickey Date: Wed, 17 Jul 2024 15:30:45 +0100 Subject: [PATCH] add suggested changes from Mike --- README.md | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 9c48218..1a19d21 100644 --- a/README.md +++ b/README.md @@ -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