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 eb829ba72..bf09c9f3b 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 @@ -1,5 +1,5 @@ -Use Backstage to Support Maintainers -#################################### +0001 Use Backstage to Support Maintainers +######################################### Status ****** @@ -21,13 +21,16 @@ Context * As a community member it is currently difficult to quickly look up who the maintainers are for multiple components quickly. +* Given the number of repos that make up the Open edX platform and the + complexity of the job of maintaining them, we need a system for cataloging, + and making transparent the critical details of our repositories. Decision ******** To solve the above issues and to enable the potential to ease other discoverability and maintainership burdens, the Open edX community shall -maintain a backstage instance and related metadata. +maintain a `backstage`_ instance and related metadata. Consequences ************ @@ -42,7 +45,7 @@ Consequences code, documentation, owners, etc. * Backstage will also give us the ability to expose other health metrics to - maintainers so they can more easily asses the components they own. + maintainers so they can more easily assess the components they own. Rejected Alternatives ********************* @@ -87,9 +90,10 @@ References * Sample ``catalog-info.yaml`` file: - .. code:: + .. code:: yaml apiVersion: backstage.io/v1alpha1 + # (Required) Acceptable Values: Component, Resource, System kind: Component metadata: name: 'docs.openedx.org' @@ -101,11 +105,23 @@ References annotations: openedx.org/arch-interest-groups: "feanil" spec: + + # (Required) This can be a group(`group:` or a user(`user:`) owner: group:docs.edx.org-maintainers + + # (Required) Acceptable Type Values: service, website, library type: 'website' + + # (Required) Acceptable Lifecycle Values: experimental, production, deprecated lifecycle: 'production' + # (Optional) The value can be the name of any known component. + subcomponentOf: '' + + # (Optional) The name of a different component or resource. + dependsOn: '' .. _catalog-info.yaml: https://backstage.io/docs/features/software-catalog/descriptor-format .. _Backstage: https://backstage.io +.. _catalog-info.yaml: https://backstage.io/docs/features/software-catalog/descriptor-format .. _single pane of glass: https://www.webopedia.com/definitions/single-pane-of-glass/