awslabs/duvet

Reference links in annotations dependent on `target` argument

Opened this issue · 3 comments

eagr commented

I noticed that the reference links we get from copying a requirement in the report relies on the target of duvet extract. Do you think that it's reasonable to decouple them?

The expected outcome would be executing duvet extract with a local file as target, but somehow being able to have urls pointing to specific sections of the desired spec in the generated report.

camshaft commented

We plan on introducing a config file to enumerate target aliases and canonical URLs. It would look something like:

[[compliance.spec.ietf]]
id = "quic-transport"
title = "QUIC: A UDP-Based Multiplexed and Secure Transport"
url = "https://www.rfc-editor.org/rfc/rfc9000.txt"
aliases = [
    "https://datatracker.ietf.org/doc/html/rfc9000",
    "https://www.rfc-editor.org/rfc/rfc9000.html",
    "./path/to/local/rfc9000.txt",
]
  • 👍1
eagr commented 
url = "https://www.rfc-editor.org/rfc/rfc9000.txt"

This field alone would probably fix the problem I had. Curious what are the aliases for?

camshaft commented

There are potentially many ways to refer to a spec and this would configure all of those resources as equivalent. So if you referred to datatracker.ietf.org or www.rfc-editor.org in your source it wouldn't matter; it would all be considered the same specification.