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 156868b commit b3c596e
Showing 1 changed file with 10 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
*********************

Expand Down Expand Up @@ -118,8 +123,10 @@ References
# (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>'
# (Optional) An array of different components or resources.
dependsOn:
- '<component_or_resource>'
- '<another_component_or_resource>'
.. _Backstage: https://backstage.io
.. _catalog-info.yaml: https://backstage.io/docs/features/software-catalog/descriptor-format
Expand Down

0 comments on commit b3c596e

Please sign in to comment.