Skip to content

Restructure image READMEs and add HEALTHCHECK to Workbench#94

Merged
ianpittwood merged 56 commits into
mainfrom
documentation-content-updates
May 13, 2026
Merged

Restructure image READMEs and add HEALTHCHECK to Workbench#94
ianpittwood merged 56 commits into
mainfrom
documentation-content-updates

Conversation

@ianpittwood
Copy link
Copy Markdown
Contributor

Summary

  • Restructure root and image READMEs to match Posit Connect/Package Manager benchmarks; split contributor guidance into CONTRIBUTING.md; apply Posit style guide fixes
  • Rename Workbench env vars to the PWB_ prefix (with RSW_/RSP_ fallbacks) across templates, rendered Containerfiles, and startup.sh
  • Add a HEALTHCHECK polling /health-check to the workbench image
  • Update badges/logos, swap callout embedded links for HTML anchors, refresh license trial URL (docs: Point Docker README licensing sections at the trial form rstudio/rstudio-docker-products#1037), drop the supported tags section, and add storage mounting to examples

Test plan

  • bakery build --plan reflects no unintended template drift
  • bakery build succeeds for affected workbench versions (2025.09, 2026.01, 2026.04)
  • bakery run dgoss --image-name workbench passes, including the new HEALTHCHECK
  • Verify PWB_* env vars activate licensing and that legacy RSW_*/RSP_* fallbacks still work
  • Render docs locally / preview READMEs to confirm formatting and anchor links

🤖 Generated with Claude Code

ianpittwood and others added 13 commits May 11, 2026 06:33
Move the bakery build/test workflow out of README.md and into a
new CONTRIBUTING.md, mirroring the structure used by
images-package-manager. Apply remaining Posit style guide fixes:
sentence-case title and link labels, expand OCI on first use,
correct `just install-bakery` recipe name, and replace "existing"
with "previous" in the migration callout.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Aligns structure with package-manager/README.md (Quick reference table,
Supported tags, Architectures, Examples, Migrating from legacy section)
and recovers content lost from the legacy rstudio-docker-products README:
/home volume mount, license-manager status verification, sssd/LDAP user
provisioning, and supervisord process management.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Aligns structure with connect-content-init/README.md: adds Docker
badges, Supported tags, Quick reference, Related images, Helm chart
usage, Architectures, User, Examples, and a Migrating section.
Restores Posit Workbench Documentation, Community Forum, Posit Support,
and License links from the legacy rstudio-docker-products README.
Removes the inaccurate Ubuntu 22.04 tag listing (only Ubuntu 24.04
Containerfiles exist) and drops the Session components table that
incorrectly listed rserver.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Aligns the workbench-positron-init README with the connect-content-init
benchmark structure (badges, Supported tags, Quick reference, Related
images, Architectures, User, Migrating from legacy) while preserving the
Positron-specific Components, Environment variables, and Copy targets
sections. Recovers the Quick reference block and Containerfile link that
existed in the legacy rstudio-docker-products README.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Aligns the workbench-session README with the connect-content README
structure: adds Quick reference, Related images, Architectures, User,
Examples, Migrating from legacy image, and Caveats sections. Recovers
content dropped from the legacy rstudio/workbench-session and
r-session-complete READMEs, including the security review note,
dependency-license note, support article reference, and the bundled
runtimes (Jupyter, TinyTeX, Posit Professional Drivers). Calls out
that session components now ship via the workbench-session-init init
container rather than bundled into the image.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Declares a Docker HEALTHCHECK on the workbench image that polls the
Workbench `/health-check` endpoint via curl. The endpoint is already
enabled by the bundled rserver.conf (`server-health-check-enabled=1`),
so container runtimes report healthy/unhealthy out of the box.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Renames STARTUP_DEBUG_MODE, DIAGNOSTIC_ENABLE, and DIAGNOSTIC_DIR to
their PWB_-prefixed equivalents to match the convention used by other
Posit images. Also renames DIAGNOSTIC_ONLY to PWB_EXIT_AFTER_VERIFY for
a clearer description of its behavior, and documents it in the workbench
README env vars table.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Change callout embedded links to HTML anchors
@ianpittwood ianpittwood force-pushed the documentation-content-updates branch from 01772be to 6e6c78d Compare May 11, 2026 12:33
@ianpittwood ianpittwood changed the title Documentation content updates and PWB_ env var prefix Restructure image READMEs and add HEALTHCHECK to Workbench May 11, 2026
@ianpittwood ianpittwood marked this pull request as ready for review May 11, 2026 20:38
Comment thread workbench-positron-init/README.md Outdated
Comment thread workbench-positron-init/README.md
Comment thread workbench-session-init/README.md Outdated
Comment thread workbench-session-init/README.md Outdated
Comment thread workbench-session/README.md Outdated
Comment thread workbench/README.md Outdated
Comment thread workbench/README.md Outdated
Comment thread workbench/README.md Outdated
Comment thread workbench/README.md Outdated
Comment thread README.md Outdated
Comment thread workbench-positron-init/README.md Outdated
Comment thread workbench-session-init/README.md Outdated
Copy link
Copy Markdown
Contributor

@bschwedler bschwedler left a comment

Choose a reason for hiding this comment

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

Thank you for all your work in this!

@ianpittwood ianpittwood merged commit e8b982b into main May 13, 2026
115 of 119 checks passed
@ianpittwood ianpittwood deleted the documentation-content-updates branch May 13, 2026 19:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants