docs(quay): enhance workspace-level README - #10140
Merged
Merged
Conversation
Replace the default scaffolded README with a workspace overview that describes the Quay workspace and lists its plugins (quay, quay-backend, quay-actions, quay-common) with links to each plugin's README and a brief description. Addresses backstage#4056. Signed-off-by: Ahnaf Labib <ahnaflabib212@gmail.com> Co-authored-by: Cursor <cursoragent@cursor.com>
AhnfLabib
requested review from
a team,
CryptoRodeo,
Eswaraiahsapram,
HusneShabbir,
caugello,
christoph-jerolimov,
ciiay,
debsmita1,
divyanshiGupta,
djanickova,
dzemanov,
its-mitesh-kumar,
jrichter1,
karthikjeeyar,
lokanandaprabhu and
rohitkrai03
as code owners
July 28, 2026 01:51
christoph-jerolimov
approved these changes
Jul 28, 2026
christoph-jerolimov
left a comment
Member
There was a problem hiding this comment.
This looks good to me now. Thanks for this improvement.
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.
What does this PR do?
Replaces the default scaffolded README in
workspaces/quaywith a workspace-specific overview. The new README describes the Quay workspace purpose, lists its four packages (quay,quay-backend,quay-actions,quay-common) with links and short descriptions, and adds a quick-start install snippet that points to the per-plugin READMEs.Why was this PR needed?
Issue #4056 asks for stronger workspace-level READMEs so contributors can understand what each workspace contains. Investigation showed that
workspaces/analytics(my original target) was already improved in #6852, whileworkspaces/quaystill used the boilerplate "This is your newly scaffolded Backstage App, Good Luck!" text despite being a multi-plugin workspace. This change follows the format used by gold-standard workspace READMEs (e.g.announcements) and the precedent of #6852.This is a follow-up to closed PR #9538. Per maintainer feedback:
Signed-off-by: Ahnaf Labib <ahnaflabib212@gmail.com>)What are the relevant issue numbers?
Addresses #4056
Screenshots / Recordings (if applicable)
Documentation-only change (no UI or backend runtime). Before/after of
workspaces/quay/README.md:Before (scaffold):
After: workspace title + purpose, Plugins section linking all four Quay packages, and Quick start install commands.
Does this PR meet the acceptance criteria?