Skip to content

Commit

Permalink
docs: create catalog-info.yaml file (#622)
Browse files Browse the repository at this point in the history
  • Loading branch information
bcitro authored Jan 17, 2025
1 parent 6c6c844 commit 21051f2
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions catalog-info.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# This file records information about this repo. Its use is described in OEP-55:
# https://open-edx-proposals.readthedocs.io/en/latest/processes/oep-0055-proc-project-maintainers.html

apiVersion: backstage.io/v1alpha1
# (Required) Acceptable Values: Component, Resource, System
# Use `Component` unless you know how backstage works and what the other kinds mean.
kind: Component
metadata:
# (Required) Must be the name of the repo, without the owning organization.
name: 'enterprise-access'
description: "Service to manage access to content for enterprise users"
annotations:
# (Optional) Annotation keys and values can be whatever you want.
# We use it in Open edX repos to have a comma-separated list of GitHub user
# names that might be interested in changes to the architecture of this
# component.
openedx.org/arch-interest-groups: ""
# (Optional) We use the below annotation to indicate whether or not this
# repository should be tagged for openedx releases and which branch is tagged.
openedx.org/release: ""
spec:

# (Required) This can be a group (`group:<github_group_name>`) or a user (`user:<github_username>`).
# Don't forget the "user:" or "group:" prefix. Groups must be GitHub team
# names in the openedx GitHub organization: https://github.com/orgs/openedx/teams
#
# If you need a new team created, create an issue with Axim engineering:
# https://github.com/openedx/axim-engineering/issues/new/choose
owner: group:2u-enterprise

# (Required) Acceptable Type Values: service, website, library
type: 'service'

# (Required) Acceptable Lifecycle Values: experimental, production, deprecated
lifecycle: 'production'

# (Optional) The value can be the name of any known component.
subcomponentOf: '<name_of_a_component>'

# (Optional) An array of different components or resources.
dependsOn:
- '<component_or_resource>'
- '<another_component_or_resource>'

0 comments on commit 21051f2

Please sign in to comment.