Skip to content

Commit e4d13d1

Browse files
authored
docs: update URLs (#283)
* Add GitHub links to DESCRIPTION * fix URLs (remove login-protected URLs) * add news item
1 parent bd147ee commit e4d13d1

13 files changed

+23
-22
lines changed

DESCRIPTION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Authors@R: c(
2323
person("Alec", "Wong", role = "ctb"),
2424
person("Alex", "Brodersen", role = "ctb")
2525
)
26-
URL: https://r-box.github.io/boxr/, https://github.com/r-box/boxr/
26+
URL: https://r-box.github.io/boxr/, https://github.com/r-box/boxr
2727
BugReports: https://github.com/r-box/boxr/issues
2828
Description: An R interface for the remote file hosting service 'Box'
2929
(<https://www.box.com/>). In addition to uploading and downloading files,

NEWS.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# boxr 0.3.6 (development)
1+
# boxr 0.3.7
22

33
## Fixes
44

@@ -33,7 +33,7 @@
3333

3434
* adds and updates GitHub Actions for testing and coverage. (#206, #247, #256)
3535

36-
* update documentation: README, external-package links, pkgdown, add alt text to figures. (#275, #276, #279)
36+
* update documentation: README, URLs, external-package links, pkgdown, add alt text to figures. (#275, #276, #279, #282)
3737

3838
# boxr 0.3.6
3939

@@ -192,7 +192,7 @@ data!
192192

193193
* `box_write` A convenience function to convert R objects to common file types
194194
(e.g. .json, .csv, .tsv, .xlsx, etc.), and upload to box. Using the default
195-
write function ([rio::export](https://github.com/leeper/rio)), the file type can
195+
write function ([rio::export](https://github.com/gesistsa/rio)), the file type can
196196
be determined automatically from the filename provided.
197197

198198
* `box_add_description` A simple way to add a description to a file on box.com.

R/boxr_auth.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@
6363
#' @seealso \describe{
6464
#' \item{[box_auth_service()]}{for authenticating to service-apps.}
6565
#' \item{[httr::oauth2.0_token()]}{for details on how tokens are handled.}
66-
#' \item{[Box Developers: Setup with OAuth 2.0](https://developer.box.com/en/guides/applications/custom-apps/oauth2-setup)}{
66+
#' \item{[Box Developers: Setup with OAuth 2.0](https://developer.box.com/guides/authentication/oauth2/oauth2-setup/)}{
6767
#' documentation for setting up Box (interactive) apps with OAuth 2.0.}
6868
#' }
6969
#'
@@ -401,7 +401,7 @@ box_auth_on_attach <- function(auth_on_attach = FALSE) {
401401
#' \item{[box_auth()]}{for authenticating to interactive-apps.}
402402
#' \item{[box_collab_create()]}{for creating a collaboration with a different account
403403
#' on a Box file or folder.}
404-
#' \item{[Box Developers: Setup with JWT](https://developer.box.com/en/guides/applications/custom-apps/jwt-setup)}{
404+
#' \item{Box Developers: Setup with JWT](https://developer.box.com/en/guides/applications/custom-apps/jwt-setup)}{
405405
#' documentation for setting up Box (service) apps with JWT.}
406406
#' }
407407
#'

R/boxr_delete_restore.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
#'
33
#' In the Box context, deleting a file moves it to a special folder
44
#' within your Box account: 'Trash'. As of mid-2019, Box' default
5-
#' [policy](https://support.box.com/hc/en-us/articles/360044196093-Manage-Trash)
5+
#' [policy](https://support.box.com/hc/en-us/articles/360044196093-Managing-Trash)
66
#' is to retain files in Trash for 30 days.
77
#'
88
#' \describe{

README.Rmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ url <- function(x = "") {
1919

2020
<!-- badges: start -->
2121
[![cran version](https://www.r-pkg.org/badges/version/boxr)](https://CRAN.R-project.org/package=boxr)
22-
[![codecov](https://codecov.io/gh/r-box/boxr/branch/main/graph/badge.svg?token=eeGrWfmg4P)](https://codecov.io/gh/r-box/boxr)
22+
[![codecov](https://codecov.io/gh/r-box/boxr/branch/main/graph/badge.svg)](https://app.codecov.io/gh/r-lib/covr?branch=master)
2323
![monthly_downloads](https://cranlogs.r-pkg.org/badges/boxr)
2424
[![R-CMD-check](https://github.com/r-box/boxr/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/r-box/boxr/actions/workflows/R-CMD-check.yaml)
2525
<!-- badges: end -->

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
[![cran
99
version](https://www.r-pkg.org/badges/version/boxr)](https://CRAN.R-project.org/package=boxr)
10-
[![codecov](https://codecov.io/gh/r-box/boxr/branch/main/graph/badge.svg?token=eeGrWfmg4P)](https://codecov.io/gh/r-box/boxr)
10+
[![codecov](https://codecov.io/gh/r-box/boxr/branch/main/graph/badge.svg)](https://app.codecov.io/gh/r-lib/covr?branch=master)
1111
![monthly_downloads](https://cranlogs.r-pkg.org/badges/boxr)
1212
[![R-CMD-check](https://github.com/r-box/boxr/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/r-box/boxr/actions/workflows/R-CMD-check.yaml)
1313
<!-- badges: end -->

man/box_auth.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/box_auth_service.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/box_delete_file.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/boxr-package.Rd

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

vignettes/boxr-app-interactive.Rmd

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -134,9 +134,9 @@ Once `.boxr-oauth` is uploaded, and you have restarted your R session, you shoul
134134

135135
Keep in mind that to create or activate a Box App, you may need the approval of your Box-admin team. If you have a personal Box account, *you* are your Box-admin team.
136136

137-
This material is a summary of the [Box documentation on OAuth 2.0 apps](https://developer.box.com/en/guides/applications/custom-apps/oauth2-setup).
137+
This material is a summary of the [Box documentation on OAuth 2.0 apps](https://developer.box.com/guides/authentication/oauth2/oauth2-setup/).
138138

139-
Having logged into your account in a browser, start at the [Box Developers Console](https://app.box.com/developers/console).
139+
Having logged into your account in a browser, start at the **Box Developers Console**.
140140

141141
### Create App
142142

@@ -174,4 +174,4 @@ At this point, you have enough information to use `box_auth()`.
174174
#| application. The input-text boxes for "Client ID", "Client Secret", and
175175
#| "Redirect URI" are highlighted.
176176
incl("interactive-config.png")
177-
```
177+
```

vignettes/boxr-app-service.Rmd

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -229,9 +229,9 @@ Use as.data.frame() to extract full results.
229229

230230
Keep in mind that to create or activate a Box App, you may need the approval of your Box-admin team. If you have a personal Box account, *you* are your Box-admin team.
231231

232-
This material is a summary of the [Box documentation on JWT apps](https://developer.box.com/en/guides/applications/custom-apps/jwt-setup).
232+
This material is a summary of the [Box documentation on JWT apps](https://developer.box.com/guides/authentication/jwt/jwt-setup/).
233233

234-
Having logged into your account in a browser, start at the [Box Developers Console](https://app.box.com/developers/console).
234+
Having logged into your account in a browser, start at the **Box Developers Console**.
235235

236236
### Create App
237237

@@ -300,7 +300,7 @@ incl("service-config-3.png")
300300

301301
### Authorize App
302302

303-
The last step is to authorize your app - this has to be done by someone on your Box-admin team. If this is a personal account, that's you. Go to your [Apps Setup page](https://app.box.com/master/settings/openbox):
303+
The last step is to authorize your app - this has to be done by someone on your Box-admin team. If this is a personal account, that's you. Go to your **Apps Setup page**:
304304

305305
1. Scroll down to **Custom Applications**, click **Authorize New App**.
306306

@@ -315,4 +315,4 @@ At this point, you are ready to [use the service-app](#use).
315315
#| Screenshot of the Box web interface, showing "Custom Applications",
316316
#| highlighting the "Authorize New App" button.
317317
incl("service-authorize.png")
318-
```
318+
```

vignettes/boxr-apps.Rmd

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,9 @@ The type of Box-app you use may also depend your situation:
5050

5151
This vignette is about the two types of apps that `boxr` uses, how to authenticate to them, and the security considerations that go along with them:
5252

53-
- **[Interactive App](./boxr-app-interactive.html)**: This is preferred for interactive use (this includes you hitting the "knit" button in the RStudio IDE). The user authenticates to the app interactively, using the "OAuth Dance": a browser-window is opened to ask the user's permission. The app has all the rights of the user who authenticates to it. The [Box documentation on OAuth 2.0 apps](https://developer.box.com/en/guides/applications/custom-apps/oauth2-setup) has even more detail.
53+
- **[Interactive App](./boxr-app-interactive.html)**: This is preferred for interactive use (this includes you hitting the "knit" button in the RStudio IDE). The user authenticates to the app interactively, using the "OAuth Dance": a browser-window is opened to ask the user's permission. The app has all the rights of the user who authenticates to it. The [Box documentation on OAuth 2.0 apps](https://developer.box.com/guides/authentication/oauth2/oauth2-setup/) has even more detail.
5454

55-
- **[Service App](./boxr-app-service.html)**: This is useful for unattended use, e.g. on a remote computer. A token (JSON file) is generated using the Box (or Box Enterprise) website. This token can be deployed to the (presumably remote) computer; there is no "OAuth Dance". Because these apps can act on behalf of the Box system itself, we recommend that you configure the app with a *minimal* set of privileges, e.g. to access only the Box folder that the app will need. The [Box documentation on JWT apps](https://developer.box.com/en/guides/applications/custom-apps/jwt-setup) has even more detail.
55+
- **[Service App](./boxr-app-service.html)**: This is useful for unattended use, e.g. on a remote computer. A token (JSON file) is generated using the Box (or Box Enterprise) website. This token can be deployed to the (presumably remote) computer; there is no "OAuth Dance". Because these apps can act on behalf of the Box system itself, we recommend that you configure the app with a *minimal* set of privileges, e.g. to access only the Box folder that the app will need. The [Box documentation on JWT apps](https://developer.box.com/guides/authentication/jwt/jwt-setup/) has even more detail.
5656

5757
## Interactive App
5858

0 commit comments

Comments
 (0)