PR #11732 docs: Add description about img in artifact-visualization.md

뚜비·2023년 9월 9일
0

PR #11732 << 해당 PR을 확인할 수 있습니다.



서론

어떤 문제를 해결하고자 했는가?


멘토님 감사합니다.. 갓근철(멘토님) 갓근철(멘토님)
멘토님은 오픈소스 컨트리뷰션 대회 수상을 위해서 PR 개수를 늘려야겠다는 판단을 하셨고.. 슬랙에 문서기여를 할 수 있는 아이디어를 제공해주셨다.



Argo Workflows 공식문서에서 Artifact Visualization에 가보면 어떤 이미지를 볼 수 있는데, 지금은 변동되었답니다


알고보니 해당 이미지는 유튜브 영상 링크였다..

✅ 즉 해당 이미지가 유튜브 영상 링크임을 알아채기 어렵기 때문에 이를 알아볼 수 있는 mention을 추가해주기로 했다.


본론

ver.1과 피드백


block quote 안에 해당 mention과 이미지를 추가한 후 PR을 올렷다.



메인테이너 님이 승인하고, test만 통과되면 바로 auto-merge가 되도록 걸어두셨다! (그런데 내가 PR을 close 해버려서 auto-merge는 제거되었다는 슬픈 소식)



하지만 test 과정에서 위와 같은 에러가 발생하였고...

Member 분이 좀 더 깔끔하게 정리하고 lint가 실패되지 않도록 space 제거하는 등의 수정 작업을 도와주어 잘 해결되었다!



ver.2

그런데 Member 분이 1. 비디오를 바로 임베디드 하거나 2. play 버튼을 추가한 이미지를 사용해보자는 제안을 하셨다. 그래서 이미지를 바꾸어 보려고 했는데..

멘토님께서 새로운 이미지를 공개 저장소 어딘가에 업로드 해야 하는데, 이 저장소에 대한 신뢰성이 보장하기 어려워져서 고민이 된다며 제안을 주셨고...


Member 분은 괜찮다며 docs/assets에 이미 image 파일들이 올라가 있으니 하나 추가해보라고 피드백을 주셨다.

따라서 피드백에 따라 다시 commit을 날렸고!!!

야호 merge가 되었다!!!



결론

알게된 점

Disallowed Raw HTML (extension)
html에 <iframe> 태그를 활용하면 유튜브 영상을 직접 임베드할 수 있다는 것을 알게 되어 더 수정해보려고 했으나.. Github markdown에서는 <iframe> 태그를 지원하지 않는다는 것을 알았다.. 혹시라도 Github Markdown에서 동영상을 임베드하는 방법을 아는 분이라면 댓글을 남겨주시길!!!



느낀 점

사실 아주아주 매우 사소한 PR이지만.. 이런식으로 기여를 하다니 뿌듯하다..쉬운 것부터 기여하면서 점차 영향력있는 issue와 PR을 날려보겠다...

profile
SW Engineer 꿈나무 / 자의식이 있는 컴퓨터

0개의 댓글