Helpful hints for Positron on Workbench #18
Conversation
✅ Deploy Preview for positron-posit-co ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| title: "Positron on Workbench" | ||
| --- | ||
|
|
||
| Positron is available as a preview feature on [Posit Workbench](https://posit.co/products/enterprise/workbench/) as of its 2024.12.0 release. Important information about using Positron on Posit Workbench is available in the Workbench documentation [for admins](https://docs.posit.co/ide/server-pro/2024.12.0/positron_sessions/) and [for users](https://docs.posit.co/ide/server-pro/user/2024.12.0/positron/getting-started/), but we also want to highlight a few ways to have the best possible experience during this preview period. |
There was a problem hiding this comment.
| Positron is available as a preview feature on [Posit Workbench](https://posit.co/products/enterprise/workbench/) as of its 2024.12.0 release. Important information about using Positron on Posit Workbench is available in the Workbench documentation [for admins](https://docs.posit.co/ide/server-pro/2024.12.0/positron_sessions/) and [for users](https://docs.posit.co/ide/server-pro/user/2024.12.0/positron/getting-started/), but we also want to highlight a few ways to have the best possible experience during this preview period. | |
| Positron is available as a preview feature on [Posit Workbench](https://posit.co/products/enterprise/workbench/) as of its 2024.12.0 release. Important information about using Positron on Posit Workbench is available in the Workbench documentation [for administrators](https://docs.posit.co/ide/server-pro/2024.12.0/positron_sessions/) and [for users](https://docs.posit.co/ide/server-pro/user/2024.12.0/positron/getting-started/), but we also want to highlight a few ways to have the best possible experience during this preview period. |
There was a problem hiding this comment.
Also - Workbench hasn't released yet so we will likely want to hold this PR until its release.
There was a problem hiding this comment.
@juliasilge The hints have been moved over to the Workbench User Guide and are available at: https://docs.posit.co/ide/server-pro/user/2024.12.0/positron/getting-started/!
Now that the main content is in the Workbench docs, maybe we just need this blurb? We could link directly to https://docs.posit.co/ide/server-pro/user/2024.12.0/positron/reference/other-resources.html in addition to the User Guide and Admin Guide links already in this blurb.
|
|
||
| ## Install binary R packages on Workbench | ||
|
|
||
| Posit Workbench runs on Linux, but CRAN doesn't build Linux binaries for R packages. You _can_ install R packages using the default configuration, but you will likely find the process extremely slow. Instead, consider using a CRAN-like repository that provides binaries for your Linux architecture, such as [Posit Package Manager](https://packagemanager.posit.co/client/#/repos/cran/setup) and set that via `options()` in R. For example, if your Workbench is installed on Ubuntu 22.04 (Jammy), you would use: |
There was a problem hiding this comment.
| Posit Workbench runs on Linux, but CRAN doesn't build Linux binaries for R packages. You _can_ install R packages using the default configuration, but you will likely find the process extremely slow. Instead, consider using a CRAN-like repository that provides binaries for your Linux architecture, such as [Posit Package Manager](https://packagemanager.posit.co/client/#/repos/cran/setup) and set that via `options()` in R. For example, if your Workbench is installed on Ubuntu 22.04 (Jammy), you would use: | |
| Posit Workbench runs on Linux, but CRAN doesn't build Linux binaries for R packages. You can install R packages using the default configuration, but it's likely that the process is extremely slow. Instead, consider using a CRAN-like repository that provides binaries for your Linux architecture, such as [Posit Package Manager](https://packagemanager.posit.co/client/#/repos/cran/setup) and set that via `options()` in R. For example, if Workbench is installed on Ubuntu 22.04 (Jammy), you would use: |
| options(repos = c(CRAN = "https://packagemanager.posit.co/cran/__linux__/jammy/latest")) | ||
| ``` | ||
|
|
||
| If you run this one time, you will set your `options` for the current R session. If you add this code to the `.Rprofile` in your home directory on Workbench, it will apply to all your R sessions. |
There was a problem hiding this comment.
I don't want to butcher the PR because I haven't given the rest of the guide a review but this is future tense. We strive to write the product doc in active voice as much as possible (it is a disaster and a WIP). So, I will just comment here vs. suggesting a rewrite here.
|
|
||
| If your administrator has configured [resource profiles](https://docs.posit.co/ide/server-pro/getting_started/installation/kubernetes_installation.html#setup-resource-profiles) on Posit Workbench, you should allocate at least 4 GB of RAM when starting Positron sessions. | ||
|
|
||
| We expect to make performance improvements in the future to decrease the memory needs of Positron. Follow along [on GitHub](https://github.com/posit-dev/positron/issues/5050) to learn about our plans for a better solution in the long term. |
There was a problem hiding this comment.
|
|
||
| Follow along [on GitHub](https://github.com/posit-dev/positron/issues/3574) to learn about our plans for a better solution in the long term. | ||
|
|
||
| :::{.callout-note} |
There was a problem hiding this comment.
Voiceover doesn't seem to recognize inline links tied to headings/files. We tested it earlier. I would change this:
directly to the Positron team
to
Use the Feedback and Users to provide feedback directly to the Positron team.
|
I think that some of this isn't appropriate for the Positron docs. Having Workbench docs in the Positron guide seems to suggest that we are showing a lot of favoritism and pushing/promoting Workbench. It also becomes another place that we have to track and update.
The Workbench docs follow the same updating process as Positron—they can be rolled out whenever, and you can build them locally using Anything Workbench-related should stay in the Workbench docs. By introducing this content here, we now have 3+ places (like 10+ with support articles) where we cover resource profiles and R discovery, and I think adding another place is further degrading our user experience. |
|
@juliasilge - I can help with/facilitate WB doc updates if it helps alleviate some of the burden. Not a problem - happy to help! |
|
I'm happy for this to go into the Workbench docs if the consensus is that it's a better option! What I think is important that we have in the user docs in that case includes:
|
|
I'll port this content over to the Workbench User Guide. |
|
Thank you so much @sharon-wang! We'll close this PR and after the Workbench release add a link to the user docs somewhere, maybe at the bottom of https://positron.posit.co/start? I don't think we need a whole page anymore. Thanks, all! 🙌 |
It is a very low lift for us to update this site (much easier than the Workbench docs themselves) so we can use this as a spot for flexibly adding advice to folks during the preview period.
What else do we want to include here?