Restructure docs, add session README, remove default user#45
Merged
bschwedler merged 1 commit intomainfrom Mar 24, 2026
Merged
Conversation
Restructure documentation to lead with running images and Helm deployment, moving build instructions below. Top-level README: - Add prerequisites (Docker, Helm, kubectl, product license) - Add "Running the Images" section with installation guide - Add Helm deployment with license secret, explicit tags, and rserver.conf session init container configuration - Explain session image tag auto-construction - Update build examples to ubuntu2404 Containerfiles - Add hyperlinks to Docker Hub and GHCR in image table workbench/README.md: - Use short version tag and license path env var in Quick Start - Pass PWB_TESTUSER and PWB_TESTUSER_PASSWD explicitly - Add data persistence warning - Document Ubuntu 24.04 as default OS with all tag formats - Use product license terminology with Licensing FAQ link workbench-session/README.md (new): - Document session images, tag format, and usage workbench-session-init/README.md: - Update OS defaults to Ubuntu 24.04 workbench-positron-init/README.md: - Update status banner Containerfiles (all versions and templates): - Clear default PWB_TESTUSER, PWB_TESTUSER_PASSWD, and PWB_TESTUSER_UID values. Test user is only created when env vars are explicitly set, eliminating well-known default credentials. All READMEs: - Update status banner to preview language - Fix "definitions" and "an ephemeral" typos
bschwedler
force-pushed
the
readme-updates
branch
from
1769a87 to
ccad424
Compare
bschwedler
changed the title
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
1 participant
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.
Summary
Restructure documentation to lead with running images and Helm deployment, moving build instructions below. Remove default test user credentials from container images.
Top-level README:
rserver.confsession init container configurationworkbench/README.md:
PWB_TESTUSERandPWB_TESTUSER_PASSWDexplicitlyworkbench-session/README.md (new):
workbench-session-init/README.md:
Containerfiles (all versions and templates):
PWB_TESTUSER,PWB_TESTUSER_PASSWD, andPWB_TESTUSER_UIDvaluesAll READMEs:
Part of a coordinated documentation update across the Posit Container Image ecosystem.