Adding shields.io badges for Fedora packages to upstream projects

[Ankur Sinha]

Hi folks,

I've only recently realised that there's a shields.io badge for
Fedora packages. For example:

https://github.com/nest/nest-simulator/blob/master/README.md

A few questions:

- Did we get this setup? Are there other services we can use too?

- What do people think of opening PRs to (optionally) add these to
  upstream readme files when a software has been included in Fedora to
  increase visibility?

- I went to shields.io to generate the badge for some of my packages,
  but it doesn't work for all of them (eg: works for arbor, not for
  python-libNeuroML). Would anyone have an idea of how this works and
  where issues should be filed? On our infra or on shields.io?

-- 
Thanks,
Regards,
Ankur Sinha "FranciscoD" (He / Him / His) |
https://fedoraproject.org/wiki/User:Ankursinha
Time zone: Europe/London

[Artur Frenszek-Iwicki]

>  Would anyone have an idea of how this works and
>  where issues should be filed? On our infra or on shields.io? 
Fedora badges are
listed on shields.io under the "Version" category:
https://shields.io/category/version
Clicking on the "Fedora" badge brings up a pop-up that allows to specify the
badge's parameters.
The pop-up mentions mdapi, so I guess that's where it gets its information from.

>  works for arbor, not for python-libNeuroML 
While
"python-libNeuroML" doesn't work, "python3-libNeuroML" does,
so I guess this works with binary RPMs, not source RPMs.

>  What do people think of opening PRs to (optionally) add these to
>  upstream readme files when a software has been included in Fedora to
>  increase visibility? 
If a project already includes some "get it on
Ubuntu/Arch" information,
I see no harm in suggesting to add a note about Fedora. Though personally
I think repology is a better solution, since it gibes you many repos at once
and you don't need to update the README every time a new distro comes along.
But that's just me.

[Ankur Sinha]

On Mon, Nov 29, 2021 11:23:13 -0000, Artur Frenszek-Iwicki wrote:
>  > Would anyone have an idea of how this works and
>  > where issues should be filed? On our infra or on shields.io?
>  Fedora badges are listed on shields.io under the "Version" category:
>  https://shields.io/category/version
>  Clicking on the "Fedora" badge brings up a pop-up that allows to specify the
> badge's parameters.
>  The pop-up mentions mdapi, so I guess that's where it gets its information from.
>  
>  > works for arbor, not for python-libNeuroML
>  While "python-libNeuroML" doesn't work, "python3-libNeuroML"
> does,
>  so I guess this works with binary RPMs, not source RPMs. 
AH! Should've tried that! Thanks!

>  
>  > What do people think of opening PRs to (optionally) add these to
>  > upstream readme files when a software has been included in Fedora to
>  > increase visibility?
>  If a project already includes some "get it on Ubuntu/Arch" information,
>  I see no harm in suggesting to add a note about Fedora. Though personally
>  I think repology is a better solution, since it gibes you many repos at once
>  and you don't need to update the README every time a new distro comes along.
>  But that's just me.  
I think adding badges to upstream projects serves a different purpose to
repology. The idea here (at least for the Neuro SIG) is for our target
audience to quickly be made aware that something is available in Fedora
when they go to a GitHub repository. They're really not going to go to
repology to search, they're going to go directly to project
websites/GitHub.

-- 
Thanks,
Regards,
Ankur Sinha "FranciscoD" (He / Him / His) |
https://fedoraproject.org/wiki/User:Ankursinha
Time zone: Europe/London

[Artur Frenszek-Iwicki]

>  The idea here [...] is for our target audience to quickly be made
> aware 
>  that something is available in Fedora when they go to a GitHub repository.
>  They're really not going to go to repology to search 
Repology also offers
badges. What I meant is that a single Repology badge
listing all known repos is a simpler solution (also requires less maintenance)
than having a separate badge for each distro.

[Zbigniew Jędrzejewski-Szmek]

