Skip to content

Commit e691cdf

Browse files
committed
Update guidance on setting AWS_REGION
1 parent d2cd9a0 commit e691cdf

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/how-tos/publish-a-techdocs-site.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ At this point you should see a `site` directory, the contents of which can be vi
3737

3838
We will use the Techdocs command line interface node package to publish our docs site to the S3 bucket.
3939

40-
In order to do this we will require the nessacary credentials for the bucket. The nessacary credentials should be made available as the environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`. These credentials are made available in GitHub Workflows in the DiamondLightSource organisation as `TECHDOCS_S3_ACCESS_KEY_ID` and `TECHDOCS_S3_SECRET_ACCESS_KEY` respectively or can be attained by contacting the owner of `developer-portal-techdocs-bucket`. Further to this, the `AWS_REGION` environment variable should be set to an empty string.
40+
In order to do this we will require the necessary credentials for the bucket. The necessary credentials should be made available as the environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`. These credentials are made available in GitHub Workflows in the DiamondLightSource organisation as `TECHDOCS_S3_ACCESS_KEY_ID` and `TECHDOCS_S3_SECRET_ACCESS_KEY` respectively or can be attained by contacting the owner of `developer-portal-techdocs-bucket`. Further to this, the `AWS_REGION` environment variable should be set to a valid region code, e.g. `eu-west-2`.
4141

4242
We will now run:
4343

@@ -90,7 +90,7 @@ npx @techdocs/cli publish --entity <NAMESPACE/KIND/NAME> --publisher-type awsS3
9090
env:
9191
AWS_ACCESS_KEY_ID: ${{ secrets.TECHDOCS_S3_ACCESS_KEY_ID }}
9292
AWS_SECRET_ACCESS_KEY: ${{ secrets.TECHDOCS_S3_SECRET_ACCESS_KEY }}
93-
AWS_REGION: ""
93+
AWS_REGION: "eu-west-2"
9494
```
9595

9696
!!! example "Example GitLab Workflow"
@@ -125,7 +125,7 @@ npx @techdocs/cli publish --entity <NAMESPACE/KIND/NAME> --publisher-type awsS3
125125
--awsEndpoint https://s3.echo.stfc.ac.uk
126126
--awsS3ForcePathStyle
127127
variables:
128-
AWS_REGION: ""
128+
AWS_REGION: "eu-west-2"
129129
```
130130

131131
## Annotate Entity

0 commit comments

Comments
 (0)