gruntjs / grunt-docs

Grunt documentation. https://github.com/gruntjs/gruntjs.com
https://gruntjs.com/
80 stars 128 forks source link

Add doc for the mini-badge. #11

Closed kahlil closed 10 years ago

kahlil commented 11 years ago

Hey @vladikoff, @isaacdurazo & @cowboy.

Here is my first stab at the doc for the mini-badge just as a screenshot:

2013-11-02 at 20 24

Here just the copy:


grunt-mini-badge

Do you use Grunt in your projects and want to proudly display that in your project README on Github?

We too! That's why we had our very own Isaac Durazo make a nice mini-badge for you that you can place up top in your README. If you are using the Travis mini-badges ours fits nicely next to it.

Here is how you place it in your README:

First, Download the badge here and place it in the root of your project.

After you published that project to Github click through to the raw version of the mini-badge image file.

2013-11-02 at 20 10

And copy the URL.

Then insert the following code snippet into your README file just underneath the Headline and replace the copied link with the link in the snippet or replace the parts in caps with the correct names:

![Grunt Mini-Badge](https://raw.github.com/USERNAME-OR-ORG-NAME/REPO-NAME/master/grunt-mini-badge.png)

Let us know if you are using it on Twitter or on IRC in the #grunt channel.


Any feedback or thoughts?

kahlil commented 11 years ago

@cowboy ah ok. Done.

kahlil commented 11 years ago

@cowboy @isaacdurazo I guess we should antialias too then? It just doesn't look right.

nickdtodd commented 11 years ago

@cowboy I'm afraid we're out of options, certainly in terms of having it served through SSL.

tkellen commented 11 years ago

I know this isn't free, but maxcdn will host SSL certs, as will cloudfront. RE: antialiasing, I think the Grunt badge looks better than the travis one, but I do agree they don't match very well.

kahlil commented 11 years ago

I agree that the Grunt badge looks better. I guess there is no way to get the Travis guys to un-antialiasing theirs? :smiley:

isaacdurazo commented 11 years ago

I don't think we should antialias the Grunt Badge. That would make it look bad (:-1:) and also because we shouldn't be following exactly what other badges are doing.

What we could to is reduce the height of ours 1 pixel like in the screenshot below, although I really think the Travis guys should fix theirs

7e72afc2-5341-11e3-8f81-b150b51de3d4

kahlil commented 11 years ago

They really should.

tkellen commented 11 years ago

I honestly don't think it matters, but it never hurts to ask. Not sure who to ping here so I'm just going to shotgun the top four comitters.

Hey @joshk / @svenfuchs / @sferik / @ifesdjeen, if you agree it would look better, would you consider removing the antialiasing on your badge? For comparison, here is our (soon to be released) badge next to yours: https://f.cloud.github.com/assets/104712/1598803/7e72afc2-5341-11e3-8f81-b150b51de3d4.png

isaacdurazo commented 11 years ago

If the Travis guys are willing to do the un-antialiasing, I would be glad to help. :)

isaacdurazo commented 11 years ago

Guys, I would say let's go with this one for now. We can always update later it if we want too. It still is 19px height but it has a 1px transparent at the top:

grunt-badge

kahlil commented 10 years ago

How can we move this forward? How can I help?

cowboy commented 10 years ago

@kahlil I'm waiting on word from @mikecdnify about SSL hosting. He should be sending me an email soon. If CDNify can't do what we need, we're going to need to find an alternative CDN host.

kahlil commented 10 years ago

Ok.

Am 01.12.2013 um 18:40 schrieb Ben Alman notifications@github.com:

@kahlil I'm waiting on word from @mikecdnify about SSL hosting. He should be sending me an email soon. If CDNify can't do what we need, we're going to need to find an alternative CDN host.

— Reply to this email directly or view it on GitHub.

ifesdjeen commented 10 years ago

I'm afraid that I'm not a commiter to Travis anymore. I've been even removed from Organisation.

sferik commented 10 years ago

Same here. I could submit a pull request but so could you. :wink:

mikecunsolo commented 10 years ago

@cowboy @kahlil Hi guys, should have an update for you tomorrow.

kahlil commented 10 years ago

@mikecdnify great!

kahlil commented 10 years ago

