Add repository READMEs, license, and contributor scaffolding#10
Merged
Conversation
Replace the placeholder root README with an overview of the specialized Workbench images, and add per-image READMEs that point users at the canonical registry (GAR for Google Cloud Workstations, GHCR for Azure ML) and the platform-specific setup documentation. Also corrects the repository URL in bakery.yaml. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Match images-workbench by including the project's MIT license and the Contributor Covenant 2.1 code of conduct at the repository root. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Provide just recipes for installing pre-commit hooks, the bakery CLI, and goss/dgoss, matching the contributor workflow used in images-workbench. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Run the doc-reviewer skill against the new READMEs and address every finding: replace em dashes with colons or sentence breaks, drop possessives on company and product names (Google, Google Cloud, Microsoft, Azure ML), convert passive constructions to active voice, remove bold from non-UI text, replace "may" with "can" for possibility, swap the slash in MCR/ACR for "and", and define OCI on first use. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 7 out of 7 changed files in this pull request and generated 6 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
| reported to the community leaders responsible for enforcement at | ||
| [INSERT CONTACT METHOD]. |
The repository builds with any OCI build tool (Docker, Podman, or Buildah), so the root README should not single out Docker as the prerequisite or in the no-local-tooling caveat. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The example code block already shows a podman build invocation; add podman to the bulleted tool list above so the prose matches. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Clarify that these images require product-specific licenses and that standard Workbench licenses do not work. Link to the relevant Posit solutions pages for licensing inquiries. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Add a pointer in the WGCW Image registries section to the US Central Artifact Registry URL, which renders a tag listing in a browser. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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.
Summary
bakeryworkflow that mirrorsimages-workbench.workbench-for-google-cloud-workstations/andworkbench-for-microsoft-azure-ml/, naming the canonical registry for each (GAR for Google Cloud Workstations, GHCR for Azure ML — with an explicit "do not use the MCR/ACR copy" callout).repository.urlinbakery.yaml(was pointing atimages-workbench).LICENSE.md(MIT, copy fromimages-workbench) andCODE_OF_CONDUCT.md(Contributor Covenant 2.1).justfilewithsetup,install-bakery,install-goss, andinitrecipes that match the contributor flow used inimages-workbench.may/can, slash in MCR/ACR, OCI definition).Test plan
[!IMPORTANT]callout display correctly.workbench-for-google-cloud-workstations/README.mdresolve.just setup,just install-bakery, andjust install-gosssucceed on a clean checkout.bakery build --planstill parses with the correctedrepository.url.🤖 Generated with Claude Code