a version with meta data

pditommaso / awesome-pipeline

A curated list of awesome pipeline toolkits inspired by Awesome Sysadmin

6.1k stars 625 forks source link

a version with meta data #152

Open alperyilmaz opened 3 years ago

alperyilmaz commented 3 years ago

Hi, In this version:

missing links were removed
if available, github repo link was used for any project
contains a script which will decorate README file
a decorated file in which, for each repo, language, star count and last activity was added as badge.

hope you like it..

alperyilmaz commented 3 years ago

by the way, I didn't change overall design. Contributor can still add repos to README.md and by using script (or even Github Actions) metadata version can be generated automatically. So, this is backwards compatible and it does not require contributors to prepare badge links.

alperyilmaz commented 3 years ago

I also added Github Actions, so README_meta.md will be updated automatically.

remram44 commented 3 years ago

This only seems to work if links in README.md point directly to GitHub, which is not the best link for many projects. How about a separate repo link for those?

Additionally I would recommend building to Pages rather than automatically committing changes to the repo from Actions. See for example how free-for.dev is generating their webpage from their repo's README.

alperyilmaz commented 3 years ago

There are some projects, they have links to their own site and when you check their repo they have lots of stars. So, for some projects, I had to put down the Github repo link instead of their own site, so that a badge can be generated. Two links would be better but I was trying to stick with the rule stated in CONTRIBUTING.md Use the following format: [RESOURCE](LINK) - DESCRIPTION.

If the rule is updated such as [RESOURCE](LINK):[Github Repo](LINK2) - DESCRIPTION. or something similar.

If the author agrees about Pages, why not.. That would be much more presentable.

pditommaso commented 3 years ago

Hi, thanks a lot for this PR and sorry for the late reply. I think the primary link included in the readme should be to the GitHub repo even if not ideal. The idea is to keep the list more developer-friendly.

I would recommend building to Pages rather than automatically committing changes to the repo from Actions

That's a nice idea, this would help to keep the main readme easier to maintain and add the decoration in the Pages branch 👍

alperyilmaz commented 3 years ago

I setup Pages, please check it out at https://alperyilmaz.github.io/awesome-pipeline/ . I tried slate theme and badges were not aligned inline. Now it's using hacker theme in which badges are aligned well. But that theme might not be for everybody's taste.

pditommaso commented 3 years ago

LOL, that's fun, tho I agree that hacker is not the best layout. What about cayman or minima ?

alperyilmaz commented 3 years ago

I tested more themes.

minima theme looks little bit dry minima

dinky has css problems, badges does not align inline dinky

tactile looks fine tactile

there are several more themes here if you want to try others, I can..

pditommaso commented 3 years ago

The tactile looks nice! it would be great to be able to push the changes to the branch gh-pages instead of master.

alperyilmaz commented 3 years ago

working on it right now..