Commit Graph
10 Commits
Author SHA1 Message Date
Paul MelnikowandThaddee Tyl cca46b7e94 Generate index.html only on gh-pages when deploying
- Build index.html at deploy time
- Update corresponding documentation references
- Since index.html is untracked, git add needs -f
- Clarify gh-pages generated commit message
- Improve Makefile dependencies related to website generation

As discussed in #936, tracking the index.html causes makes PRs longer / noisier
and causes extra merge conflicts. More importantly, it causes contributors to
inadvertently edit the wrong file, which causes extra work (#949) or
contributions to be lost (#898).

Since there's no need for index.html in development (everything uses try.html) a
logical solution is to generate and commit the index.html at deploy time.

Recording compiled or generated files in a deploy commit is a reasonable
practice for git-based deploys (Heroku, gh-pages, and others).

The old version of this was slightly "unsafe" for my taste, in that it depended
on the local copy of gh-pages (if it existed) and master. The new version just
replaces gh-pages with master + the new commit.

Closes #936.

Fixes #954 (the PR).
2017-04-25 23:40:08 +02:00
Nicco KunzmannandPaul Melnikow 21a3aef427 Add tutorial on how to add a new service (#889) 2017-03-30 11:46:10 -04:00
Thaddee Tyl 225ed98663 Mention the need to minimize .svg images
As suggested by https://github.com/badges/shields/pull/861#discussion_r96729020.
2017-01-24 23:03:12 +01:00
Thaddee Tyl 479b5c6666 Document the command to generate index.html 2016-03-28 19:53:49 +02:00
Thaddee Tyl a82db53597 Describe the recipe for badge URLs 2016-01-31 18:15:27 +01:00
Thaddee Tyl 784de4a8ec Ground design rules for large modifications 2015-11-24 20:12:54 +01:00
RebornixandThaddee Tyl a525dfa28f Add a link to C# port of Shield style badge lib.
When we try to add a badge service to [visual studio gallery](visualstudiogallery.msdn.microsoft.com), we find Shield is the best option but there is no .NET implementation. So we port it to [.NET](https://github.com/rebornix/DotBadge) for better code integration.

I'll appreciate it if you can add a link to C# port of Shield badge library and CLI, which can bring more audience to this tiny draft project. But we can understand if you don't, as it's not an official one :)
2015-05-11 21:13:29 +02:00
Thaddee Tyl 0ef15011bd Clarify the state of badge implementations
See https://github.com/badges/shields/issues/377#issuecomment-76528216
2015-02-28 16:00:36 +01:00
Thaddee Tyl 90eeafe8a0 Mention that contributors should modify try.html.
Fixes #131.
2014-02-26 10:58:06 +01:00
Thaddee Tyl 3f3f1b30bb Files related to the switch to the shields repo. 2014-02-23 22:53:34 +01:00