On 22/07/2014 07:50, Robert Ramey wrote:
Andrey Semashev-2 wrote
Keeping auto-generated files in git is not a good idea. Syncing is not as simple as it may seem, it also spams history and increases the repo size. There was a discussion about this earlier, and I think the consensus was unanimous.
lol - maybe it was unanimous among those who see it as an issue.
It should be unanimous among everybody. Those who don't think they object to it have merely not yet encountered the merge hell that it generates. (To be clear: -1 for generated files in Git.)
Had I thought about while writing the advice section, I would have recommended storing the html in git for the reasons I mention above. I thought about doing that now - but it's really beside the point. The incubator doesn't even specify the usage of GitHub, Git or anything else - just that there be a repository. So I'm pleased just to not make any recommendation at all on this subject.
I would suggest going a step further and explicitly recommending *against* that (unless the HTML is manually written instead of generated) -- instead the link should be to some separately maintained location which is updated by the maintainer (or some automated CI process) when changes to the docs are committed to the main repo. This could even be a separate GitHub repo (eg. personal one) if the maintainer doesn't have any other public webspace available -- but under no circumstances should it be the "real" library repo.