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

GoDoc.org shield #81

Closed
nathany opened this issue Nov 16, 2013 · 7 comments
Closed

GoDoc.org shield #81

nathany opened this issue Nov 16, 2013 · 7 comments
Labels
service-badge Accepted and actionable changes, features, and bugs

Comments

@nathany
Copy link
Contributor

nathany commented Nov 16, 2013

We recently added a badge to GoDoc.org using a PNG generated with buckler.repl.ca. golang/gddo#107

People were already linking to GoDoc.org to provide documentation (much like Read the Docs or RubyDoc.info. Having a badge/shield was a nice step in making that metadata more harmonious (as you say). We still have some work to do before the badge provides useful metadata (documentation quality) instead of just being "branding".

I'd be interested in using the shields.io image server/API, once SSL #66 is in place, and in particular, when there is an additional advantage, like Retina support #80 and analytics.

@pspeter3
Copy link

pspeter3 commented Jun 2, 2015

Is this available?

@espadrine
Copy link
Member

I have seen such badges, so I would presume so. In fact, you can simply link to whichever project you have by having something like:

[![](https://godoc.org/github.com/nathany/looper?status.svg)](http://godoc.org/github.com/nathany/looper)

or whatever project you have.

So I'm closing this. If there was something additional you wanted out of it, I can re-open it.

@pspeter3
Copy link

pspeter3 commented Jun 3, 2015

Can you make it the flat squared style?

@espadrine
Copy link
Member

That is a distinct possibility.

http://img.shields.io/badge/godoc-reference-5272B4.svg?style=flat-square

Is it suitable?

@nathany
Copy link
Contributor Author

nathany commented Jun 3, 2015

I used the style that matched Travis CI and other Shield badges (though I like the flat squared style too).

@pspeter3
Copy link

pspeter3 commented Jun 3, 2015

That works perfectly well for me. It just seems like the godoc is generating one that may have some meaning?

@sagikazarmark
Copy link

@paulmelnikow paulmelnikow added service-badge Accepted and actionable changes, features, and bugs and removed needs-upstream-help Not actionable without help from a service provider labels Oct 12, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
service-badge Accepted and actionable changes, features, and bugs
Projects
None yet
Development

No branches or pull requests

5 participants