Skip to content

a version with meta data#152

Open
alperyilmaz wants to merge 37 commits intopditommaso:masterfrom
alperyilmaz:master
Open

a version with meta data#152
alperyilmaz wants to merge 37 commits intopditommaso:masterfrom
alperyilmaz:master

Conversation

@alperyilmaz
Copy link
Copy Markdown

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
Copy link
Copy Markdown
Author

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
Copy link
Copy Markdown
Author

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

@remram44
Copy link
Copy Markdown
Contributor

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
Copy link
Copy Markdown
Author

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
Copy link
Copy Markdown
Owner

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
Copy link
Copy Markdown
Author

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
Copy link
Copy Markdown
Owner

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

run: |
git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
git config --local user.name "github-actions[bot]"
git commit -m "update docs/index.md file" -a || echo "Nothing to update"
Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it be possible to commit to a separate branch e.g. gh-pages to avoid committing decoration in the same branch?

@alperyilmaz
Copy link
Copy Markdown
Author

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
Copy link
Copy Markdown
Owner

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

@alperyilmaz
Copy link
Copy Markdown
Author

working on it right now..

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants