Add which-image guide and update extending links#122
Open
bschwedler wants to merge 3 commits into
Open
Conversation
bschwedler
requested review from
ianpittwood,
skyeturriff,
ssinnott and
zachhannum
as code owners
Add a "Customizing images" section to the repo root README with a table mapping admin goals to the right image and a concrete example link. Workbench has four images that serve distinct roles; it was not obvious which to customize for a given goal. Update the per-image extending-examples links to point directly to the relevant subfolder in images-examples rather than the generic extending/ root. Closes #112
bschwedler
force-pushed
the
extend-by-image
branch
from
78825cd to
f90a1b6
Compare
ssinnott
approved these changes
Jun 4, 2026
kmasiello
suggested changes
Jun 4, 2026
Comment on lines
+91
to
+104
| Each image serves a different role. The right image to customize depends on what you want to change. | ||
|
|
||
| | I want to… | Customize | Example | | ||
| |:-----------|:----------|:--------| | ||
| | Add R or Python packages available in every user session | `workbench-session` | [session/r-python-packages](https://github.com/posit-dev/images-examples/tree/main/extending/workbench/session/r-python-packages) | | ||
| | Add system libraries that session packages need | `workbench-session` | [session/system-dependencies](https://github.com/posit-dev/images-examples/tree/main/extending/workbench/session/system-dependencies) | | ||
| | Change Workbench server configuration | `workbench` (Minimal) | [server/config](https://github.com/posit-dev/images-examples/tree/main/extending/workbench/server/config) | | ||
| | Install additional languages on the Workbench server | `workbench` (Minimal) | [server/python](https://github.com/posit-dev/images-examples/tree/main/extending/workbench/server/python) | | ||
| | Install Posit Pro Drivers on the Workbench server | `workbench` (Minimal) | [server/pro-drivers](https://github.com/posit-dev/images-examples/tree/main/extending/workbench/server/pro-drivers) | | ||
| | Pre-install VS Code extensions | `workbench` (Standard) | [server/vs-code-extensions](https://github.com/posit-dev/images-examples/tree/main/extending/workbench/server/vs-code-extensions) | | ||
| | Bundle session components into a self-contained session image | `workbench-session-init` + `workbench-session` | [session-init](https://github.com/posit-dev/images-examples/tree/main/extending/workbench/session-init) | | ||
| | Run a newer Positron version than the Workbench server ships | `workbench-positron-init` | Helm `components.positron.version` | | ||
| | Upgrade the Workbench server version | `workbench` + `workbench-session-init` (keep in sync) | — | | ||
|
|
There was a problem hiding this comment.
see previous comments in posit-dev/images-examples#36
- common/R and common/python replace deleted workbench/server/python - Add row linking to Workbench Python package index admin docs
skyeturriff
approved these changes
Jun 5, 2026
ianpittwood
approved these changes
Jun 5, 2026
kmasiello
reviewed
Jun 8, 2026
|  | ||
|
|
||
| > [!TIP] | ||
| > Deploying on Kubernetes? Try the <a href="https://docs.posit.co/helm/charts/rstudio-workbench/README.html">Posit Workbench Helm chart</a>! |
There was a problem hiding this comment.
Suggested change
| > Deploying on Kubernetes? Use the <a href="https://docs.posit.co/helm/charts/rstudio-workbench/README.html">Posit Workbench Helm chart</a>! |
|  | ||
|
|
||
| > [!TIP] | ||
| > Deploying on Kubernetes? Try the <a href="https://docs.posit.co/helm/charts/rstudio-workbench/README.html">Posit Workbench Helm chart</a>! |
There was a problem hiding this comment.
Suggested change
| > Deploying on Kubernetes? Use the <a href="https://docs.posit.co/helm/charts/rstudio-workbench/README.html">Posit Workbench Helm chart</a>! |
|  | ||
|
|
||
| > [!TIP] | ||
| > Deploying on Kubernetes? Try the <a href="https://docs.posit.co/helm/charts/rstudio-workbench/README.html">Posit Workbench Helm chart</a>, which can configure Workbench to launch sessions with this image. |
There was a problem hiding this comment.
Suggested change
| > Deploying on Kubernetes? Use the <a href="https://docs.posit.co/helm/charts/rstudio-workbench/README.html">Posit Workbench Helm chart</a>, which can configure Workbench to launch sessions with this image. |
|  | ||
|
|
||
| > [!TIP] | ||
| > Deploying on Kubernetes? Try the <a href="https://docs.posit.co/helm/charts/rstudio-workbench/README.html">Posit Workbench Helm chart</a>! |
There was a problem hiding this comment.
Suggested change
| > Deploying on Kubernetes? Use the <a href="https://docs.posit.co/helm/charts/rstudio-workbench/README.html">Posit Workbench Helm chart</a>! |
|
|
||
| ## Customizing images | ||
|
|
||
| Each image serves a different role. The right image to customize depends on what you want to change. |
There was a problem hiding this comment.
This section and the customizing table is no longer consistent with https://github.com/posit-dev/images-examples/blob/c64546037bd4bc7e6023498fa530a0047ba3ee97/extending/workbench/README.md?plain=1#L5-L15
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a "Customizing images" section to the repo root README with a goal-to-image mapping table. Workbench has four images that serve distinct roles; it was not obvious which to customize for a given goal (the immediate motivation behind issue #112).
Updates the per-image extending-example links to point at the relevant
images-examples/extending/workbench/...subfolder rather than the genericextending/root.Closes #112
Depends on (must land first):