VIDSOL-345: Updated catalog info file #285
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the catalog-info.yaml file to align with Backstage standards by restructuring it into separate System and Component definitions with improved metadata annotations.
- Adds a new System definition for the video-react-ref-app
- Updates the Component definition with standardized naming and annotations
- Changes ownership from team-based to group-based (orgdata/vdk)
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| --- | ||
| apiVersion: backstage.io/v1alpha1 | ||
| kind: Component | ||
| kind: System |
There was a problem hiding this comment.
The 'kind: System' definition with 'type: library' at line 11 is inconsistent. Systems typically contain multiple components rather than being libraries themselves. Consider using 'kind: Component' if this represents a single library.
There was a problem hiding this comment.
🤦♂️ we follow copilot recommendation or we keep with System?
There was a problem hiding this comment.
You have the template ... you can assess.
Obviously, component cannot be in the first line. That must be system.
Component is the one in the second part, down below.
(Use english @VZaphod )
| kind: System | ||
| metadata: | ||
| name: vonage-video-react-app | ||
| name: video-react-ref-app # SERVICE NAME field |
There was a problem hiding this comment.
The comment 'SERVICE NAME field' is misleading since this is defined as a System of type 'library' (line 11), not a service. Update the comment to accurately reflect the entity type.
| name: video-react-ref-app # SERVICE NAME field | |
| name: video-react-ref-app # SYSTEM NAME field |
|
What is this PR doing?
Updates the catalog-info.yaml
How should this be manually tested?
What are the relevant tickets?
A maintainer will add this ticket number.
Resolves VIDSOL-345
Checklist
[x] Branch is based on
develop(notmain).[ ] Resolves a
Known Issue.[ ] If yes, did you remove the item from the
docs/KNOWN_ISSUES.md?[ ] Resolves an item reported in
Issues.If yes, which issue? Issue Number?