mkdocs/catalog

Referencing plugins hosted on gitlab?

Closed this issue · 5 comments

FredZinelli commented

Hello,

I recently created a plugin for mkdocs, but it currently is hosted on gitlab: mkdocs-adresses. I was wondering if I had to transfer it to github to see it potentially added to the catalog of mkdocs plugins?

Regards,
Fred

pawamoy commented

Not at all, we already have projects listed here that are hosted on GitLab, feel free to send a PR 🙂 Simply use gitlab_id instead of github_id.

FredZinelli commented

wow, that was fast... x)

OK, thx, I'll work on it in the next few days

  • 😄1
FredZinelli commented

Hello,

I'm a bit surprised by some of the stats my plugin got. Specifically, it's marked as unlicensed while it has one (I also think it should have a few more medals than it currently does, but it's hard to tell...).
I took a quick look at the best-of-list repo, and it seems (at first glance at least) that only a part of the information is gathered for gitlab (just comparing the size of the files: the github integration one is to 3 times longer than the gitlab one). Do you think it's worth transferring the plugin to github? (I hope I'm not too much annoying, here, but my main goal was to give some visibility to the plugin, so... x) ).

Cheers

pawamoy commented

For reference, the GitLab integration source: https://github.com/mkdocs/best-of-generator/blob/main/src/best_of/integrations/gitlab_integration.py

It probably doesn't fetch as much info as from GitHub indeed. I'm not seeing any code that actually "detects" the license from GitHub or GitLab. It looks like the best-of-generator relies on what these platforms return, and simply match it against a list of known licenses (in the license.py module).

Looking at your repo, it seems even GitLab gets your license wrong: it says Apache License 2.0, while your LICENSE.md file says it Free BSD.

I don't often see license files containing the license of all the dependencies, maybe that's what is confusing GitLab and best-of-generator.

It would be a bit sad to force you to migrate over to GitHub. Maybe we can open a issue/discussion on the best-of-generator repository to get more info from the author?