Skip to content

Commit

Permalink
fixup! docs: Add an ADR for using Backstage to support OEP-55
Browse files Browse the repository at this point in the history
  • Loading branch information
Feanil Patel committed Jun 17, 2022
1 parent 1224840 commit 156868b
Showing 1 changed file with 22 additions and 7 deletions.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Use Backstage to Support Maintainers
####################################
0001 Use Backstage to Support Maintainers
#########################################

Status
******
Expand All @@ -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
************
Expand All @@ -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
*********************
Expand Down Expand Up @@ -83,13 +86,14 @@ References

* `Backstage`_ project site.

* `catalog-info.yaml` spec definition
* `catalog-info.yaml`_ spec definition

* 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'
Expand All @@ -101,11 +105,22 @@ References
annotations:
openedx.org/arch-interest-groups: "feanil"
spec:
# (Required) This can be a group(`group:<group_name>` or a user(`user:<github_username>`)
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: '<name_of_a_component>'
# (Optional) The name of a different component or resource.
dependsOn: '<component_or_resource>'
.. _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/

0 comments on commit 156868b

Please sign in to comment.