From b3c596e72e025a5343d03d98088cd24875bc195b Mon Sep 17 00:00:00 2001 From: Feanil Patel Date: Fri, 17 Jun 2022 14:04:25 -0400 Subject: [PATCH] fixup! docs: Add an ADR for using Backstage to support OEP-55 --- .../0001-use-backstage-to-support-maintainers.rst | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/oeps/processes/oep-0055/decisions/0001-use-backstage-to-support-maintainers.rst b/oeps/processes/oep-0055/decisions/0001-use-backstage-to-support-maintainers.rst index 9b3be228b..09f88f224 100644 --- a/oeps/processes/oep-0055/decisions/0001-use-backstage-to-support-maintainers.rst +++ b/oeps/processes/oep-0055/decisions/0001-use-backstage-to-support-maintainers.rst @@ -8,7 +8,7 @@ Status .. TODO Upon Acceptance - * Update OEP to mention the catalog-info.ymal file instead of the readme. + * Update OEP to mention the catalog-info.yaml file instead of the readme. * Relevant link https://open-edx-proposals.readthedocs.io/en/latest/processes/oep-0055-proc-project-maintainers.html#documenting-maintainers Context @@ -47,6 +47,11 @@ Consequences * Backstage will also give us the ability to expose other health metrics to maintainers so they can more easily assess the components they own. +* As a result of adding the ``catalog-info.yaml`` file we end with two top-level + files that have very similar data. If this decision is not reversed after the + initial pilot, it may make sense to revisit this consequence and see if we can + consolidate this metadata into a single file. + Rejected Alternatives ********************* @@ -118,8 +123,10 @@ References # (Optional) The value can be the name of any known component. subcomponentOf: '' - # (Optional) The name of a different component or resource. - dependsOn: '' + # (Optional) An array of different components or resources. + dependsOn: + - '' + - '' .. _Backstage: https://backstage.io .. _catalog-info.yaml: https://backstage.io/docs/features/software-catalog/descriptor-format