Update catalog info #3
Open
Conversation
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
…//app.backstage.wayflyer.team). Please note that the Backstage app is only viewable if you are on the VPN. 🤓 Fill in the placeholders with data and merge to populate the [table](https://app.backstage.wayflyer.team/catalog?filters%5Bkind%5D=component&filters%5Buser%5D=all)! 📈 Over time, Backstage will introduce more features to the component views and form the basis of our centralised view of software. 🤩 Expand the section below for an explanation of what each of the fields mean and the acceptable values for them. You can see an example [here](https://www.notion.so/wayflyer/Backstage-1584d940aa1d4bcd95d38bd425b003fd). 👀 <details> - `apiVersion` -- The version of the Catalog file. This should be set to "backstage.io/v1alpha1". - `kind` -- The kind of Backstage entity this file represents. We currently only support 'Component'. - `metadata:name` -- The name of your Backstage component. Give it a clear, sensible and easily-searchable name. - `metadata:description` -- Briefly describe this component here to help others understand what this does. - `metadata:annotations:github.com/project-slug` -- An annotation that allows for Backstage to associate the component with a Github repo. Set this to the Github repo, including the 'wayflyer' org (e.g. wayflyer/wayflyer). - `spec:type` -- The type of the component. We currently support 'service', 'website' or 'library'. - `spec:lifecycle` -- The readiness of the component. We currently support 'experimental', 'production' or 'deprecated'. - `spec:owner` -- The owner of this component. This should be a team (which Backstage calls a 'group'). You can see the acceptable values [here](https://app.backstage.wayflyer.team/catalog?filters%5Bkind%5D=group&filters%5Buser%5D=all). </details> Does this repo contain multiple components? Read how to express that [here](https://www.notion.so/wayflyer/Backstage-1584d940aa1d4bcd95d38bd425b003fd)!
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.
This PR populates the
catalog-info.yamlfile for Backstage.Please note that the Backstage app is only viewable if you are on the VPN. 🤓
Fill in the placeholders with data and merge to populate the table! 📈
Over time, Backstage will introduce more features to the component views and form the basis of our centralised view of software. 🤩
Expand the section below for an explanation of what each of the fields mean and the acceptable values for them. You can see an example here. 👀
Details
apiVersion-- The version of the Catalog file. This should be set to "backstage.io/v1alpha1".kind-- The kind of Backstage entity this file represents. We currently only support 'Component'.metadata:name-- The name of your Backstage component. Give it a clear, sensible and easily-searchable name.metadata:description-- Briefly describe this component here to help others understand what this does.metadata:annotations:github.com/project-slug-- An annotation that allows for Backstage to associate the component with a Github repo. Set this to the Github repo, including the 'wayflyer' org (e.g. wayflyer/wayflyer).spec:type-- The type of the component. We currently support 'service', 'website' or 'library'.spec:lifecycle-- The readiness of the component. We currently support 'experimental', 'production' or 'deprecated'.spec:owner-- The owner of this component. This should be a team (which Backstage calls a 'group'). You can see the acceptable values here.Does this repo contain multiple components? Read how to express that here!