From 6aab052ff9f0ef2b7aa9cf22ef98a6cfa1de7b11 Mon Sep 17 00:00:00 2001 From: Michael Chow Date: Wed, 18 May 2022 14:31:55 -0400 Subject: [PATCH] docs: add notes on pin name when using rsc board --- docs/getting_started.Rmd | 6 ++++++ docs/intro.md | 2 +- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/getting_started.Rmd b/docs/getting_started.Rmd index cbb74e3d..518821c9 100644 --- a/docs/getting_started.Rmd +++ b/docs/getting_started.Rmd @@ -89,6 +89,12 @@ As a general rule of thumb, we don't recommend using pins with files over 500 MB If you find yourself routinely pinning data larger that this, you might need to reconsider your data engineering pipeline. +```{note} +If you are using the RStudio Connect board (`board_rsconnect`), then you must specify your pin name as +`/`. For example, `hadely/sales-report`. +``` + + ## Metadata diff --git a/docs/intro.md b/docs/intro.md index 539de465..9d93da0f 100644 --- a/docs/intro.md +++ b/docs/intro.md @@ -75,7 +75,7 @@ from pins import board_rsconnect board = board_rsconnect() #> Connecting to RSC 1.9.0.1 at -board.pin_write(tidy_sales_data, "sales-summary", type = "csv") +board.pin_write(tidy_sales_data, "hadley/sales-summary", type = "csv") #> Writing to pin 'hadley/sales-summary' ```