Skip to content

docs: Point Docker README licensing sections at the trial form#1037

Open
andrie wants to merge 1 commit into
rstudio:mainfrom
andrie:docs-fix/project-gateway-trial-readmes
Open

docs: Point Docker README licensing sections at the trial form#1037
andrie wants to merge 1 commit into
rstudio:mainfrom
andrie:docs-fix/project-gateway-trial-readmes

Conversation

@andrie
Copy link
Copy Markdown
Member

@andrie andrie commented May 8, 2026

Summary

The Connect, Workbench, and Package Manager Docker READMEs (rendered as the description on Docker Hub) tell first-time users that they need a "valid License" but never say where to get one. With the built-in 45-day trial removed under Project Gateway, this PR adds a one-sentence pointer to https://posit.co/trial-license/ in each README's Product Licensing intro.

It also reworks a stale comment in package-manager/Dockerfile.ubuntu2204 that referenced the built-in trial; the new wording preserves the operational meaning (userspace init can fail; activation can be retried) without referencing trials.

Changes

File Change
connect/README.md Add trial-license pointer sentence to Product Licensing intro
workbench/README.md Same
package-manager/README.md Same
package-manager/Dockerfile.ubuntu2204 Rework line-49 comment to drop trial reference

What's left as-is

The example license-manager status output (with Has-Trial / Trial-Type lines) is unchanged. The binary still prints those fields during the 7-day transitional period, so the example is still accurate. Best to revisit when the binary output itself changes.

Cross-references

  • Tracking: TWPM-434 — Documentation updates for Project Gateway
  • Wave 2 PRs already in flight: posit-dev/connect#39378 (approved), rstudio/package-manager#17931, rstudio/rstudio-pro#11013

Closes #1036

The Connect, Workbench, and Package Manager Docker READMEs (rendered as the
description on Docker Hub) tell users they need a valid license but never say
where to get one. With the built-in 45-day trial removed under Project Gateway,
add a one-sentence pointer to https://posit.co/trial-license/ in each Product
Licensing intro paragraph.

Also update a stale comment in package-manager/Dockerfile.ubuntu2204 that
references the built-in trial.

Closes rstudio#1036
@andrie andrie requested review from a team, cm421 and melissa-barca as code owners May 8, 2026 15:55
@andrie
Copy link
Copy Markdown
Member Author

andrie commented May 8, 2026

cc @bschwedler @glin @sarahsdao — requesting review.

@andrie andrie requested review from jonyoder and nunyunuymi and removed request for a team May 8, 2026 15:55
ianpittwood added a commit to posit-dev/images-connect that referenced this pull request May 8, 2026
ianpittwood added a commit to posit-dev/images-package-manager that referenced this pull request May 8, 2026
ianpittwood added a commit to posit-dev/images-workbench that referenced this pull request May 8, 2026
ianpittwood added a commit to posit-dev/images-package-manager that referenced this pull request May 8, 2026
@andrie
Copy link
Copy Markdown
Member Author

andrie commented May 10, 2026

Diagnosed the CI failures: every red "Build, Test, and Push" job is hitting Snyk authentication timeout (SNYK-CLI-0000: authentication failed (timeout)). The Snyk CLI tries to open an interactive browser auth flow because the SNYK_TOKEN secret isn't reaching the job, then times out after 2 minutes. Example: run 25565446955 / Connect job.

Notes:

  • This is unrelated to the changes in this PR — it only edits 3 README files and one Dockerfile comment.
  • The Lint workflow on the same SHA passed, so the issue is specific to the Snyk-using build workflows.
  • Main branch CI is also intermittent: today's 07:04 UTC run succeeded but 05:18 UTC failed, suggesting the Snyk auth path is flaky generally (or the secret isn't being passed to PR-triggered runs).
  • I tried gh run rerun --failed on both failed workflow runs; both returned "workflow file may be broken," so I can't retrigger from here.

