Layout

[jonathanong]

Okay just realized the layout doesn't make sense. Each module needs a description on how it is important. I'll mess with it later unless someone else gets to it first

[rlidwka]

Is it the same description as in package.json's?

[jonathanong]

I think it needs more explanation that

[Raynos]

I used this format ( https://github.com/Raynos/http-framework/wiki/Modules )

Grouping, link to each module, a 2/3 line description per module.

I think the badges you added is really good, having a link to core maintainer is 👍 too.

Copying some form of grouping like I use in my wiki is probably not important.

[jonathanong]

yeah basically that format, except i don't think we need categories and THERE SHOULD BE MORE BADGES!!!

[rlidwka]

THERE SHOULD BE MORE BADGES!!!

Like... this?

[Fishrock123]

Nice.

[jonathanong]

?style=flat-square

[rlidwka]

Something around those lines:

http://rlidwka.github.io/jshttp.github.io/layout1.html
http://rlidwka.github.io/jshttp.github.io/layout2.html
http://rlidwka.github.io/jshttp.github.io/layout3.html
http://rlidwka.github.io/jshttp.github.io/layout4.html
http://rlidwka.github.io/jshttp.github.io/layout5.html

PS: you're welcome to write better descriptions :P

[Fishrock123]

PS: you're welcome to write better descriptions :P

Yeah that will need to be done.

[dougwilson]

Something around those lines:

of those 5, i think layout 3 is the easiest to read. could probably use more vertical whitespace between the badges and the previous module's description

[yoshuawuyts]

I built a quick alternative to the bar layout, let me know if you like this direction. -- http://yoshuawuyts.github.io/jshttp-example-site/

[dougwilson]

i like it, especially since the description's max width is much smaller and easier to read on a wide screen

[yoshuawuyts]

The only issue this doesn't address is @jonathanong's comment about the purpose of the site: being a place to quickly check build statuses. That said, you can solve it easily by wrapping 'https://api.travis-ci.org/repos/' + userRepo + '/builds.json' in a label / mark, which should convey status fairly easily.

[Fishrock123]

Do the descriptions have to be there?

[yoshuawuyts]

Depends on what you want the site to do. If you expect it to be user-facing, I'd definitely put in descriptions. If it's purely for internal use and you're not promoting it, then no, you as a maintainer probably already know what the modules do.

That said: you can always agree to reduce description to a single sentence, which makes it both concise and user friendly.

[rlidwka]

Yeah, the whole idea of the current layout is about making badges visually line up, so you can compare them.

This would be about as small description field as it gets while preserving it: http://rlidwka.github.io/jshttp.github.io/fixed.png

[Fishrock123]

I say we either let people check the links (the names are fairly descriptive anyways, imo) for the readme descriptions / etc..

Or have a separate page with just the badges.

I don't really think the former is an issue because it's probably just going to be people like us who want to use these things.

[dougwilson]

basically, i think we have two different things that i would like:

1. a user-facing site with the mod names and little descriptions and basic data like node version, etc.
2. a non-user-facing site that would be a big table of badges like a dashboard

[rlidwka]

making two versions of the same webpage with the same information isn't really a great idea

if the description is too noisy, we could add click-to-expand thingie, but we'd better have a lot of information about each module to justify that

[dougwilson]

well, i don't think the user-facing page should have a million badges; even the build status badge may be a bit much on there. the pages are just generated, though, so it's not like it's extra by-hand work.

[Fishrock123]

Basically, I want a list like we have now, even if just for us.

Likewise in our other orgs, once we finalize how here.

[rlidwka]

i don't think the user-facing page should have a million badges

Yeah it should. They show people how much our modules are used, social proof, blah blah blah. I'd bet that 90% of projects out there having badges don't give a rat's ass about useful info, and I've even see travis badges that always pass. :)

[yoshuawuyts]

@rlidwka Throwing more badges at the problem will only generate noise. I agree with @dougwilson here.

[jonathanong]

the gittip badges can go in a list of maintainers. we probably don't need the build status badge since all the tests should be passing

[dougwilson]

the gittip badges can go in a list of maintainers

yea. i only even had them in the readme because they had nowhere else to live, but if we had a page on the site that listed the maintainers, that would be the better place for them to live

[rlidwka]

the gittip badges can go in a list of maintainers. we probably don't need the build status badge since all the tests should be passing

Yeah, they should be, but it'd be nice to capture those 1% cases when they don't.

Actually, all badges there are useful, except for gittip and node.js version (which should be the same for all modules anyway).

[jonathanong]

maybe the header at the topleft should link to this issues list, not the repo. would be pretty cool to get people visiting into the discussion.

[jonathanong]

@rlidwka i'm getting a broken header on some page loads in safari 7

do you know whats up?

[Fishrock123]

Needs to be @media screen and (min-width: 481px) I think.

https://github.com/jshttp/jshttp.github.io/blob/master/src/style.css#L62

Edit: See below

[jonathanong]

okay guys... i really want to use this "badgeboard" in other orgs. @Fishrock123 @rlidwka are you guys interested in making a template, then allow orgs to fork it? i don't think it can be in an org though because then that org can't have a badgeboard lol

[jonathanong]

unless you don't "fork" it

[rlidwka]

git pull here, change settings, git push there?

[jonathanong]

yeah you can just do git add remote ... then git pull remote or wahtever the git command for it is. don't have to do a github fork

[jonathanong]

if you do that, we can just add it to https://github.com/repo-utils. i'll add you as owner

[rlidwka]

I mean, can you use this org as a template for other orgs?

Or we need a place to bikeshed style changes for all badgeboards?

[jonathanong]

ours is pretty minimal now and it works, so we can use it as a template. we don't need to move every change here to the "badgeboard" though, if that's what you mean. nobody should be pulling from here, only from the "badgeboard"

[rlidwka]

https://github.com/repo-utils/badgeboard

[jonathanong]

damn you are so fast

[jonathanong]

okay i'm going to close this for now. i think the base is pretty good. open new issues whenever we have new ideas