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

Update documentation on updating FontAwesome Iconset #5655

Merged
merged 3 commits into from Dec 18, 2016

Conversation

Projects
None yet
5 participants
@ashmaroli
Member

ashmaroli commented Dec 11, 2016

Addresses #5650

Adds a comprehensive section to contributing.md
Leaves docs/readme.md as is..

--
/cc @jekyll/documentation

@Crunch09

👍 for the idea. Just some small things i noticed.

Show outdated Hide outdated docs/_docs/contributing.md
@@ -71,6 +71,26 @@ You can find the documentation for jekyllrb.com in the [docs](https://github.com
One gotcha, all pull requests should be directed at the `master` branch (the default branch).
### Updating FontAwesome package for jekyllrb.com
We recently moved to using a stripped-down version of FontAwesome iconset on the site, consisting of only those icons that we actually use here.

This comment has been minimized.

@Crunch09

Crunch09 Dec 11, 2016

Member

Maybe the FontAwesome inconset? Sounds better IMHO.

@Crunch09

Crunch09 Dec 11, 2016

Member

Maybe the FontAwesome inconset? Sounds better IMHO.

Show outdated Hide outdated docs/_docs/contributing.md
If you ever need to update our documentation with an icon that is not already available in our custom iconset, you'll have to regenerate the iconset using Icomoon's Generator:
1. Go to <https://icomoon.io/app/>

This comment has been minimized.

@Crunch09

Crunch09 Dec 11, 2016

Member

I think there should be a . at the end of each instruction.

@Crunch09

Crunch09 Dec 11, 2016

Member

I think there should be a . at the end of each instruction.

Show outdated Hide outdated docs/_docs/contributing.md
If you ever need to update our documentation with an icon that is not already available in our custom iconset, you'll have to regenerate the iconset using Icomoon's Generator:
1. Go to <https://icomoon.io/app/>
2. Click `Import Icons` on the top-horizontal-bar and upload `icomoon-selection.json`

This comment has been minimized.

@Crunch09

Crunch09 Dec 11, 2016

Member

[...] upload the existing docs/icomoon-selection.json file.

@Crunch09

Crunch09 Dec 11, 2016

Member

[...] upload the existing docs/icomoon-selection.json file.

Show outdated Hide outdated docs/_docs/contributing.md
- Copy the contents of `selection.json` and overwrite existing content inside `<jekyll>/docs/icomoon-selection.json`.
- Copy the entire `@font-face {}` declaration and only the **new-icon(s)' css declarations** further below, to update the
`<jekyll>/docs/_sass/_font-awesome.scss` sass partial.
- Fix paths in the `@font-face {}` declaraion by adding `../` before `fonts/FontAwesome.???` like so:

This comment has been minimized.

@Crunch09

Crunch09 Dec 11, 2016

Member

There is a typo in declaration. And i think fonts/FontAwesome.* looks better, ??? seems to me like something is missing :)

@Crunch09

Crunch09 Dec 11, 2016

Member

There is a typo in declaration. And i think fonts/FontAwesome.* looks better, ??? seems to me like something is missing :)

@ashmaroli

This comment has been minimized.

Show comment
Hide comment
@ashmaroli

ashmaroli Dec 11, 2016

Member

Thank you for the feedback @Crunch09. 😃. Will update shortly.

Member

ashmaroli commented Dec 11, 2016

Thank you for the feedback @Crunch09. 😃. Will update shortly.

@parkr

Thank you! Our build process actually overwrites this file from .github/CONTRIBUTING.md. Can you move this new content there and run rake site:generate to generate the site file?

Show outdated Hide outdated docs/_docs/contributing.md
@@ -71,6 +71,26 @@ You can find the documentation for jekyllrb.com in the [docs](https://github.com
One gotcha, all pull requests should be directed at the `master` branch (the default branch).
### Updating FontAwesome iconset for jekyllrb.com
We recently moved to using a stripped-down version of FontAwesome iconset on the site, consisting of only those icons that we actually use here.

This comment has been minimized.

@parkr

parkr Dec 17, 2016

Member

Maybe just "We use a custom version of FontAwesome which contains just the icons we use." 4 years from now this will still say "recently" 😆

@parkr

parkr Dec 17, 2016

Member

Maybe just "We use a custom version of FontAwesome which contains just the icons we use." 4 years from now this will still say "recently" 😆

This comment has been minimized.

@ashmaroli

ashmaroli Dec 18, 2016

Member

lol.. yeah, valid point. 😆 I'll update.

@ashmaroli

ashmaroli Dec 18, 2016

Member

lol.. yeah, valid point. 😆 I'll update.

@DirtyF

DirtyF approved these changes Dec 18, 2016

@parkr

parkr approved these changes Dec 18, 2016

@DirtyF

This comment has been minimized.

Show comment
Hide comment
@DirtyF

DirtyF Dec 18, 2016

Member

@jekyllbot: merge +site

Member

DirtyF commented Dec 18, 2016

@jekyllbot: merge +site

@DirtyF DirtyF closed this Dec 18, 2016

@jekyllbot jekyllbot merged commit e21d35a into jekyll:master Dec 18, 2016

2 checks passed

continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

jekyllbot added a commit that referenced this pull request Dec 18, 2016

@ashmaroli ashmaroli deleted the ashmaroli:fontawesome-docs branch Dec 18, 2016

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment