synchronize branches master and gh-badges in the shields repo

[chadwhitacre]

Reticketed from badges/gh-badges#36.

Also, I'd like to synchronize branches master and gh-badges in the shields repo, if possible. It makes it easier to browse through the code from GitHub.

@espadrine Can you say more about what you mean here?

[espadrine]

Right now, when going to https://github.com/badges/shields, you do not see the website as it currently is, which makes it harder to understand where to look. Since this is the repository that holds the website, it should be made obvious by having the master branch reflect what the gh-pages branch holds.

[chadwhitacre]

Okay, dug this up: #91 (comment). Our intention was to use:

• master for http://img.shields.io/
• gh-pages for http://shields.io/

Per badges/gh-badges#36 (comment), it sounds like you might like this idea? Shall we move the gh-badges code into the master branch of this repo? The two files that conflict are LICENSE and README. LICENSE doesn't actually conflict because both are CC0. We would need to discuss how to merge the READMEs.

[espadrine]

I like the idea, but as you said, there are a few things to discuss.

First, as I understand it, the master branch would contain exactly what is currently on gh-badges' current master branch. I could easily move the index.html file to the root of the repo, so that modifying the website is a mere push to the gh-pages branch.

As for the readme, the one currently in use in gh-badges is designed to explain how to use the code, and how to modify it. It isn't a design document, and it isn't a FAQ. I feel like those should be separate from the working code. A wiki, perhaps? A design repo?

Finally, should we transfer the issues from gh-badges to shields?

[chadwhitacre]

First, as I understand it, the master branch would contain exactly what is currently on gh-badges' current master branch.

Sort of. It would contain:

• badges/gh-badges' current master
• badges/shields' current master (font, static)
• a merged README however we decide to do that

I could easily move the index.html file to the root of the repo, so that modifying the website is a mere push to the gh-pages branch.

I believe this is the situation we have now. No?

As for the readme, the one currently in use in gh-badges is designed to explain how to use the code, and how to modify it. It isn't a design document, and it isn't a FAQ. I feel like those should be separate from the working code. A wiki, perhaps? A design repo?

I think it'd actually make more sense to move the installation docs to a wiki page, because Shields is not primarily designed for other people to install. The primary use case is via the web API at http://img.shields.io/.

I could definitely see putting the design spec on the main website http://shields.io/ once that's further along.

Finally, should we transfer the issues from gh-badges to shields?

Good call, we'd need to do that as well.

[chadwhitacre]

Option B is to not fold the repos, but to continue to maintain them separately.

[espadrine]

I think it'd actually make more sense to move the installation docs to a wiki page, because Shields is not primarily designed for other people to install. The primary use case is via the web API at http://img.shields.io/.

In that case, it makes more sense to keep the repo with all the code for installation separate. Shields can stay focused on API, front-facing and visual design and organization, while the code can stay in gh-badges.

In that case, I'd argue for a change from redirecting to http://badges.github.io/shields/ to redirecting to http://badges.github.io/gh-badges/ (which, no, doesn't exist yet). It would be easier for contributors and I alike, because the code for the website would be with the code for… well… the website's API… which would ensure that they're in sync.

Besides, we wouldn't have the issue of moving the issues, and we'd have a separation between design / organization issues and code issues.

[nathany]

I'd keep the repos separate but update the README for the shields repo. The specification should be moved to a separate Markdown file and the README should just have the basics about the project and what repo/branch is what.

[chadwhitacre]

I could easily move the index.html file to the root of the repo, so that modifying the website is a mere push to the gh-pages branch.

The location of an index.html file on the master branch is unrelated to the location of the index.html file on the gh-pages branch, no?

[chadwhitacre]

the code for the website would be with the code for… well… the website's API… which would ensure that they're in sync.

Per badges/gh-badges#37 (comment), I'm fine with automating the sync-up between what's available on http://img.shields.io/ and what's documented on http://shields.io/. That brings me back to my suggestion above (at #117 (comment) ):

• master for http://img.shields.io/
• gh-pages for http://shields.io/

Using something like the make website dance currently in use on gh-badges, we can push an auto-generated index.html to the gh-pages branch whenever warranted by changes on master. We can revisit this system as we further develop http://shields.io/ in gh-pages.

[espadrine]

I believe this can be closed. The branches master and gh-pages are currently in sync.