W3C home > Mailing lists > Public > public-publ-wg@w3.org > August 2017

Re: [pwg] Are you watching github?

From: Ivan Herman <ivan@w3.org>
Date: Sat, 5 Aug 2017 07:04:56 +0200
Cc: W3C Publishing Working Group <public-publ-wg@w3.org>
Message-Id: <347FDB24-6E1A-412F-899D-322449E61025@w3.org>
To: Tzviya Siegman <tsiegman@wiley.com>
One more information (for github newcomers, mainly).

One of our main tools to propose changes on a document is to use Pull Requests. A good example is the Pull Request provided by Tim Cole yesterday[1] which proposes changes (this time, additions) to a spec, and the discussion can be done directly on this pull request to decide whether it is incorporated in the document.

A problem with the basic GitHub pull request is that it is a bit difficult to see what the differences are. There is a way to see the differences (see [2] in this case), but that is not always convenient. I standard way is to use the "rawgit" service[3], which can be used to generate, eg, [4] for our case.

All this may seem a bit convoluted, and it is. However, there is a service (in the making) that provides automatic previews and diffs for Pull Requests. I have been experimenting with it already in the (currently empty) PWP repository. It worked for a moment, see[5], but there is a problem somewhere because it is not automatically generated when it should. There is an open issue for the moment[6] which, hopefully, will be resolved soon. When it is, PR-s will become even more friendly as they are today!


[1] https://github.com/w3c/wpub/pull/17#event-1193898153 <https://github.com/w3c/wpub/pull/17#event-1193898153>
[2] https://github.com/w3c/wpub/pull/17/files <https://github.com/w3c/wpub/pull/17/files>
[3] http://rawgit.com <http://rawgit.com/>
[4] https://rawgit.com/tcole3/wpub/8b3d570bb3c2106e2fc754119369bd4a434067f3/index.html <https://rawgit.com/tcole3/wpub/8b3d570bb3c2106e2fc754119369bd4a434067f3/index.html>
[5] https://github.com/w3c/pwpub/pull/2 <https://github.com/w3c/pwpub/pull/2>
[6] https://github.com/w3c/respec/issues/1345 <https://github.com/w3c/respec/issues/1345>

> On 4 Aug 2017, at 21:42, Siegman, Tzviya - Hoboken <tsiegman@wiley.com <mailto:tsiegman@wiley.com>> wrote:
> Dear PWG,
> There is a lot of discussion happening on GitHub. GitHub is an opt-in service, so please make sure that you are “watching” the repositories listed at [1] to make sure that you don’t miss any of the discussions.
> New to GitHub? Fear not! Ivan wrote guidelines [2]. To get started, create an account. When you are signed in, go to a repository. Click on the “watch” button toward the top of the screen. This will trigger GitHub to notify you when there is activity on the site. Then you too can GitHub and chill! 
> Have a good weekend,
> Tzviya
> [1] https://github.com/search?q=topic%3Apubl-wg+org%3Aw3c&type=Repositories <https://github.com/search?q=topic%3Apubl-wg+org%3Aw3c&type=Repositories>
> [2] https://www.w3.org/publishing/groups/publ-wg/WorkMode/#github <https://www.w3.org/publishing/groups/publ-wg/WorkMode/#github>
> Tzviya Siegman
> Information Standards Lead
> Wiley
> 201-748-6884
> tsiegman@wiley.com <mailto:tsiegman@wiley.com>

Ivan Herman, W3C 
Publishing@W3C Technical Lead
Home: http://www.w3.org/People/Ivan/ <http://www.w3.org/People/Ivan/>
mobile: +31-641044153
ORCID ID: http://orcid.org/0000-0003-0782-2704 <http://orcid.org/0000-0003-0782-2704>
Received on Saturday, 5 August 2017 05:05:08 UTC

This archive was generated by hypermail 2.3.1 : Monday, 23 October 2017 15:49:06 UTC