tektoncd
Picture/Diagram missing on Documentation page Triggers and EventListeners
Expected Behavior
All images/diagrams in the documentation are present
Actual Behavior
The SVG image about the Trigger Flow does not exist (shows a broken image icon) on the Triggers and EventListeners page
Steps to Reproduce the Problem
- Open https://tekton.dev/docs/triggers/ in a browser
Additional Info
The SVG images URL is https://tekton.dev/docs/images/TriggerFlow.svg
I looked a bit at this one, and the problem is that the image is not stored along with the docs, but in an images folder, which is a peer of the docs one. I suspect the easiest fix here would be to move the image around, possibly place the images folder under docs in the triggers repo would help already.
Alternatively we could add logic to the sync script to handle shared images, e.g.:
- each project could specify one shared images folder
- those images could be copied into the hugo static content folder, in a project/version specific subfolder
- links to the image would be overwritten accordingly
This would quite a bit of engineering to be done for a feature that I'm not convinced we need.
I'd be in favour of the easier approach here:
I suspect the easiest fix here would be to move the image around, possibly place the images folder under docs in the triggers repo would help already.
Sure, I would move the images folder under the docs folder. It's fast and simple.
Thanks for the fast resolution. When will this result in a change of the effected website page (https://tekton.dev/docs/triggers/)?
@afrittoli I think placing images folder inside triggers docs folders didn't solve this. Or is the website yet to be rebuilt?
Thanks @khrm I need to update the website config to include the new folder. Once I've done that it should on the "main" branch docs. If you want to fix it on the docs associated to a release you'll need to backport the fix to the branch
This came up during the Docs WG today when reviewing potential issues for new contributors.
@afrittoli I see you have a PR open for this already: https://github.com/tektoncd/website/pull/351
Does it still require more work? If so, do you think you'll have bandwidth to work on it or does it need a new owner?
Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale with a justification.
Stale issues rot after an additional 30d of inactivity and eventually close.
If this issue is safe to close now please do so with /close with a justification.
If this issue should be exempted, mark the issue as frozen with /lifecycle frozen with a justification.
/lifecycle stale
Send feedback to tektoncd/plumbing.
The <img/> tag references https://tekton.dev/docs/triggers/images/TriggerFlow.svg (indirectly, by specifying path ./images/TriggerFlow.svg), which doesn’t exist.
Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale with a justification.
Stale issues rot after an additional 30d of inactivity and eventually close.
If this issue is safe to close now please do so with /close with a justification.
If this issue should be exempted, mark the issue as frozen with /lifecycle frozen with a justification.
/lifecycle stale
Send feedback to tektoncd/plumbing.