-
Notifications
You must be signed in to change notification settings - Fork 3.3k
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
docs: add release badge and LinkedIn badge #12531
Conversation
Signed-off-by: Yuan Tang <[email protected]>
Is there a way to use the root level README file in the docs website? e.g. https://github.com/argoproj/argo-workflows/blob/main/docs/README.md is pretty redundant and we don't want to update both places every time. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I actually don't like the way Argo CD has badges with a lot of spacing and explicit categories, because that kind of defeats the purpose of badges as being small, aesthetically pleasing, in-line links.
If we wanted to do something similar, I would at least remove the double-spaced new-lines as suggested below, but I still think this is not quite how badges are intended to be used.
It also violates markdownlint
& markdown conventions as well
@@ -1,11 +1,18 @@ | |||
<!-- markdownlint-disable-next-line MD041 --> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this ignore is here because the first line is supposed to be an H1
. If there's a line of badges first, I think that's ok, but putting several lines of text + badges would be an anti-pattern and would fail markdownlint
multiple times. By convention, any text should be inside of / below headings
If we want them to be equivalent, yes, I'm pretty sure there's a few ways to do it. They weren't the same until your #11358 I think, so that is a more recent change. I can handle that |
Signed-off-by: Yuan Tang <[email protected]>
Addressed comments |
Signed-off-by: Yuan Tang <[email protected]>
Agreed that this looks ugly. I re-purposed the PR to just add the additional badges. |
Signed-off-by: Yuan Tang <[email protected]>
I added a script for this in #12752. It's not quite a straight copy+paste because of needing to change relative and absolute links. |
Signed-off-by: Yuan Tang <[email protected]> (cherry picked from commit 6a39edf)
The categorization is to be consistent with Argo CD. Also added release badge and LinkedIn badge.