On Mon, Nov 29, 2021 at 01:40:29PM +0000, Ankur Sinha wrote:
>  On Mon, Nov 29, 2021 11:23:13 -0000, Artur Frenszek-Iwicki wrote:
>  > > Would anyone have an idea of how this works and
>  > > where issues should be filed? On our infra or on shields.io?
>  > Fedora badges are listed on shields.io under the "Version" category:
>  > https://shields.io/category/version
>  > Clicking on the "Fedora" badge brings up a pop-up that allows to specify
> the badge's parameters.
>  > The pop-up mentions mdapi, so I guess that's where it gets its information
> from.
>  > 
>  > > works for arbor, not for python-libNeuroML
>  > While "python-libNeuroML" doesn't work, "python3-libNeuroML"
> does,
>  > so I guess this works with binary RPMs, not source RPMs.
>  
>  AH! Should've tried that! Thanks!
>  
>  > 
>  > > What do people think of opening PRs to (optionally) add these to
>  > > upstream readme files when a software has been included in Fedora to
>  > > increase visibility?
>  > If a project already includes some "get it on Ubuntu/Arch" information,
>  > I see no harm in suggesting to add a note about Fedora. Though personally
>  > I think repology is a better solution, since it gibes you many repos at once
>  > and you don't need to update the README every time a new distro comes along.
>  > But that's just me. 
>  
>  I think adding badges to upstream projects serves a different purpose to
>  repology. The idea here (at least for the Neuro SIG) is for our target
>  audience to quickly be made aware that something is available in Fedora
>  when they go to a GitHub repository. They're really not going to go to
>  repology to search, they're going to go directly to project
>  websites/GitHub. 
What I think Artur meant was to use the badge from repology, see
https://repology.org/project/python:libneuroml/badges

Zbyszek

[Zbigniew Jędrzejewski-Szmek]

On Mon, Nov 29, 2021 at 01:55:11PM +0000, Zbigniew Jędrzejewski-Szmek wrote:
>  On Mon, Nov 29, 2021 at 01:40:29PM +0000, Ankur Sinha wrote:
>  > On Mon, Nov 29, 2021 11:23:13 -0000, Artur Frenszek-Iwicki wrote:
>  > > > Would anyone have an idea of how this works and
>  > > > where issues should be filed? On our infra or on shields.io?
>  > > Fedora badges are listed on shields.io under the "Version" category:
>  > > https://shields.io/category/version
>  > > Clicking on the "Fedora" badge brings up a pop-up that allows to
> specify the badge's parameters.
>  > > The pop-up mentions mdapi, so I guess that's where it gets its information
> from.
>  > > 
>  > > > works for arbor, not for python-libNeuroML
>  > > While "python-libNeuroML" doesn't work,
> "python3-libNeuroML" does,
>  > > so I guess this works with binary RPMs, not source RPMs.
>  > 
>  > AH! Should've tried that! Thanks!
>  > 
>  > > 
>  > > > What do people think of opening PRs to (optionally) add these to
>  > > > upstream readme files when a software has been included in Fedora to
>  > > > increase visibility?
>  > > If a project already includes some "get it on Ubuntu/Arch"
> information,
>  > > I see no harm in suggesting to add a note about Fedora. Though personally
>  > > I think repology is a better solution, since it gibes you many repos at once
>  > > and you don't need to update the README every time a new distro comes
> along.
>  > > But that's just me. 
>  > 
>  > I think adding badges to upstream projects serves a different purpose to
>  > repology. The idea here (at least for the Neuro SIG) is for our target
>  > audience to quickly be made aware that something is available in Fedora
>  > when they go to a GitHub repository. They're really not going to go to
>  > repology to search, they're going to go directly to project
>  > websites/GitHub.
>  
>  What I think Artur meant was to use the badge from repology, see
>  https://repology.org/project/python:libneuroml/badges 
Or maybe even something like this which looks better ;)

https://repology.org/badge/vertical-allrepos/python:libneuroml.svg?exclud...

Zbyszek

[Ankur Sinha]

