Skip to content

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

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

Linting images referenced in documentation #18090

Closed
ad-m opened this issue Jan 19, 2022 · 0 comments
Closed

Linting images referenced in documentation #18090

ad-m opened this issue Jan 19, 2022 · 0 comments
Labels
enhancement:request Enhancement request submitted by anyone from the community

Comments

@ad-m
Copy link
Contributor

ad-m commented Jan 19, 2022

Is your feature request related to a problem? Please describe.

We might have an issue that our image is misreferenced in documentation. For example see at #18089 . This prevents the images from loading, which reduces the value of the documentation.

Describe the solution you'd like

I think we should introduce linting to verify that all referenced images in the documentation are loads properly.

I am currently familiarizing myself with this project and I do not know the whole CI & CD flow, but if someone has an obvious direction - I will gladly adapt it to this project.

Describe alternatives you've considered

We might periodically review if all images load correctly. We can also increase attention during review and follow guidelines, but this will not effectively prevent human omissions from such subtle inconsistencies as has been the case so far.

Additional context

N/A

@geido geido added the enhancement:request Enhancement request submitted by anyone from the community label Jan 24, 2022
This was referenced Jan 27, 2022
@apache apache locked and limited conversation to collaborators Feb 2, 2022
@geido geido converted this issue into discussion #18549 Feb 2, 2022

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

Labels
enhancement:request Enhancement request submitted by anyone from the community
Projects
None yet
Development

No branches or pull requests

2 participants