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.

Sign up for GitHub

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
Merged

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

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
10add64
Improve shields and header in README
3t8 Oct 24, 2022
697fdfd
Remove link from header image
3t8 Oct 25, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 22 additions & 21 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
<html>
<p align="center">
<img src="https://raw.githubusercontent.com/flyteorg/static-resources/main/flyte/readme/flyte_and_lf.png" alt="Flyte and LF AI & Data Logo" width="250">
<a href="https://lfaidata.foundation/projects/flyte/">
3t8 marked this conversation as resolved.
Show resolved Hide resolved
<img src="https://raw.githubusercontent.com/flyteorg/static-resources/main/flyte/readme/flyte_and_lf.png" alt="Flyte and LF AI & Data Logo" width="250">
</a>
</p>

<h1 align="center">
Expand All @@ -23,32 +25,31 @@ Code. Ship. Scale.

<p align="center">
<a href="https://github.com/flyteorg/flyte/releases/latest">
<img src="https://img.shields.io/github/release/flyteorg/flyte.svg" alt="Current Release" />
</a>
<img src="https://img.shields.io/github/release/flyteorg/flyte.svg" alt="Current Release" /></a>
<a href="https://github.com/flyteorg/flyte/actions/workflows/sandbox.yml">
<img src="https://github.com/flyteorg/flyte/actions/workflows/sandbox.yml/badge.svg" alt="Sandbox Build" />
</a>
<img src="https://github.com/flyteorg/flyte/actions/workflows/sandbox.yml/badge.svg" alt="Sandbox Build" /></a>
<a href="https://github.com/flyteorg/flyte/actions/workflows/tests.yml">
<img src="https://github.com/flyteorg/flyte/actions/workflows/tests.yml/badge.svg" alt="End-to-End Tests" />
</a>
<img src="https://github.com/flyteorg/flyte/actions/workflows/tests.yml/badge.svg" alt="End-to-End Tests" /></a>
<a href="http://www.apache.org/licenses/LICENSE-2.0.html">
<img src="https://img.shields.io/badge/LICENSE-Apache2.0-ff69b4.svg" alt="License" />
</a>
<img src="https://img.shields.io/github/commit-activity/w/flyteorg/flyte.svg?style=plastic" alt="Commit Activity" />
<img src="https://img.shields.io/github/commits-since/flyteorg/flyte/latest.svg?style=plastic" alt="Commits since Last Release" />
<img src="https://img.shields.io/github/milestones/closed/flyteorg/flyte?style=plastic" alt="GitHub Milestones Completed" />
<img src="https://img.shields.io/github/milestones/progress-percent/flyteorg/flyte/18?style=plastic" alt="GitHub Next Milestone Percentage" />
<img src="https://img.shields.io/badge/LICENSE-Apache2.0-ff69b4.svg" alt="License" /></a>
<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>
Comment on lines +33 to +34
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 •
edited
Loading

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

<a href="https://github.com/flyteorg/flyte/commits">
<img src="https://img.shields.io/github/commits-since/flyteorg/flyte/latest.svg" alt="Commits since Last Release" /></a>
<a href="https://github.com/flyteorg/flyte/milestones?state=closed">
<img src="https://img.shields.io/github/milestones/closed/flyteorg/flyte" alt="GitHub Milestones Completed" /></a>
<a href="https://github.com/flyteorg/flyte/milestone/29">
<img src="https://img.shields.io/github/milestones/progress-percent/flyteorg/flyte/29" alt="GitHub Next Milestone Percentage" /></a>
<a href="https://flyte.rtfd.io">
<img src="https://readthedocs.org/projects/flyte/badge/?version=latest&style=plastic" alt="Docs" />
</a>
<a href="https://bestpractices.coreinfrastructure.org/projects/4670"><img src="https://bestpractices.coreinfrastructure.org/projects/4670/badge"></a>
<img src="https://img.shields.io/twitter/follow/flyteorg?label=Follow&style=social" alt="Twitter Follow" />
<img src="https://readthedocs.org/projects/flyte/badge/?version=latest" alt="Docs" /></a>
<a href="https://bestpractices.coreinfrastructure.org/projects/4670">
<img src="https://bestpractices.coreinfrastructure.org/projects/4670/badge" alt="OpenSSF Best Practices" /></a>
<a href="https://artifacthub.io/packages/search?repo=flyte">
<img src="https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/flyte" alt="Flyte Helm Chart" />
</a>
<img src="https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/flyte" alt="Flyte Helm Chart" /></a>
<a href="https://twitter.com/flyteorg">
<img src="https://img.shields.io/twitter/follow/flyteorg?label=Follow&style=social" alt="Twitter Follow" /></a>
<a href="https://slack.flyte.org">
<img src="https://img.shields.io/badge/slack-join_chat-white.svg?logo=slack&style=social" alt="Join Flyte Slack" />
</a>
<img src="https://img.shields.io/badge/slack-join_chat-white.svg?logo=slack&style=social" alt="Join Flyte Slack" /></a>
</p>

<h3 align="center">
Expand Down