Skip to content
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

Fork-Awesome is deprecated, please consider alternatives #858

Closed
paride opened this issue Nov 19, 2023 · 10 comments
Closed

Fork-Awesome is deprecated, please consider alternatives #858

paride opened this issue Nov 19, 2023 · 10 comments
Labels
help wanted Extra attention is needed

Comments

@paride
Copy link

paride commented Nov 19, 2023

Describe the problem:

I've been watching Fork-Awesome for a while, a bit frustrated by bugs, missing icons and the lack of new releases. I even recompiled it myself to use a newer version of it, only to discover more bugs.

Turns out the Fork-Awesome consider the project deprecated (or even "failed" in some ways), and plan to archive it in 2024. See https://github.com/ForkAwesome/Fork-Awesome/blob/master/README.md and https://github.com/ForkAwesome/Fork-Awesome/blob/master/posts/2023-04-10_forkawesomeIntrospection/forkawesomeIntrospection.md.

I think hugo-coder should start looking for alternatives, which may include switching back to Font Awesome.

@luizdepra
Copy link
Owner

Hey.

Well, we could change. No problem.
But, returning to Font Awesome is not an option because of its license.

@luizdepra luizdepra added the help wanted Extra attention is needed label Nov 29, 2023
@paride
Copy link
Author

paride commented Nov 29, 2023

Hey @luizdepra, AIUI the problem with Font Awesome is not really the license, but the fact that the build system is not public, and that the project does not accept community contributions. At least this is what I get paragraph right before "Forkawesome 1.x" in https://github.com/ForkAwesome/Fork-Awesome/blob/master/posts/2023-04-10_forkawesomeIntrospection/forkawesomeIntrospection.md:

Fontawesome 5.0.6, the initial release of the 5.x series, was released on the 6th of February 2018 by Rob Madole. (The very first release of series 5.x, 5.0.0-alpha1, was released on the 23rd of June 2017, but is no longer available.) On the 4th of February 2018 Julian Deswaef raised the FortAwesome/Font-Awesome#12199 (comment) that the build system for the website and CSS, LESS & SASS was no longer shared, and that community pull requests were continuing to be refused. Madole confirmed these developments were intentional FortAwesome/Font-Awesome#12199 (comment).

This said, I am totally in favor of using a "true" FLOSS project (without a working build system the sources are not of much use), but unfortunately I don't see many alternatives at the moment :(

@simonhollingshead
Copy link
Contributor

For what it's worth, I got sufficiently frustrated with the missing parts of Fork Awesome that I actually carry a patch on my own repo to swap back to Font Awesome, which thankfully was relatively minimal in size.

(For anyone reading this, don't directly use my patch, though, I've deliberately dropped the v4 shims in favour of swapping to v5+ syntax, so it is not a drop in replacement for an existing codebase)

@b-reich
Copy link

b-reich commented Dec 24, 2023

Whats the plan? Using FontAwsome (instead of the Forked one) or a totally new icon set?

@luizdepra
Copy link
Owner

No plans yet. I need to check if there are any license related problems if we redistribute FontAwesome within the theme. If so, maybe we could point to its CDN. Or, find another icon set.

@simonhollingshead
Copy link
Contributor

simonhollingshead commented Jan 5, 2024

https://fontawesome.com/license/free

As far as I can tell:

Icons - CC BY 4.0 License - Not relevant if you're using the WOFF2 and the SCSS, only if you're using the SVG/JS icons.

Fonts - SIL OFL 1.1 License - https://openfontlicense.org/how-to-use-ofl-fonts/ - there are no issues in redistributing with proper attribution.

Code - MIT License - https://opensource.org/license/mit/ - there are no issues in redistributing with proper attribution.

@luizdepra
Copy link
Owner

Right. I was looking for other options, but everything interesting that I found is SVG-based. It would be a lot of work to change to.

So, I'm accepting help with the migration.

@simonhollingshead
Copy link
Contributor

IMO, my existing change is a good starting point but I'd need to make a couple of changes. Specifically, it really would have to inject v4-shims because people use those fontawesome classes in their homepage - it's not something where a refactor of hugo-coder covers all uses such that everything could be mass-migrated to the v6 syntax.

Maybe I can see if I can propose a couple of PRs at the weekend, one to move to v6 in compatibility mode, and then one to modernize how the existing codebase calls FA.

@luizdepra
Copy link
Owner

Would be less complicated to migrate to FA v5?
As far as I read, we can't self-host v6 kits without pro license. I don't know if they provide a default kit or something like.

@simonhollingshead
Copy link
Contributor

simonhollingshead commented Jan 19, 2024

You don't need kits. A kit is a pro-level feature for auto-subsetting a font (removing characters that aren't going to be used to reduce page load size). The reason there's no free method is because that's a paid-for feature that isn't necessary for our use-case.

The standard free download contains WOFF/TTF files which can be redistributed under the OFL, the exact same license that you're redistributing ForkAwesome under right now.

luizdepra added a commit that referenced this issue Jan 31, 2024
… fa-solid. (#887)

### Prerequisites

Put an `x` into the box(es) that apply:

- [ ] This pull request fixes a bug.
- [ ] This pull request adds a feature.
- [ ] This pull request introduces breaking change.

### Description

This change is the second half of #882, designed to remove use of the v4
syntax from the codebase.

This is not removing the v4 shims as users may require it for their own
content, but we don't need the template to rely on the old syntax!

PLEASE NOTE: There are minor visible changes here by explicitly setting
a consistent font choice. The default fa-solid calendar icon has no
little squares where the days should be (but fa-calendar-days does, so
we could always swap back) and the default clock is solid (forkawesome
only had a hollow clock called clock-o).


![before-after](https://github.com/luizdepra/hugo-coder/assets/3343403/a2f95d34-3d7a-49e9-92c2-26f685bff601)

### Issues Resolved

I promised this cleanup in #858 

### Checklist

Put an `x` into the box(es) that apply:

#### General

- [x] Describe what changes are being made
- [x] Explain why and how the changes were necessary and implemented
respectively
- [x] Reference issue with `#<ISSUE_NO>` if applicable

#### Resources

- [ ] If you have changed any SCSS code, run `make release` to
regenerate all CSS files

#### Contributors

- [x] Add yourself to `CONTRIBUTORS.md` if you aren't on it already

Co-authored-by: Luiz F. A. de Prá <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

4 participants