Skip to content

docs(quay): enhance workspace-level README - #10140

Merged
christoph-jerolimov merged 1 commit into
backstage:mainfrom
AhnfLabib:fix-issue-4056
Jul 28, 2026
Merged

docs(quay): enhance workspace-level README#10140
christoph-jerolimov merged 1 commit into
backstage:mainfrom
AhnfLabib:fix-issue-4056

Conversation

@AhnfLabib

Copy link
Copy Markdown
Contributor

What does this PR do?

Replaces the default scaffolded README in workspaces/quay with 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, while workspaces/quay still 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:

  • Removed the workspace README regression test (docs-only PRs do not need that coverage)
  • Signed the commit with DCO (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):

# Backstage

This is your newly scaffolded Backstage App, Good Luck!

To start the app, run:

yarn install
yarn start

After: workspace title + purpose, Plugins section linking all four Quay packages, and Quick start install commands.

Does this PR meet the acceptance criteria?

  • Tests added for new/changed behavior — N/A (docs-only; no runtime behavior; test removed per maintainer request on Fix issue 4056 #9538)
  • All tests passing — CI checks should run on this PR (DCO, quay workspace CI/verify)
  • Follows project style guide — matches existing enhanced workspace README pattern (docs: improve workspace-level READMEs for selected workspaces #6852 / announcements)
  • No breaking changes introduced
  • Documentation updated (if applicable)
  • All commits have a Signed-off-by line

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>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@AhnfLabib AhnfLabib mentioned this pull request Jul 28, 2026
5 tasks

@christoph-jerolimov christoph-jerolimov left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This looks good to me now. Thanks for this improvement.

@christoph-jerolimov
christoph-jerolimov merged commit 46521f1 into backstage:main Jul 28, 2026
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants