🚀 ADR: Annotation doesn't support local references (similar to techdocs)

[christoph-jerolimov]

Workspace

adr

🔖 Feature description

It looks to me that the ADR plugin can load the ADR markdown files currently just from external sources, or?

https://github.com/backstage/community-plugins/blob/main/workspaces/adr/plugins/adr-backend/src/service/router.ts#L33C11-L33C27

This makes it hard(er) to test ADRs locally. TechDocs for example using mostly a relative path that allows local testing:

  annotations:
    backstage.io/techdocs-ref: dir:.
    # at the moment the adr plugin doesn't support local paths, so it can only render what's pushed already :-/
    backstage.io/adr-location: https://github.com/......./adrs

🎤 Context

Using the plugin with a local catalog-info.yaml that reference a local techdocs and adr folder.

ADR doesn't support this currently.

✌️ Possible Implementation

No response

👀 Have you spent some time to check if this feature request has been raised before?

• I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

• I have read the Code of Conduct

Are you willing to submit PR?

No, I don't have time to work on this right now

[vinzscam]

cc @kuangp

[kuangp]

Hi @christoph-jerolimov - happy to welcome contributions if you or someone else wants to implement this support