On Mon, Nov 29, 2021 13:57:52 +0000, Zbigniew Jędrzejewski-Szmek wrote:
>  On Mon, Nov 29, 2021 at 01:55:11PM +0000, Zbigniew Jędrzejewski-Szmek
> wrote:
>  > What I think Artur meant was to use the badge from repology, see
>  > https://repology.org/project/python:libneuroml/badges
>  
>  Or maybe even something like this which looks better ;)
>  
>
> https://repology.org/badge/vertical-allrepos/python:libneuroml.svg?exclud...
Yeh, that looks good too. I see the verical badge can get quite large
for projects that are packaged in lots of places (scipy, for example):
https://repology.org/badge/vertical-allrepos/python:scipy.svg?exclude_sou...

Scipy is an extreme case, though. Other lists should be shorter:

https://repology.org/badge/vertical-allrepos/nest.svg?exclude_sources=sit...

https://repology.org/badge/vertical-allrepos/neuron.svg?exclude_sources=s...

With my Fedora hat on, I have a couple of issues here:

- Fedora can easily get lost in the list here (sheilds.io shows logos,
  which make it somewhat easier to locate platforms/distros):
  https://github.com/nest/nest-simulator/blob/master/README.md

- Individual badges in the vertical badge cannot be linked to specific
  SCMs. I could link to this page:
  https://repology.org/project/nest/packages but that's not exactly
  user-friendly. (It may work for seasoned FOSS folks, but certainly not
  for the Neuro SIG's less technical target audience.)

So, I think I'll go with a Fedora specific badge to begin with (either
form repology or from shields.io) so I can link to src.fp.o.

In general, folks can always open PRs with the complete vertical badge
too if they want, and perhaps let upstream choose.

-- 
Thanks,
Regards,
Ankur Sinha "FranciscoD" (He / Him / His) |
https://fedoraproject.org/wiki/User:Ankursinha
Time zone: Europe/London

[Matthew Miller]

On Mon, Nov 29, 2021 at 11:02:58AM +0000, Ankur Sinha wrote:
>  https://github.com/nest/nest-simulator/blob/master/README.md 
Oh, wow, we need to get them to replace that logo they've made up for us. :)


-- 
Matthew Miller
<mattdm(a)fedoraproject.org&gt;
Fedora Project Leader

[Vitaly Zaitsev]

On 29/11/2021 15:07, Matthew Miller wrote:
>  Oh, wow, we need to get them to replace that logo they've made up
> for us.:) 
They use Simple icons library: https://github.com/simple-icons/simple-icons

Also they removed the Fedora logo as it is not free:
- 
https://github.com/simple-icons/simple-icons/issues/5540#issuecomment-828...
- https://github.com/simple-icons/simple-icons/pull/6892

-- 
Sincerely,
   Vitaly Zaitsev (vitaly(a)easycoding.org)

[Ankur Sinha]

On Mon, Nov 29, 2021 15:23:26 +0100, Vitaly Zaitsev via devel wrote:
>  On 29/11/2021 15:07, Matthew Miller wrote:
>  > Oh, wow, we need to get them to replace that logo they've made up for us.:)
>  
>  They use Simple icons library: https://github.com/simple-icons/simple-icons
>  
>  Also they removed the Fedora logo as it is not free:
>  - https://github.com/simple-icons/simple-icons/issues/5540#issuecomment-828...
>  - https://github.com/simple-icons/simple-icons/pull/6892 
Uh. Matthew, would we be able to grant them permission so they can use
our new logo? (Happy to file a ticket wherever if this is doable)

-- 
Thanks,
Regards,
Ankur Sinha "FranciscoD" (He / Him / His) |
https://fedoraproject.org/wiki/User:Ankursinha
Time zone: Europe/London

[Matthew Miller]

On Mon, Nov 29, 2021 at 03:23:26PM +0100, Vitaly Zaitsev via devel wrote:
>  On 29/11/2021 15:07, Matthew Miller wrote:
>  >Oh, wow, we need to get them to replace that logo they've made up for us.:)
>  
>  They use Simple icons library: https://github.com/simple-icons/simple-icons
>  
>  Also they removed the Fedora logo as it is not free:
>  - https://github.com/simple-icons/simple-icons/issues/5540#issuecomment-828...
>  - https://github.com/simple-icons/simple-icons/pull/6892 
Yeah, addressing that is on my todo list. :-/

-- 
Matthew Miller
<mattdm(a)fedoraproject.org&gt;
Fedora Project Leader