Skip to content

Commit

Permalink
Fix s3 example URLs in the artifacts docs (#15123)
Browse files Browse the repository at this point in the history
* Fix s3 URLs so that they work

Unfortunately, s3 urls prefixed with https:// do NOT work with the underlying go-getter library. As such, this fixes the examples so that they are working examples that won't cause problems for people reading the docs.
See discussion in #1113 circa 2016.

* Use s3:// protocol schema for artifact examples

Per the discussion in #15123,
we're going to use the explicit s3 protocol in the examples since that
is the likeliest to work in all scenarios
  • Loading branch information
twunderlich-grapl committed Nov 7, 2022
1 parent 1a1ce36 commit 1b5eedc
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions website/content/docs/job-specification/artifact.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ This example uses path-based notation on a publicly-accessible bucket:

```hcl
artifact {
source = "https://my-bucket-example.s3-us-west-2.amazonaws.com/my_app.tar.gz"
source = "s3://my-bucket-example.s3-us-west-2.amazonaws.com/my_app.tar.gz"
}
```

Expand Down Expand Up @@ -240,7 +240,7 @@ Alternatively you can use virtual hosted style:

```hcl
artifact {
source = "https://my-bucket-example.s3-eu-west-1.amazonaws.com/my_app.tar.gz"
source = "s3://my-bucket-example.s3-eu-west-1.amazonaws.com/my_app.tar.gz"
}
```

Expand Down

0 comments on commit 1b5eedc

Please sign in to comment.