Skip to content

Commit c85fa33

Browse files
authored
docs: Improve README.md (#28)
* docs: Add link to Authorization section on README.md * docs: Add link to enable App Engine Admin API on README.md.
1 parent 7517c94 commit c85fa33

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ background if not using in with the [`setup-gcloud` action][setup-gcloud].
2525
## Prerequisites
2626

2727
This action requires Google Cloud credentials that are authorized to deploy an
28-
App Engine Application. See the Authorization section below for more information.
28+
App Engine Application. See the [Authorization](#authorization) section below for more information.
2929

3030
## Usage
3131

@@ -77,7 +77,7 @@ for more information.
7777
- `url`: The URL of your App Engine Application.
7878

7979
## Authorization
80-
80+
<a name="authorization"></a>
8181
There are a few ways to authenticate this action. The caller must have
8282
permissions to access the secrets being requested.
8383

@@ -146,7 +146,9 @@ Credentials.
146146

147147
1. Create a new Google Cloud Project (or select an existing project).
148148

149-
1. [Initialize your App Engine app with your project](https://cloud.google.com/appengine/docs/standard/nodejs/console#console).
149+
1. [Initialize your App Engine app with your project][app-engine-nodejs-docs].
150+
151+
1. Enable the [App Engine Admin API][app-engine-admin-api] on your project.
150152

151153
1. [Create a Google Cloud service account][sa] or select an existing one.
152154

@@ -212,4 +214,6 @@ Migrated to `deploy-appengine`:
212214
[gh-secret]: https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets
213215
[setup-gcloud]: https://github.com/google-github-actions/setup-gcloud/
214216
[roles]: https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource
215-
[create-key]: https://cloud.google.com/iam/docs/creating-managing-service-account-keys
217+
[create-key]: https://cloud.google.com/iam/docs/creating-managing-service-account-keys
218+
[app-engine-admin-api]: https://console.cloud.google.com/apis/api/appengine.googleapis.com/overview
219+
[app-engine-nodejs-docs]: https://cloud.google.com/appengine/docs/standard/nodejs/console#console

0 commit comments

Comments
 (0)