Skip to content
New issue

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

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

Already on GitHub? # to your account

Picture/Diagram missing on Documentation page Triggers and EventListeners #340

Closed
vovtz opened this issue Feb 8, 2022 · 13 comments · Fixed by tektoncd/triggers#1311 or #490
Closed

Comments

@vovtz
Copy link
Contributor

vovtz commented Feb 8, 2022

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

  1. Open https://tekton.dev/docs/triggers/ in a browser

Additional Info

The SVG images URL is https://tekton.dev/docs/images/TriggerFlow.svg

@AlanGreene
Copy link
Member

@tektoncd/triggers-maintainers fyi

@afrittoli
Copy link
Member

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.

@AlanGreene
Copy link
Member

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.

@khrm
Copy link
Contributor

khrm commented Feb 14, 2022

Sure, I would move the images folder under the docs folder. It's fast and simple.

@vovtz
Copy link
Contributor Author

vovtz commented Feb 14, 2022

Thanks for the fast resolution. When will this result in a change of the effected website page (https://tekton.dev/docs/triggers/)?

@khrm
Copy link
Contributor

khrm commented Feb 15, 2022

@afrittoli I think placing images folder inside triggers docs folders didn't solve this. Or is the website yet to be rebuilt?

@afrittoli
Copy link
Member

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

@afrittoli afrittoli reopened this Feb 15, 2022
afrittoli added a commit to afrittoli/tektoncd-website that referenced this issue Feb 15, 2022
Pull in SVG images from triggers docs/images into the main docs
folder, so that we can display it correctly.

Partially addresses tektoncd#340

Signed-off-by: Andrea Frittoli <andrea.frittoli@gmail.com>
afrittoli added a commit to afrittoli/tektoncd-website that referenced this issue Feb 15, 2022
Pull in SVG images from triggers docs/images into the main docs
folder, so that we can display it correctly.

Handle rewriting links in images with the "src" attribute.
Extend unit tests accordingly.

Partially addresses tektoncd#340

Signed-off-by: Andrea Frittoli <andrea.frittoli@gmail.com>
afrittoli added a commit to afrittoli/tektoncd-website that referenced this issue Feb 15, 2022
Pull in SVG images from triggers docs/images into the main docs
folder, so that we can display it correctly.

Handle rewriting links in images with the "src" attribute.
Extend unit tests accordingly.

Partially addresses tektoncd#340

Signed-off-by: Andrea Frittoli <andrea.frittoli@gmail.com>
afrittoli added a commit to afrittoli/tektoncd-website that referenced this issue Feb 16, 2022
Pull in SVG images from triggers docs/images into the main docs
folder, so that we can display it correctly.

Handle rewriting links in images with the "src" attribute.
Extend unit tests accordingly.

Partially addresses tektoncd#340

Signed-off-by: Andrea Frittoli <andrea.frittoli@gmail.com>
afrittoli added a commit to afrittoli/tektoncd-website that referenced this issue Feb 16, 2022
Pull in SVG images from triggers docs/images into the main docs
folder, so that we can display it correctly.

Handle rewriting links in images with the "src" attribute.
Extend unit tests accordingly.

Partially addresses tektoncd#340

Signed-off-by: Andrea Frittoli <andrea.frittoli@gmail.com>
afrittoli added a commit to afrittoli/tektoncd-website that referenced this issue Feb 17, 2022
Pull in SVG images from triggers docs/images into the main docs
folder, so that we can display it correctly.

Handle rewriting links in images with the "src" attribute.
Extend unit tests accordingly.

Partially addresses tektoncd#340

Signed-off-by: Andrea Frittoli <andrea.frittoli@gmail.com>
afrittoli added a commit to afrittoli/tektoncd-website that referenced this issue Feb 17, 2022
Pull in SVG images from triggers docs/images into the main docs
folder, so that we can display it correctly.

Handle rewriting links in images with the "src" attribute.
Extend unit tests accordingly.

Partially addresses tektoncd#340

Signed-off-by: Andrea Frittoli <andrea.frittoli@gmail.com>
@AlanGreene
Copy link
Member

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: #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?

@tekton-robot
Copy link

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.

@tekton-robot tekton-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jul 25, 2022
@vovtz
Copy link
Contributor Author

vovtz commented Jul 29, 2022

/remove-lifecycle stale

Still looks like:

image

@tekton-robot tekton-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jul 29, 2022
@vovtz
Copy link
Contributor Author

vovtz commented Jul 29, 2022

The <img/> tag references https://tekton.dev/docs/triggers/images/TriggerFlow.svg (indirectly, by specifying path ./images/TriggerFlow.svg), which doesn’t exist.

@tekton-robot
Copy link

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.

@tekton-robot tekton-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Oct 27, 2022
@AlanGreene
Copy link
Member

/remove-lifecycle stale

@tekton-robot tekton-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Oct 27, 2022
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
Status: Done
5 participants