docs(material/icon): update the FontAwesome example link #24954
Conversation
Fixed the FontAwesome link.
victorwvieira
changed the title
|
Thanks for catching this! Can you update your commit message to follow these Commit Message Guidelines (right now that is causing the lint CI test to fail). |
|
Sorry, my fault. I changed the commit accordingly to the guideline. |
victorwvieira
changed the title
src/material/icon/icon.md
Outdated
| @@ -27,7 +27,7 @@ use the desired font, or to an alias previously registered with | |||
|
|
|||
| Fonts can also display icons by defining a CSS class for each icon glyph, which typically uses a | |||
| `:before` selector to cause the icon to appear. | |||
| [FontAwesome](https://fortawesome.github.io/Font-Awesome/examples/) uses this approach to display | |||
| [FontAwesome](https://github.com/FortAwesome/angular-fontawesome) uses this approach to display | |||
There was a problem hiding this comment.
I'm not sure that this is the correct link since it points to FontAwesome's own Angular component. I think that the old link was showing some examples of the actual icons. Maybe we should link to this instead? https://fontawesome.com/icons
There was a problem hiding this comment.
I understand your point @crisbeto, to be honest I don't know what the broken link was showing, if was just icons examples or implementations examples.
In my situation I was looking for examples of how to start use the FontAwesome and not just the icon itself, than the github angular-fontawesome helped me in the both situation, how to do de integration and also where I can check the icons. This is the reason that I suggested to use this link and not just the icons.
There was a problem hiding this comment.
It definitely makes sense not to link to a 404, but the whole point of the doc is to show how to use a font icon set with mat-icon.
There was a problem hiding this comment.
Indeed should be the example link, you are right @crisbeto.
I will change and do the commit again.
In this case, and seeing that the Fontawesome is also an official Angular component for icons, is it possible to create a session in the documentation to explain how to install and use the Font Awesome in the project?
There was a problem hiding this comment.
I don't think that we should mention the Font Awesome component, because we aren't the ones maintaining it.
docs(material/icon): update the FontAwesome example link. Update the FontAwesome link to a link with examples. Fixes angular#24954
victorwvieira
changed the title
Update the Font Awesome link to a link with examples. Fixes angular#24954
crisbeto
added
docs
* Update icon.md Fixed the FontAwesome link. * Update icon.md docs(material/icon): update the FontAwesome example link. Update the FontAwesome link to a link with examples. Fixes #24954 * docs(material/icon): update the FontAwesome link Update the Font Awesome link to a link with examples. Fixes #24954 (cherry picked from commit d0f803c)
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
docs(material/icon): update the FontAwesome link.
Update the FontAwesome link example.
The FontAwesome link was broken.
Fixes #24954