Skip to content

Conversation

@loujaybee
Copy link

This PR implements the Backstage catalog standardization requirements defined in RFC-2024-023.

Changes Made

  • Created catalog-info.yaml with automated fields
  • All automated fields populated based on repository analysis
  • File validated using @roadiehq/backstage-entity-validator

What Was Automated

Field Value Rationale
metadata.name workshop Derived from repository name
metadata.description Full-stack portfolio manager workshop... From README (under 200 chars)
metadata.tags javascript, documentation, internal + tech stack RFC-required tags
spec.type documentation Educational workshop repository
spec.lifecycle production Actively maintained with recent commits

Requires Manual Review

  • spec.owner: Replace team:REPLACE_WITH_TEAM_NAME with the team responsible for this component (e.g., team:developer-experience)
  • Review all automated fields for accuracy

Note: spec.system is not required for documentation type components per RFC-2024-023.

Validation

✅ Passed Backstage entity validation

Validating Entity Schema policies for file catalog-info.yaml
Validated entity kind 'component' successfully.
Entity Schema policies validated

Please review the automated fields and complete the manual items before merging.

Add catalog-info.yaml to comply with organization-wide Backstage catalog
standardization requirements.

Automated fields populated based on repository analysis:
- Component type: documentation (workshop/tutorial repository)
- Lifecycle: production (actively maintained)
- Tags: javascript, react, nodejs, express, vite, devcontainer

Manual review required for spec.owner field.

Co-authored-by: Ona <[email protected]>
@loujaybee
Copy link
Author

⚠️ Manual Action Required

While most of the catalog metadata has been populated automatically, the following fields require your input:

Required Manual Fields

spec.owner (Line 27)

  • Current: team:REPLACE_WITH_TEAM_NAME
  • Action needed: Replace with your team identifier (e.g., team:developer-experience, team:platform-engineering)
  • See team registry for valid team names

Please Review

  • Verify the component description accurately reflects the purpose
  • Confirm the technology tags are complete
  • Ensure the lifecycle state (production) is correct

Note: spec.system is not required for documentation type components per RFC-2024-023, so no action is needed there.


Once you've completed these items, this component will be fully compliant with RFC-2024-023.

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.

2 participants