Add which-image guide and update extending links#115
Open
bschwedler wants to merge 5 commits into
Open
Conversation
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. Connect has three images (server, content runtime, init container) that serve distinct roles in Kubernetes deployments. Update the per-image extending-examples links to point directly to the relevant subfolder in images-examples rather than the generic extending/ root.
ce99943 to
dd910b1
Compare
kmasiello
suggested changes
Jun 4, 2026
…docs - common/R and common/python replace deleted connect/server/R and connect/content/r-python-packages examples - common/system-dependencies replaces connect/content/system-dependencies - pip-conf row replaced with a link to Connect Python package index admin docs
ianpittwood
approved these changes
Jun 5, 2026
Co-authored-by: Katie Masiello <32964481+kmasiello@users.noreply.github.com>
kmasiello
reviewed
Jun 8, 2026
|  | ||
|
|
||
| > [!TIP] | ||
| > Deploying on Kubernetes? Try the <a href="https://docs.posit.co/helm/charts/rstudio-connect/README.html">Posit Connect 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-connect/README.html">Posit Connect Helm chart</a>! |
| ## Running the images | ||
|
|
||
| For local Docker, you only need the `connect` image. The `connect-content` and `connect-content-init` images are for Kubernetes deployments, where published content runs in separate pods from the Connect server. | ||
| or local Docker, you only need the `connect` image. The `connect-content` and `connect-content-init` images are for [Off-Host Execution (OHE) deployments](https://docs.posit.co/connect/admin/appendix/off-host/arch-overview/#off-host-execution) on Kubernetes, where published content runs in separate pods from the Connect server. |
There was a problem hiding this comment.
Suggested change
| or local Docker, you only need the `connect` image. The `connect-content` and `connect-content-init` images are for [Off-Host Execution (OHE) deployments](https://docs.posit.co/connect/admin/appendix/off-host/arch-overview/#off-host-execution) on Kubernetes, where published content runs in separate pods from the Connect server. | |
| For local Docker, you only need the `connect` image. The `connect-content` and `connect-content-init` images are for [Off-Host Execution (OHE) deployments](https://docs.posit.co/connect/admin/appendix/off-host/arch-overview/#off-host-execution) on Kubernetes, where published content runs in separate pods from the Connect server. |
|  | ||
|
|
||
| > [!TIP] | ||
| > Deploying on Kubernetes? Try the <a href="https://docs.posit.co/helm/charts/rstudio-connect/README.html">Posit Connect Helm chart</a>, which uses this image by default. |
There was a problem hiding this comment.
Suggested change
| > Deploying on Kubernetes? Use the <a href="https://docs.posit.co/helm/charts/rstudio-connect/README.html">Posit Connect Helm chart</a>, which uses this image by default. |
|  | ||
|
|
||
| > [!TIP] | ||
| > Deploying on Kubernetes? Try the <a href="https://docs.posit.co/helm/charts/rstudio-connect/README.html">Posit Connect 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-connect/README.html">Posit Connect Helm chart</a>! |
| | Install specific versions of R, Python, or Quarto (Kubernetes) | `connect-content` | [common/R](https://github.com/posit-dev/images-examples/tree/main/extending/common/R) · [common/python](https://github.com/posit-dev/images-examples/tree/main/extending/common/python) | | ||
| | Add system libraries that content packages need (Kubernetes) | `connect-content` | [common/system-dependencies](https://github.com/posit-dev/images-examples/tree/main/extending/common/system-dependencies) | | ||
| | Install R on the Connect server (local Docker) | `connect` (Minimal) | [common/R](https://github.com/posit-dev/images-examples/tree/main/extending/common/R) | | ||
| | Install Quarto on the Connect server | `connect` (Minimal) | [server/quarto](https://github.com/posit-dev/images-examples/tree/main/extending/connect/server/quarto) | |
There was a problem hiding this comment.
Suggested change
| | Install Quarto on the Connect server | `connect` (Minimal) | [server/quarto](https://github.com/posit-dev/images-examples/tree/main/extending/connect/server/quarto) | | |
| | Install Quarto on the Connect server (local Docker) | `connect` (Minimal) | [server/quarto](https://github.com/posit-dev/images-examples/tree/main/extending/connect/server/quarto) | |
|
|
||
| ## 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/connect/README.md?plain=1#L5-L14
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
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. Connect has three images (server, content runtime, init container) that serve distinct roles in Kubernetes deployments.
Updates the per-image extending-example links to point at the relevant
images-examples/extending/connect/...subfolder rather than the genericextending/root.Depends on (must land first):