Skip to content

Commit

Permalink
fix: catalog-info.yaml name should be the repo name
Browse files Browse the repository at this point in the history
  • Loading branch information
Ned Batchelder committed Dec 18, 2023
1 parent 66eb2ab commit 19b91a5
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 2 deletions.
4 changes: 2 additions & 2 deletions oeps/processes/oep-0055-proc-project-maintainers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@ It is acceptable for a component to be maintained by a team or group as long as
that arrangement does not reduce the reachability of at least one maintainer or
reduce accountability for the above responsibilities. The maintaining team must
have ways of direct contact, such as an email address and a GitHub team, that
anyone can use to get ahold of someone - it is completely acceptable for the
anyone can use to get hold of someone - it is completely acceptable for the
team to figure out arrangements for list monitoring, such as an "on-call"
rotation.

Expand Down Expand Up @@ -362,7 +362,7 @@ As it is essential that maintainers are discoverable and reachable, the person
or persons responsible for maintaining a component should be listed in the
repository. Per :doc:`the backstage ADR
<oep-0055/decisions/0001-use-backstage-to-support-maintainers>` we will use a
``catalog-info.yaml`` file to capture the github handles for the maintainers of
``catalog-info.yaml`` file to capture the GitHub handles for the maintainers of
a repository.

Jobs of the Maintainer
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,7 @@ References
# 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: 'docs.openedx.org'
description: "The root documentation site for https://docs.openedx.org"
links:
Expand Down

0 comments on commit 19b91a5

Please sign in to comment.