Skip to content
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.

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

Helpful hints for Positron on Workbench #18

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
13 changes: 7 additions & 6 deletions _quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ project:
- "*.qmd"

website:
announcement:
announcement:
icon: info-circle
dismissable: false
content: "Positron is available for beta testing and [may not yet be a good fit for you](start.qmd#is-positron-for-me). If you are interested in experimenting with it, we welcome your [feedback](feedback.qmd)!"
Expand All @@ -31,12 +31,12 @@ website:
href: "https://docs.posit.co/"
- text: "<img alt='Link to main Posit site' src='images/posit-icon-fullcolor.svg' id='footer-right-posit-logo'>"
href: "https://posit.co/"
navbar:
navbar:
left:
- text: "Get Started"
href: start.qmd
href: start.qmd
- text: "Guides"
href: interpreters.qmd
href: interpreters.qmd
- text: "Help"
href: troubleshooting.qmd

Expand All @@ -56,11 +56,12 @@ website:
- connections-pane.qmd
- run-interactive-apps.qmd
- updating.qmd
- workbench.qmd

- title: "Help"
style: "docked"
contents:
- troubleshooting.qmd
- feedback.qmd
- faqs.qmd
- faqs.qmd

33 changes: 33 additions & 0 deletions workbench.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: "Positron on Workbench"
juliasilge marked this conversation as resolved.
Show resolved Hide resolved
---

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.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
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.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Also - Workbench hasn't released yet so we will likely want to hold this PR until its release.

Copy link
Member

Choose a reason for hiding this comment

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

@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:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
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:


```r
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.
Copy link
Collaborator

Choose a reason for hiding this comment

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

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.


Follow along [on GitHub](https://github.com/posit-dev/positron/issues/5318) to learn about our plans for a better solution in the long term.

### Resource profiles

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.
Copy link
Collaborator

Choose a reason for hiding this comment

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


### Python discovery

We plan to add admin configuration to set defaults for both Python and R interpreters, as well as to control interpreter discovery. In the meantime, we suggest adding [Python interpreters appropriate for use in Workbench to the `PATH`](https://docs.posit.co/ide/server-pro/python/configuring_default.html) to ensure Positron can find and use those Python interpreters.

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}
Copy link
Collaborator

Choose a reason for hiding this comment

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

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.

We encourage you as our customer to try out Positron on Workbench and we welcome any feedback via Posit Support, your Posit Customer Success representative, or [directly to the Positron team](/feedback.qmd). During this Public Beta period (before general availability), we recommend that Positron not be used in production.
:::