Skip to content

Add image style guide #614

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
May 31, 2024
Merged

Add image style guide #614

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions modules/contributor/pages/docs/style-guide.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,11 @@ The Google guide also includes it's own list of https://developers.google.com/st

Lastly, these are guidelines and not strict rules to follow. Use your own judgement to clearly communicate and explain - after all this is what documentation is about.

== Images

Please include an alt text when https://docs.asciidoctor.org/asciidoc/latest/macros/images/[embedding images].
The alt text should describe what can be seen on the picture, to make the documentation more accessible.

== CRD documentation

In general, follow the other guidelines. In particular, use PascalCase for API objects and `code style` for object properties.
Expand Down