Convert existing shields.io website to GitHub Pages

[nathany]

Just as a start, before doing a full-on redesign.

• GitHub Pages https://github.com/gittip/img.shields.io/tree/gh-pages
• Point DNS A record to it @olivierlacan
• Jekyll FTW (github-pages gem) @nathany
• Bonus: Toss in Sass @nathany
  bundle exec sass --watch _sass/all.sass:assets/all.css --load-path _sass/ (Procfile)

[chadwhitacre]

If we use project pages then we solve the two repos issue (#90) as well, right?

[nathany]

Cool. I hadn't thought of that. One repo to rule them all?

[chadwhitacre]

Done. I think it will show up at http://gittip.github.io/img.shields.io in the next 10 minutes, and then we can start configuring a CNAME.

[chadwhitacre]

Okay! Page is showing up at http://gittip.github.io/img.shields.io.

@olivierlacan We're ready for an A record for shields.io, pointing to 204.232.175.78.

[nathany]

Very cool. Source is at https://github.com/gittip/img.shields.io/tree/gh-pages

[chadwhitacre]

(We don't actually want a CNAME here because we're using the apex.)

[chadwhitacre]

@nathany Note that this isn't using Jekyll yet (let alone SASSSass/LESS). This is just a single static page.

[nathany]

oh. true, though you still need a CNAME file in gh-pages containing shields.io. :-)

[nathany]

Yah. Best to let @bryanveloso chime in regarding Jekyll before setting that up. We can always use a different static site generator and .no-jekyll if he prefers. Though sounds like everyone else 😍 Jekyll.

[chadwhitacre]

@nathany The problem is that this is the repo that has all the stars/forks. :-/

[chadwhitacre]

@nathany Actually, the problem is worse: img.shields.io is up to 6/108/6 watchers/stars/forks (16/323/32 here). We're diluting our traction, or something.

[chadwhitacre]

Maybe it'd be better after all to:

• Keep the shields.io repo separate from img.shields.io
• Have no master branch on shields.io for now, just have gh-pages
• Be more careful to open issues in the right repo to address Organizing GitHub Issues #90 (comment).

[nathany]

Good point. And all the issues.

There is the possibility of this being the Go code for the web API and img serving parts (and analytics, etc.) While the other repo is just the buckler image generation library, as per #84 (comment). Though then we're back to 2 places for issues #90.

Or we find some way to merge these repos? Possibly losing history on @jbowes work, less than ideal.

[nathany]

Maybe GitHub support could transfer the Stargazers? Not sure if that'd be kosher.

[chadwhitacre]

Maybe three repos?

1. shields.io - web pages
2. img.shields.io - web API
3. buckler - library + CLI

(1) and (2) already exist, (3) would be new.

[chadwhitacre]

Maybe GitHub support could transfer the Stargazers?

Huh, never occurred to me. [email protected] would be the place to ask, I suppose. Even then, I think multiple repos makes more conceptual sense. Yes, it requires thought (and/or post facto curation) to keep issues in the right repo.

[nathany]

This repo has open issues for a bunch of different integrations (web hooks?) and the img.shields.io stuff has yet to be written in Go.

I'd suggest gh-pages in this repo (instead) and master becomes the API.

If we end up need the website to be more dynamic, we can always shuffle the new design from gh-pages over to master and have Go to serve it up. And multiple subdomains from a single instance (img, www/apex) are no problem if that's what we want.

[olivierlacan]

A record for 204.232.175.78 added to shields.io

Killed the ALIAS to the old Heroku app.

PS: SASS is spelled Sass and is better than LESS.

[bryanveloso]

Sass is my preference. 👍

[chadwhitacre]

DNS change confirmed. !m @olivierlacan

[nathany]

So, I guess we should move gh-pages over to this repo instead, if we're gonna go ahead with multiple repos.

[chadwhitacre]

@nathany Am I hearing you right?

1. shields.io
   1. master - web API - http://img.shields.io/
   2. gh-pages - web pages - http://shields.io/
2. buckler - library + CLI (rename from img.shields.io)

[nathany]

that's my thought

[chadwhitacre]

Okay. Should we rename the shields.io repo (this one) to just shields in the process?

[nathany]

I think it's fine as is.

[chadwhitacre]

Well, shields.io was meant to be the domain name of the site in the repo, but now we have two sites in there (and it's img.shields.io that's on master). Now it seems that the name of the repo should reflect the general name of the project, and at #92 (comment) @olivierlacan asked to not use the .io in branding.

[chadwhitacre]

Okay, I've done the following:

• renamed img.shields.io to buckler
• renamed shields.io to shields
• cleared out shields/master except for README, LICENSE, and CONTRIBUTING
• moved the static stuff to shields/gh-pages

Next would be to make sure that http://shields.io/ is being served out of shields/gh-pages.

[nathany]

@whit537 Thanks for doing all that. It looks like buckler/gh-pages still exists. If we remove it and shields.io still works, we should be good.

[olivierlacan]

@whit537 http://shields.io is now pointing to http://badges.github.io/shields effectively loading the shields/gh-pages branch.

Had to hack the DNS settings today since we don't have http://shields.github.io anymore due to the move the badges organization. Instead it's the unsightly http://badges.github.io/shields which can't work with an A record or an ALIAS.

[nathany]

How did we have shields.github.io in the first place? The repo was under gittip.

Anyway, glad that you got it working again.

[chadwhitacre]

We've got something configured wrong. http://shields.io/ is simply redirecting to http://badges.github.io/shields/. My reading of the docs is that we should ALIAS shields.io to badges.github.io, and then the CNAME file in the shields/gh-pages branch should take over there (I think?).

[chadwhitacre]

@olivierlacan It looks from the screenshot like you're using DNSimple. They do provide the ALIAS record type to provide CNAME functionality using the apex domain, and that's what we should use.

[nathany]

DNSimple also allows sharing the domain configuration with others, if you want to let @whit537 fiddle with it.

If the badges.github.io repo is somehow impacting things, we probably can rename it? (which probably does mean taking that site down) @Mikulas

[chadwhitacre]

We could keep the existing badges.github.io page up as a subpage or subdomain of shields.io until we figure out our transition plan (#101).

[chadwhitacre]

Per #96 (comment), can we give @seanlinsley the permissions he needs to work on this ticket?

[chadwhitacre]

@olivierlacan Status? :-)

[chadwhitacre]

I've asked @olivierlacan for access to DNS.

[chadwhitacre]

DNS reticketed as #115.

[espadrine]

I believe this is fixed. We are using GitHub pages.