Skip to content

docs: add notes on pin name when using rsc board #125

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 18, 2022
Merged

docs: add notes on pin name when using rsc board #125

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/getting_started.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
`<user_name>/<content_name>`. For example, `hadely/sales-report`.
Copy link
Member

@juliasilge juliasilge May 18, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might want to fix Hadley's name in a later PR: hadley

Copy link
Collaborator Author

@machow machow May 19, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah shoot--thanks for catching, fixed in #118

```


## Metadata


Expand Down
2 changes: 1 addition & 1 deletion docs/intro.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ from pins import board_rsconnect
board = board_rsconnect()
#> Connecting to RSC 1.9.0.1 at <https://connect.rstudioservices.com>

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'
```

Expand Down