search

camaraproject / QualityOnDemand

Repository to describe, develop, document and test the QualityOnDemand API family
https://wiki.camaraproject.org/x/zwOeAQ
Apache License 2.0
42 stars 59 forks source link

Local links within API documentation have to be release specific #363

Open hdamker opened 4 weeks ago

hdamker commented 4 weeks ago

Problem description

There is currently one link within quality-on-demand.yaml this is pointing to main instead to the tagged release tree (line 13, https://raw.githubusercontent.com/camaraproject/QualityOnDemand/main/documentation/API_documentation/resources/QoD_latency_overview.PNG). If the file will be updated for upcoming version, also the documentation of the released version is impacted.

Expected behavior

The link should go into the release tree, e.g. for r1.2 to https://raw.githubusercontent.com/camaraproject/QualityOnDemand/r1.2/documentation/API_documentation/resources/QoD_latency_overview.PNG

For the Fall24 / v0.11.0 that can be handled within a patch release (-> adding Fall24 label)

Alternative solution

Any proposal which will come from Release Management to handle https://github.com/camaraproject/ReleaseManagement/issues/101

Additional context

hdamker commented 1 week ago

This issue will be best handled in context of the release PR for r1.3 (with v0.11.1), replacing main with r1.3. Afterwards the link can stay unchanged unless there is a change of the picture for an upcoming release.