diff --git a/.github/ISSUE_TEMPLATE/issue_template.md b/.github/ISSUE_TEMPLATE/issue_template.md index 898687a4..3ad684b7 100644 --- a/.github/ISSUE_TEMPLATE/issue_template.md +++ b/.github/ISSUE_TEMPLATE/issue_template.md @@ -3,7 +3,7 @@ name: Bug report or feature request about: Describe a bug you've seen or make a case for a new feature --- -Please briefly describe your problem and what output you expect. If you have a question, please don't use this form. Instead, ask on or . +Please briefly describe your problem and what output you expect. If you have a question, please don't use this form. Instead, ask on or . Please include a minimal reproducible example (AKA a reprex). If you've never heard of a [reprex](http://reprex.tidyverse.org/) before, start by reading . diff --git a/.github/SUPPORT.md b/.github/SUPPORT.md index c32a4d02..b45e7220 100644 --- a/.github/SUPPORT.md +++ b/.github/SUPPORT.md @@ -5,31 +5,31 @@ Before filing an issue, there are a few places to explore and pieces to put toge ## Make a reprex -Start by making a minimal **repr**oducible **ex**ample using the [reprex](https://reprex.tidyverse.org/) package. -If you haven't heard of or used reprex before, you're in for a treat! -Seriously, reprex will make all of your R-question-asking endeavors easier (which is a pretty insane ROI for the five to ten minutes it'll take you to learn what it's all about). +Start by making a minimal **repr**oducible **ex**ample using the [reprex](https://reprex.tidyverse.org/) package. +If you haven't heard of or used reprex before, you're in for a treat! +Seriously, reprex will make all of your R-question-asking endeavors easier (which is a pretty insane ROI for the five to ten minutes it'll take you to learn what it's all about). For additional reprex pointers, check out the [Get help!](https://www.tidyverse.org/help/) section of the tidyverse site. ## Where to ask? -Armed with your reprex, the next step is to figure out [where to ask](https://www.tidyverse.org/help/#where-to-ask). +Armed with your reprex, the next step is to figure out [where to ask](https://www.tidyverse.org/help/#where-to-ask). -* If it's a question: start with [community.rstudio.com](https://community.rstudio.com/), and/or StackOverflow. There are more people there to answer questions. +* If it's a question: start with [forum.posit.co](https://forum.posit.co/), and/or StackOverflow. There are more people there to answer questions. -* If it's a bug: you're in the right place, [file an issue](https://github.com/rstudio/connectapi/issues/new). - -* If you're not sure: let the community help you figure it out! - If your problem _is_ a bug or a feature request, you can easily return here and report it. +* If it's a bug: you're in the right place, [file an issue](https://github.com/rstudio/connectapi/issues/new). -Before opening a new issue, be sure to [search issues and pull requests](https://github.com/rstudio/connectapi/issues) to make sure the bug hasn't been reported and/or already fixed in the development version. -By default, the search will be pre-populated with `is:issue is:open`. -You can [edit the qualifiers](https://help.github.com/articles/searching-issues-and-pull-requests/) (e.g. `is:pr`, `is:closed`) as needed. +* If you're not sure: let the community help you figure it out! + If your problem _is_ a bug or a feature request, you can easily return here and report it. + +Before opening a new issue, be sure to [search issues and pull requests](https://github.com/rstudio/connectapi/issues) to make sure the bug hasn't been reported and/or already fixed in the development version. +By default, the search will be pre-populated with `is:issue is:open`. +You can [edit the qualifiers](https://help.github.com/articles/searching-issues-and-pull-requests/) (e.g. `is:pr`, `is:closed`) as needed. For example, you'd simply remove `is:open` to search _all_ issues in the repo, open or closed. ## What happens next? To be as efficient as possible, development of tidyverse packages tends to be very bursty, so you shouldn't worry if you don't get an immediate response. -Typically we don't look at a repo until a sufficient quantity of issues accumulates, then there’s a burst of intense activity as we focus our efforts. -That makes development more efficient because it avoids expensive context switching between problems, at the cost of taking longer to get back to you. -This process makes a good reprex particularly important because it might be multiple months between your initial report and when we start working on it. +Typically we don't look at a repo until a sufficient quantity of issues accumulates, then there’s a burst of intense activity as we focus our efforts. +That makes development more efficient because it avoids expensive context switching between problems, at the cost of taking longer to get back to you. +This process makes a good reprex particularly important because it might be multiple months between your initial report and when we start working on it. If we can’t reproduce the bug, we can’t fix it! diff --git a/DESCRIPTION b/DESCRIPTION index 85516911..98d6ae7c 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,8 +1,8 @@ Type: Package Package: connectapi Title: Utilities for Interacting with the 'Posit Connect' Server API -Version: 0.1.3.9000 -Authors@R: +Version: 0.1.4 +Authors@R: c(person(given = "Sean", family = "Lopp", role = c("aut")), @@ -12,15 +12,15 @@ Authors@R: email = "cole@posit.co"), person(given = "Posit, PBC", role = c("cph", "fnd"))) -Description: Provides a helpful 'R6' class and methods for interacting with +Description: Provides a helpful 'R6' class and methods for interacting with the 'Posit Connect' Server API along with some meaningful utility functions for regular tasks. API documentation varies by 'Posit Connect' installation - and version, but the latest documentation is also hosted publicly at + and version, but the latest documentation is also hosted publicly at . License: MIT + file LICENSE URL: https://pkgs.rstudio.com/connectapi/, https://github.com/rstudio/connectapi BugReports: https://github.com/rstudio/connectapi/issues -Imports: +Imports: config, dplyr, fs, @@ -38,7 +38,7 @@ Imports: yaml, bit64, jsonlite -Suggests: +Suggests: crayon, dbplyr, flexdashboard, diff --git a/NEWS.md b/NEWS.md index cf1a32bb..55bf0af8 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,12 +1,12 @@ -# connectapi (development version) +# connectapi 0.1.4 -- Now correctly provides methods for `tbl_connect`, rather than `tbl_lazy`, - preventing problems when also using dplyr (#177). - BREAKING: The functions `Connect$download_bundle()` and `Connect$bundle_delete()` have been removed. Use `Content$bundle_download()` and `Content$bundle_delete()` instead. - `Content$tag_delete()` removes the tag from the target content item rather than removing the tag entirely. (#194) +- Correctly provides methods for `tbl_connect` rather than `tbl_lazy`, + preventing problems when also using dbplyr (#177). # connectapi 0.1.3.1 @@ -125,7 +125,7 @@ # connectapi 0.1.0.9017 -BREAKING: +BREAKING: * Switch from `RSTUDIO_CONNECT_*` variables to `CONNECT_*` variables * Rename a handful of functions: - `connect$activate_bundle` to `connect$content_deploy` @@ -143,7 +143,7 @@ BREAKING: - `cache_apps` - `tag_page` -OTHER: +OTHER: * Add some endpoints: - `content` - `audit_logs` diff --git a/README.Rmd b/README.Rmd index e29a842e..e06bdba1 100644 --- a/README.Rmd +++ b/README.Rmd @@ -43,7 +43,7 @@ Please pay careful attention to the lifecycle badges of the various functions and warnings present when you are using experimental features. **Also, [please share -feedback!!](https://community.rstudio.com/c/r-admin/posit-connect/27) We love +feedback!!](https://forum.posit.co/c/r-admin/posit-connect/27) We love hearing how the Posit Connect Server API is helpful and what additional endpoints would be useful!!** @@ -124,16 +124,16 @@ client <- connect() # NOTE: a `manifest.json` should already exist from `rsconnect::writeManifest()` bundle <- bundle_dir("./path/to/directory") -content <- client %>% - deploy(bundle, name = "my-app-name") %>% +content <- client %>% + deploy(bundle, name = "my-app-name") %>% poll_task() # set an image for content -content %>% +content %>% set_image_path("./my/local/image.png") -content %>% +content %>% set_image_url("http://url.example.com/image.png") # set image and a vanity URL @@ -145,13 +145,13 @@ content %>% # change access_type to "anyone" content$update(access_type = "all") - + # edit another piece of content client %>% content_item("the-content-guid") %>% set_vanity_url("/another-awesome-app") - + # migrate content to another server client_prod <- connect( @@ -217,7 +217,7 @@ If you get this error message, our recommendation would be: Please feel free to open an Issue if you think there is a bug, or ask a free-form question on [Posit -Community](https://community.rstudio.com/c/r-admin/posit-connect/27) +Community](https://forum.posit.co/c/r-admin/posit-connect/27) **Other ideas for FAQs or Common Issues?** diff --git a/README.md b/README.md index 17c707f0..2320fbe0 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ Please pay careful attention to the lifecycle badges of the various functions and warnings present when you are using experimental features. **Also, [please share -feedback!!](https://community.rstudio.com/c/r-admin/posit-connect/27) We +feedback!!](https://forum.posit.co/c/r-admin/posit-connect/27) We love hearing how the Posit Connect Server API is helpful and what additional endpoints would be useful!!** @@ -120,16 +120,16 @@ client <- connect() # NOTE: a `manifest.json` should already exist from `rsconnect::writeManifest()` bundle <- bundle_dir("./path/to/directory") -content <- client %>% - deploy(bundle, name = "my-app-name") %>% +content <- client %>% + deploy(bundle, name = "my-app-name") %>% poll_task() # set an image for content -content %>% +content %>% set_image_path("./my/local/image.png") -content %>% +content %>% set_image_url("http://url.example.com/image.png") # set image and a vanity URL @@ -141,13 +141,13 @@ content %>% # change access_type to "anyone" content$update(access_type = "all") - + # edit another piece of content client %>% content_item("the-content-guid") %>% set_vanity_url("/another-awesome-app") - + # migrate content to another server client_prod <- connect( @@ -220,7 +220,7 @@ If you get this error message, our recommendation would be: Please feel free to open an Issue if you think there is a bug, or ask a free-form question on [Posit -Community](https://community.rstudio.com/c/r-admin/posit-connect/27) +Community](https://forum.posit.co/c/r-admin/posit-connect/27) **Other ideas for FAQs or Common Issues?**