Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(backstage): Add catalog-info.yaml config file #26

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

jburns24
Copy link
Contributor

This pull request adds a Backstage entity metadata file to this repository so that the component can be added to the Liatrio's Backstage software catalog.

After this pull request is merged, the component will become available.

For more information, read an overview of the Backstage software catalog.

@jburns24 jburns24 changed the title Add catalog-info.yaml config file chrore: Add catalog-info.yaml config file Aug 14, 2023
@jburns24 jburns24 changed the title chrore: Add catalog-info.yaml config file chore(backstage): Add catalog-info.yaml config file Aug 14, 2023
@caseyw
Copy link

caseyw commented Aug 14, 2023

@jburns24 I'd probably add some tags, so we can see them listed in the catalog view. It'd allow us to do some sorting, searching, etc.

@jburns24
Copy link
Contributor Author

@caseyw I was considering tags but was unsure what good tags for this component should be. Poor tagging in a system like Backstage would hurt sorting and searching. While a good tagging convention helps. These workflows are used for a wide variety of things and the repo name is the best generalized tag I could think of. Now maybe github-wrokflows is the tag we should put here?

Given the risk of adding crap tags I was thinking I would hold off on that until we came up with some tagging standards or something of the sort. Mostly I want to get this in so I can start building out relationships with other repos.

If you think missing tagging blocks the PR I would appreciate input on what kind of tags you think would be valuable for a repo like this.

@caseyw
Copy link

caseyw commented Aug 14, 2023

You're absolutely right. The way @gesparza3 explained it to me is that tags represent the repository. So in this case I think it would be GitHub and workflows, and any tech used to make that happen.

Examples:
https://github.com/liatrio/gratibot/blob/main/catalog-info.yaml
https://github.com/liatrio/openo11y.dev/blob/main/catalog-info.yaml

I'd defer to @gesparza3 in the end.

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.

None yet

2 participants