@bschwedler @ianpittwood — could one of you check whether SNYK_TOKEN is configured to be available on pull_request-triggered runs, or push an empty commit to retrigger? Happy to push a no-op myself if that's the preferred path.

@ianpittwood
Copy link
Copy Markdown
Collaborator

@andrie we may have finally had our plan end for Snyk Container. I'll take a look tomorrow to fix it.

ianpittwood added a commit to posit-dev/images-workbench that referenced this pull request May 11, 2026
ianpittwood added a commit to posit-dev/images-connect that referenced this pull request May 11, 2026
@ianpittwood
Copy link
Copy Markdown
Collaborator

@andrie if you can rebase your change, it should work now. I didn't notice before that this was a fork though so there may still be permission issues.

ianpittwood added a commit to posit-dev/images-workbench that referenced this pull request May 13, 2026
* Split root README into README and CONTRIBUTING

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>

* Restructure workbench README to match Package Manager benchmark

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>

* Restructure workbench-session-init README to match Connect benchmark

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>

* Restructure workbench-positron-init README to match Connect benchmark

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>

* Restructure workbench-session README to match Connect benchmark

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>

* Add HEALTHCHECK polling /health-check endpoint to workbench image

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>

* Prefix workbench env vars with PWB_ for consistency

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>

* Update badges and logos

* Change callout embedded links to HTML anchors

* Pull upstream changes for license trial URL rstudio/rstudio-docker-products#1037

* Remove supported tags section

* amend! Change callout embedded links to HTML anchors

Change callout embedded links to HTML anchors

* Add storage mounting to examples

* Enable image size for latest tag

* Enable latest and image size positron init badges

* Run pre-commit

* Add product documentation to quick reference

* Fix k8s documentation

* Add an explicit env var default for PWB_POSITRON_TARGET

Matches the default used by our helm charts and generally makes this more obvious to users of the Containerfile/image

* Fix Kubernetes sections for workbench-session-init

* Fix alt text for logos

* Update documentation guidelines in CLAUDE.md

* Correct Workbench arch support

* Clarify ARM support for each image

* Fix Quarto install path for workbench-session/README.md

* Fix Job Launcher description

* Fixes to the Helm chart guide in README.md

* Remove duplicated link to CONTRIBUTING.md from README.md

* Fix env var definitions for workbench/README.md

* Sync licensing info with other images in workbench/README.md

* Fix up example tags and illustrative callouts in workbench/README.md

* Fixes to licensing caveats in workbench/README.md

* Fix user definition in workbench/README.md

* Grammar/formatting fixes for workbench/README.md

* Clarify that `r-session-complete` will not be supported by this repository in workbench-session/README.md

* Clarify how to pick a workbench-session image

* Remove Jupyter kernel from components in workbench-session/README.md

* Add migration section for Quarto install path change

* Grammar/formatting fixes for workbench-session/README.md

* Enable latest version badge for workbench-session/README.md

* Add product documentation to workbench-session-init/README.md quick reference

* Change forum links to target main pro products forum

* Add callout for version compatibility earlier in workbench-sesion-init/README.md

* Add environment variables section to explicitly state there are no env vars for workbench-session-init

* Clarify architectures support description in workbench-session-init/README.md

* Remove duplicated Workbench docs link from where to get help in workbench-session-init/README.md

* Grammar/formatting for workbench-session-init/README.md

* Add TIP callout for deploying on k8s in workbench-positron-init/README.md

* Clarify out-of-band upgrades in workbench-positron-init/README.md

* Add session image to helm values example in workbench-positron-init/README.md

* Fully qualify component paths in workbench-positron-init/README.md

* Clarify Ubuntu 24.04 only support in workbench-positron-init/README.md

* Remove documentation footer section in workbench-positron-init/README.md

* Grammar/formatting for workbench-positron-init/README.md

* Fix migrating from section header

* Fix launcher port publish in workbench/README.md

---------

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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.

docs: Point Docker README licensing sections at the trial form

2 participants