Skip to content

Commit 41a816a

Browse files
authored
Add image style guide (#614)
1 parent 03dbb97 commit 41a816a

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

modules/contributor/pages/docs/style-guide.adoc

+5
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,11 @@ The Google guide also includes it's own list of https://developers.google.com/st
103103

104104
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.
105105

106+
== Images
107+
108+
Please include an alt text when https://docs.asciidoctor.org/asciidoc/latest/macros/images/[embedding images].
109+
The alt text should describe what can be seen on the picture, to make the documentation more accessible.
110+
106111
== CRD documentation
107112

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

0 commit comments

Comments
 (0)