Skip to content

Commit

Permalink
Improve board_s3() docs for non-AWS S3-compatible storage (#853)
Browse files Browse the repository at this point in the history
* Improve `board_s3()` docs for non-AWS S3-compatible storage

* Update NEWS
  • Loading branch information
juliasilge authored Dec 13, 2024
1 parent 1a69348 commit 669ab4e
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 8 deletions.
2 changes: 2 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

* Fixed a bug in how `pin_upload()` handles pin names (#852).

* Improved documentation for S3-compatible object storage (#853).

# pins 1.4.0

## Lifecycle changes
Expand Down
11 changes: 7 additions & 4 deletions R/board_s3.R
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#' Use an S3 bucket as a board
#'
#' Pin data to an S3 bucket, such as on Amazon's S3 service or MinIO, using the
#' paws.storage package.
#' Pin data to an S3-compatible storage bucket, such as on Amazon's S3 service,
#' MinIO, or Digital Ocean, using the paws.storage package.
#'
#' # Authentication
#'
Expand Down Expand Up @@ -48,6 +48,9 @@
#' * You can pass arguments for [paws.storage::s3_put_object] such as `Tagging`
#' and `ServerSideEncryption` through the dots of `pin_write()`. (Note that
#' these are separate from [pin_write()] arguments like `tags`.)
#' * You can use `board_s3()` with S3-compatible object storage on non-AWS
#' platforms such as MinIO and Digital Ocean. For this type of object storage,
#' use the full URL (including scheme like `https://`) of the storage endpoint.
#' * `board_s3()` is powered by the paws.storage package, which is a
#' suggested dependency of pins (not required for pins in general). If
#' you run into errors when deploying content to a server like
Expand All @@ -66,8 +69,8 @@
#' @param region AWS region. If not specified, will be read from `AWS_REGION`,
#' or AWS config file.
#' @param endpoint Endpoint to use; usually generated automatically for AWS
#' from `region`. For MinIO, use the full URL (including scheme like
#' `https://`) of your MinIO endpoint.
#' from `region`. For MinIO and Digital Ocean, use the full URL (including
#' scheme like `https://`) of your S3-compatible storage endpoint.
#' @param profile Role to use from AWS shared credentials/config file.
#' @export
#' @examples
Expand Down
11 changes: 7 additions & 4 deletions man/board_s3.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 669ab4e

Please sign in to comment.