@mikecdnify any developments?

cowboy commented 10 years ago

@kahlil it looks like CDNify won't be able to do what we need, so I'm currently looking into alternatives.

kahlil commented 10 years ago

@cowboy ok, cool, let me know if I can help in any way.

Sent from my iPhone

On 07.12.2013, at 19:08, Ben Alman notifications@github.com wrote:

@kahlil it looks like CDNify won't be able to do what we need, so I'm currently looking into alternatives.

— Reply to this email directly or view it on GitHub.

jdorfman commented 10 years ago

@cowboy we got your back

cowboy commented 10 years ago

Ok, MaxCDN is hooking things up. Thanks @jdorfman!

@vladikoff can you make the badge available at http://gruntjs.com/cdn/builtwith.png and kill the temporary heroku server? Once that's live (and the SSL is set up), I should be able to configure the CDN to mirror it to https://cdn.gruntjs.com/builtwith.png

jdorfman commented 10 years ago

=)

kahlil commented 10 years ago

\o/

cowboy commented 10 years ago

YAY

[![Built with Grunt](https://cdn.gruntjs.com/builtwith.png)](http://gruntjs.com/)

Built with Grunt

jimaek commented 10 years ago

Awesome, congratulations!

kahlil commented 10 years ago

OMG YES!

jdorfman commented 10 years ago

so pretty

kahlil commented 10 years ago

@cowboy I updated the snippets here in the copy: https://github.com/gruntjs/grunt-docs/blob/mini-badge/Badges.md

How about a review, cause then we can get it out quick :)

cowboy commented 10 years ago

@kahlil Can you find a Travis badge that's not showing an error? :tongue:

kahlil commented 10 years ago

:D

hmm... that's the actual Travis CI badge and it seems like tests are not passing at the moment. There are only dynamically generated images available. So I guess I could just download a passing badge and we could put it into gruntjs.com images folder?

kahlil commented 10 years ago

OK I pushed a branch with badge in the img folder: https://github.com/gruntjs/gruntjs.com/blob/travis-badge/src/img/travis-badge.png

kahlil commented 10 years ago

@cowboy I changed the Travis badge path to what it will be later (see my previous comment) in the mini-badge doc: https://github.com/gruntjs/grunt-docs/blob/mini-badge/Badges.md

Gotta go :zzz: it's late over here. Big ups for making this happen!

mikecunsolo commented 10 years ago

@kahlil @cowboy glad you guys got sorted. We'll definitely be using the badge on our site : )

kahlil commented 10 years ago

@mikecdnify awesome!

@cobwoy & @vladikoff: can I get some :+1: or :-1: on the copy? https://raw.github.com/gruntjs/grunt-docs/mini-badge/Badges.md

Cause if you are cool with it I can merge master into mini-badge doc branch so it can be fast-forward merged into master and we're good to go for deployment.

cowboy commented 10 years ago

@kahlil I made some edits, how does this look to you?

https://github.com/gruntjs/grunt-docs/blob/mini-badge/Built-with-Grunt.md

@jdorfman does the MaxCDN line work for you?

cowboy commented 10 years ago

@isaacdurazo take a look at the BitDeli image in the page I just linked. It has a hard border, but is only 18px high, which seems to be a better visual compromise than our 19px high image. Do you have any problem resizing the "Built with Grunt" badge to be 18px high?

kahlil commented 10 years ago

@cowboy looks great!

ifesdjeen commented 10 years ago

How do I unsubscribe from notifications for that issue?...

kahlil commented 10 years ago

@ifesdjeen scroll to the bottom of the page and click the mute button.

jdorfman commented 10 years ago

@cowboy +10

[EDIT] submitted: https://news.ycombinator.com/item?id=6916404

isaacdurazo commented 10 years ago

@cowboy here is an 18px version of the Badge. The only problem I see is that it's not perfectly vertically aligned anymore. What do you think?

grunt-badge-18px

ifesdjeen commented 10 years ago

thanks @kahlil !

isaacdurazo commented 10 years ago

@cowboy Also, +1 to the Badge page updates you made.

cowboy commented 10 years ago

THIS IS DONE AND LIVE!

http://gruntjs.com/built-with-grunt-badge

Thanks to everyone for contributing, you all rock.