-
Notifications
You must be signed in to change notification settings - Fork 3.1k
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
docs: Add description about img in artifact-visualization.md #11732
Conversation
Signed-off-by: juijeong8324 <juijeong8324@gmail.com> Signed-off-by: Justice <juijeong8324@gmail.com>
Signed-off-by: juijeong8324 <juijeong8324@gmail.com> Signed-off-by: Justice <juijeong8324@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I didn't even know this was a video, nice change!
I am thinking though that there are better, more conventional ways of indicating that it is a video:
- Embed the video directly in the page
- Use an image with a play button in the middle (or otherwise overlay such a play button)
Co-authored-by: Anton Gilgur <4970083+agilgur5@users.noreply.github.com> Signed-off-by: Justice <juijeong8324@gmail.com>
Head branch was pushed to by a user without write access
Signed-off-by: GeunSam2 <rootiron96@gmail.com>
Signed-off-by: GeunSam2 <rootiron96@gmail.com>
…juijeong8324 Fix/docs lint error for juijeong8324
@GeunSam2 suggests to me as follows... |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Consequently, I opted to add a caption at the bottom of the image!
This is still an improvement over what it was before, so I'm ok with this.
For other readers/reviewers, see the rendered version
The docs/assets/ directory has many images already, so one could be added there. |
Add artifact-visualization-demo.png at docs/assets Signed-off-by: Justice <juijeong8324@gmail.com>
Signed-off-by: Justice <juijeong8324@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice! LGTM, thanks for iterating on this!
Actually I have tried to use |
Yea it's not allowed in GH Markdown (no interactive elements basically), but I would think it would work on the rendered docs site. Did it not work on the docs site? |
Motivation
It is difficult to know that img can link to play demo.
Modifications
Therefore I add description of img.
Verification
.