Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
hdamker opened this issue Sep 20, 2024 · 1 comment
Open

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

hdamker opened this issue Sep 20, 2024 · 1 comment
Labels
correction correction in documentation or alignment with commonalities Fall24 Relevant for maintenance of Fall24 release

Comments

@hdamker
Copy link
Collaborator

hdamker commented Sep 20, 2024

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 camaraproject/ReleaseManagement#101

Additional context

@hdamker hdamker added Fall24 Relevant for maintenance of Fall24 release correction correction in documentation or alignment with commonalities labels Sep 20, 2024
@hdamker
Copy link
Collaborator Author

hdamker commented Oct 9, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
correction correction in documentation or alignment with commonalities Fall24 Relevant for maintenance of Fall24 release
Projects
None yet
Development

No branches or pull requests

1 participant