[DOC-14369] Add an icon page#51
Conversation
| @@ -0,0 +1,43 @@ | |||
| = Icons | |||
|
|
|||
There was a problem hiding this comment.
| Use icons in the Couchbase documentation when: | |
| * You need to describe a clickable element in the UI that does not have a name label. | |
| * The clickable element is a Font Awesome icon. | |
sarahlwelton
left a comment
There was a problem hiding this comment.
Sorry, but this doesn't tie into the existing documentation we have on style very well.
See:
^ Particularly that final bullet.
Same thing here:
^ Particularly the last bullet, again, and again, stating that a button might not have a defined border or colour/the X icon that's highlighted in the example image.
If we want to add this guidance, we need to do some more thinking about how to incorporate it into the existing guidance around buttons. Because really, an "icon" is still a button - at least the way you're describing it here.
You can leave this with me and I can make the changes, or you can take another stab at it. Let me know.
|
@sarahlwelton I'll take another stab at it as - it seems like we're saying that since icons in the UI are always buttons, we should have the the style requirements for icons be within the same "Button Macro" page. I'll adjust the content to follow that feedback. |
In the UI Elements section, create a page for Icons.
The icons we use in the docs are Font Awesome V4.
Have the style for icons be something along the lines of: "click IconCopy (icon:fontawesome-icon[])." or if the button doesn’t have any copy, it could be written as "click icon:fontawesome-icon[]."
Images of Local Build: