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

Improve shields and header in README (Close #3017) #3018

Merged
merged 2 commits into from
Oct 27, 2022

Conversation

3t8
Copy link
Contributor

@3t8 3t8 commented Oct 24, 2022

Tracking issue

#3017

Describe your changes

  • Add links for commits, milestones, openssf and twitter
  • Remove plastic style for consistency
  • Remove newline in a tags to prevent unwanted underline on hover
  • Bump milestone to current version
  • Add link to LF AI & Data image

Check all the applicable boxes

  • I updated the documentation accordingly.
  • All new and existing tests passed.
  • All commits are signed-off.

@welcome
Copy link

welcome bot commented Oct 24, 2022

Thank you for opening this pull request! 🙌

These tips will help get your PR across the finish line:

  • Most of the repos have a PR template; if not, fill it out to the best of your knowledge.
  • Sign off your commits (Reference: DCO Guide).

@3t8 3t8 mentioned this pull request Oct 24, 2022
2 tasks
@3t8 3t8 changed the title Improve shields and header in README Improve shields and header in README (close #3017) Oct 24, 2022
@3t8 3t8 changed the title Improve shields and header in README (close #3017) Improve shields and header in README (Close #3017) Oct 24, 2022
README.md Outdated Show resolved Hide resolved
Comment on lines +35 to +36
<a href="https://github.com/flyteorg/flyte/commits">
<img src="https://img.shields.io/github/commit-activity/w/flyteorg/flyte.svg" alt="Commit Activity" /></a>
Copy link
Contributor

Choose a reason for hiding this comment

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

This formatting somehow doesn't look clean. Is the anchor tag on the new line the reason for underscores?

Copy link
Contributor Author

@3t8 3t8 Oct 25, 2022

Choose a reason for hiding this comment

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

Yes, everything before the closing anchor tag is interpreted as text, including newlines. By default the style is underlined and we cannot change that on github.
In alternative we could put everything on the same line
<a href="https://github.com/flyteorg/flyte/commits"><img src="https://img.shields.io/github/commit-activity/w/flyteorg/flyte.svg" alt="Commit Activity" /></a>
but I thought it would make more sense to have the img tag on a new line even if the closing anchor doesn't have the same indentation as the opening one

Copy link
Contributor

Choose a reason for hiding this comment

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

Can you try replacing anchor tags with https://stackoverflow.com/a/61072867/9695360 and check if this works?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We wouldn't be able to keep them centered if we go for markdown. The closest solution to mixing both is something similar to this https://stackoverflow.com/questions/29368902/how-can-i-wrap-my-markdown-in-an-html-div but the only difference would be using markdown image tags instead of html img tags. They all still have to stay on one line

@samhita-alla samhita-alla merged commit 0b6ddec into flyteorg:master Oct 27, 2022
@welcome
Copy link

welcome bot commented Oct 27, 2022

Congrats on merging your first pull request! 🎉

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

Successfully merging this pull request may close these issues.

2 participants