[Project review] How to make the best of GitHub for your specification? - 17 December 2015

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
11 messages Options
Reply | Threaded
Open this post in threaded view
|

[Project review] How to make the best of GitHub for your specification? - 17 December 2015

Xueyuan Jia

Dear Team, Chairs, AB, TAG, Group participants,

Next week right after Global meeting, we will have a Project review and
please find more information below:

Title: How to make the best of GitHub for your specification?
-------------------------------------------------------------
https://docs.google.com/presentation/d/1PE9bZnYGlrNyiplIF1QqC4h1EBLuFbEXiFk9zwFm1FI/pub?start=false&loop=false&delayms=3000#slide=id.p

Presenter: Philippe Le Hegaret
Date: 17 December, 2015
Time: 09:00 Boston/08:00 Chicago/06:00 Whistler/14:00 London/15:00
Paris/22:00 Beijing/23:00 Tokyo
Expected timing: 09:00 - 10:30
Scribe: open for volunteers

* The goal of this project review is:
-------------------------------------
- learn from each other on how to use GitHub for writing a specification
- provide a forum for sharing tips and tricks on how to use GitHub
efficiently
- help groups to be more agile with the community by using GitHub
- connect the workflow of GitHub, W3C Process, and W3C Patent Policy
- how to do spec versioning in GitHub
- how to facilitate cross and wide reviews with GitHub
- how to do automatic /TR publishing with GitHub
- harmonize the different ways W3C groups are using GitHub as much as
possible
* Please note that this is NOT a tutorial on how to install or use GitHub.

* Logistics:
------------
- IRC channel: #git
- JOIN WEBEX MEETING (same line as Global, )
   https://mit.webex.com/mit/j.php?MTID=m36feaf50ee6c877240c6dfdb7e264255
Meeting number (access code): 648 453 912
Meeting password: global
Mobile Auto Dial: +1-617-324-0000 US Toll Number

We look forward to your participation!

Best Regards,
Xueyuan


---

Reply | Threaded
Open this post in threaded view
|

Re: [Project review] How to make the best of GitHub for your specification? - 17 December 2015

Arthur Barstow-2
On 12/9/15 10:27 PM, Xueyuan Jia wrote:
> https://docs.google.com/presentation/d/1PE9bZnYGlrNyiplIF1QqC4h1EBLuFbEXiFk9zwFm1FI/pub?start=false&loop=false&delayms=3000#slide=id.p 
>
>
> Presenter: Philippe Le Hegaret

Nice doc PLH; thanks!

(Although I did have a LOL moment since this doc doesn't appear to be
available on Github (and if it is, please cite the repo in the doc).)

Reply | Threaded
Open this post in threaded view
|

Re: [Project review] How to make the best of GitHub for your specification? - 17 December 2015

Adrian Hope-Bailie
We have been using the GitHub wiki successfully in the Web Payments WG.
We use it to plan our meeting agendas, link to minutes and capture high-level ideas that are then discussed on the issue list.

https://github.com/w3c/webpayments/wiki/

On 10 December 2015 at 17:55, Arthur Barstow <[hidden email]> wrote:
On 12/9/15 10:27 PM, Xueyuan Jia wrote:
https://docs.google.com/presentation/d/1PE9bZnYGlrNyiplIF1QqC4h1EBLuFbEXiFk9zwFm1FI/pub?start=false&loop=false&delayms=3000#slide=id.p

Presenter: Philippe Le Hegaret

Nice doc PLH; thanks!

(Although I did have a LOL moment since this doc doesn't appear to be available on Github (and if it is, please cite the repo in the doc).)


Reply | Threaded
Open this post in threaded view
|

Re: [Project review] How to make the best of GitHub for your specification? - 17 December 2015

Philippe Le Hegaret
In reply to this post by Arthur Barstow-2


On 12/10/2015 10:55 AM, Arthur Barstow wrote:

> On 12/9/15 10:27 PM, Xueyuan Jia wrote:
>> https://docs.google.com/presentation/d/1PE9bZnYGlrNyiplIF1QqC4h1EBLuFbEXiFk9zwFm1FI/pub?start=false&loop=false&delayms=3000#slide=id.p
>>
>>
>> Presenter: Philippe Le Hegaret
>
> Nice doc PLH; thanks!
>
> (Although I did have a LOL moment since this doc doesn't appear to be
> available on Github (and if it is, please cite the repo in the doc).)

Not yet for my own practical purpose. I also meant to have a propoer
html version of those slides but been lacking time. Since my ultimate
goal is also to improve our documentation at https://w3c.github.io/,
that will definitively find its way into a repo.

Philippe

Reply | Threaded
Open this post in threaded view
|

Re: [Project review] How to make the best of GitHub for your specification? - 17 December 2015

Philippe Le Hegaret


On 12/11/2015 09:10 AM, Philippe Le Hegaret wrote:

>
>
> On 12/10/2015 10:55 AM, Arthur Barstow wrote:
>> On 12/9/15 10:27 PM, Xueyuan Jia wrote:
>>> https://docs.google.com/presentation/d/1PE9bZnYGlrNyiplIF1QqC4h1EBLuFbEXiFk9zwFm1FI/pub?start=false&loop=false&delayms=3000#slide=id.p
>>>
>>>
>>>
>>> Presenter: Philippe Le Hegaret
>>
>> Nice doc PLH; thanks!
>>
>> (Although I did have a LOL moment since this doc doesn't appear to be
>> available on Github (and if it is, please cite the repo in the doc).)
>
> Not yet for my own practical purpose. I also meant to have a propoer
> html version of those slides but been lacking time.

HTML version of the slides is at:
   http://www.w3.org/2015/Talks/1217-github-w3c/

Philippe

Reply | Threaded
Open this post in threaded view
|

Re: [Project review] How to make the best of GitHub for your specification? - 17 December 2015

nigelmegitt
Thanks Philippe,

One technical query I don't think I've seen an answer for yet, under the
Migration heading:

What's the best way to migrate the Mercurial keywords replacement
functionality?

For example, if you used to have a .hgrc file such as the following needed
for building TTML (using XMLSpec) with entries like:


[keyword]
ttml1/spec/ttml1.xml =
ttml2/spec/ttml2.xml =

[keywordmaps]
Author = {author|user}
Date = {date|utcdate}
Header = {root}/{file},v {node|short} {date|utcdate} {author|user}
Id = {file|basename},v {node|short} {date|utcdate} {author|user}
RCSFile = {file|basename},v
RCSfile = {file|basename},v
Revision = {node|short}
Source = {root}/{file},v


(probably not all of those keyword maps entries are actually needed, so
please excuse my untidiness)

Then how do you reproduce that behaviour in github?


All answers appreciated - a quick web search indicates there are a variety
of techniques available, so any known good practices would be welcome.

Nigel


On 16/12/2015 23:01, "Philippe Le Hegaret" <[hidden email]> wrote:

>
>
>On 12/11/2015 09:10 AM, Philippe Le Hegaret wrote:
>>
>>
>> On 12/10/2015 10:55 AM, Arthur Barstow wrote:
>>> On 12/9/15 10:27 PM, Xueyuan Jia wrote:
>>>>
>>>>https://docs.google.com/presentation/d/1PE9bZnYGlrNyiplIF1QqC4h1EBLuFbE
>>>>XiFk9zwFm1FI/pub?start=false&loop=false&delayms=3000#slide=id.p
>>>>
>>>>
>>>>
>>>> Presenter: Philippe Le Hegaret
>>>
>>> Nice doc PLH; thanks!
>>>
>>> (Although I did have a LOL moment since this doc doesn't appear to be
>>> available on Github (and if it is, please cite the repo in the doc).)
>>
>> Not yet for my own practical purpose. I also meant to have a propoer
>> html version of those slides but been lacking time.
>
>HTML version of the slides is at:
>   http://www.w3.org/2015/Talks/1217-github-w3c/
>
>Philippe
>



-----------------------------
http://www.bbc.co.uk
This e-mail (and any attachments) is confidential and
may contain personal views which are not the views of the BBC unless specifically stated.
If you have received it in
error, please delete it from your system.
Do not use, copy or disclose the
information in any way nor act in reliance on it and notify the sender
immediately.
Please note that the BBC monitors e-mails
sent or received.
Further communication will signify your consent to
this.
-----------------------------
Reply | Threaded
Open this post in threaded view
|

Re: [Project review] How to make the best of GitHub for your specification? - 17 December 2015

Ivan Herman-2
In reply to this post by Philippe Le Hegaret
Philippe (or anyone)

I saw the reference to http://www.w3.org/2010/webperf/board/, which is a really nice tool. Is this tool generally available so that a group can pick it up and adapt it to a specific group?

There is the W3C dashboard:

https://labs.w3.org/hatchery/midgard/

but I am not sure it is still actively managed (and not all repositories are automatically added to it from github in the configuration panel, although that would make it really useful…). But the webperf dashboard seems to be handier insofar as it is based on open issues as opposed to each comments as separate items…

Ivan


> On 17 Dec 2015, at 00:01, Philippe Le Hegaret <[hidden email]> wrote:
>
>
>
> On 12/11/2015 09:10 AM, Philippe Le Hegaret wrote:
>>
>>
>> On 12/10/2015 10:55 AM, Arthur Barstow wrote:
>>> On 12/9/15 10:27 PM, Xueyuan Jia wrote:
>>>> https://docs.google.com/presentation/d/1PE9bZnYGlrNyiplIF1QqC4h1EBLuFbEXiFk9zwFm1FI/pub?start=false&loop=false&delayms=3000#slide=id.p
>>>>
>>>>
>>>>
>>>> Presenter: Philippe Le Hegaret
>>>
>>> Nice doc PLH; thanks!
>>>
>>> (Although I did have a LOL moment since this doc doesn't appear to be
>>> available on Github (and if it is, please cite the repo in the doc).)
>>
>> Not yet for my own practical purpose. I also meant to have a propoer
>> html version of those slides but been lacking time.
>
> HTML version of the slides is at:
>  http://www.w3.org/2015/Talks/1217-github-w3c/
>
> Philippe
>

----
Ivan Herman, W3C
Digital Publishing Lead
Home: http://www.w3.org/People/Ivan/
mobile: +31-641044153
ORCID ID: http://orcid.org/0000-0003-0782-2704





signature.asc (210 bytes) Download Attachment
Reply | Threaded
Open this post in threaded view
|

Re: [Project review] How to make the best of GitHub for your specification? - 17 December 2015

Philippe Le Hegaret


On 12/17/2015 04:57 AM, Ivan Herman wrote:
> Philippe (or anyone)
>
> I saw the reference to http://www.w3.org/2010/webperf/board/, which is a really nice tool. Is this tool generally available so that a group can pick it up and adapt it to a specific group?

The source of that code is at
  https://github.com/w3c/webperf-dashboard

available under the MIT license.

Dominique has been playing with it as well to adapt it for the WebRTC WG.


>
> https://labs.w3.org/hatchery/midgard/
>
> but I am not sure it is still actively managed (and not all repositories are automatically added to it from github in the configuration panel, although that would make it really useful…). But the webperf dashboard seems to be handier insofar as it is based on open issues as opposed to each comments as separate items…

I've also started to play with the webperf dashboard and the w3c api to
see the possibilities there. But that's only vague attempts so far.

Philippe

Reply | Threaded
Open this post in threaded view
|

Re: [Project review] How to make the best of GitHub for your specification? - 17 December 2015

Philippe Le Hegaret
In reply to this post by nigelmegitt


On 12/17/2015 04:44 AM, Nigel Megitt wrote:
> Thanks Philippe,
>
> One technical query I don't think I've seen an answer for yet, under the
> Migration heading:
>
> What's the best way to migrate the Mercurial keywords replacement
> functionality?

Did you look into git attribute?

https://git-scm.com/book/en/v2/Customizing-Git-Git-Attributes

http://git-scm.com/docs/gitattributes


Philippe

Reply | Threaded
Open this post in threaded view
|

Re: [Project review] How to make the best of GitHub for your specification? - 17 December 2015

nigelmegitt


On 17/12/2015 13:19, "Philippe Le Hegaret" <[hidden email]> wrote:

>
>
>On 12/17/2015 04:44 AM, Nigel Megitt wrote:
>> Thanks Philippe,
>>
>> One technical query I don't think I've seen an answer for yet, under the
>> Migration heading:
>>
>> What's the best way to migrate the Mercurial keywords replacement
>> functionality?
>
>Did you look into git attribute?
>
>https://git-scm.com/book/en/v2/Customizing-Git-Git-Attributes
>
>http://git-scm.com/docs/gitattributes

Yes, I did find that - it's certainly one of the options available. There
seem to be others too, so any stories based on experience of using this
would be good.

>
>
>Philippe



-----------------------------
http://www.bbc.co.uk
This e-mail (and any attachments) is confidential and
may contain personal views which are not the views of the BBC unless specifically stated.
If you have received it in
error, please delete it from your system.
Do not use, copy or disclose the
information in any way nor act in reliance on it and notify the sender
immediately.
Please note that the BBC monitors e-mails
sent or received.
Further communication will signify your consent to
this.
-----------------------------
Reply | Threaded
Open this post in threaded view
|

RE: [Project review] How to make the best of GitHub for your specification? - 17 December 2015

Todd Reifsteck
In reply to this post by Philippe Le Hegaret
And in case it wasn't obvious, big props to Ilya Grigorik for putting this dashboard together!

-----Original Message-----
From: Philippe Le Hegaret [mailto:[hidden email]]
Sent: Thursday, December 17, 2015 5:14 AM
To: Ivan Herman <[hidden email]>
Cc: Arthur Barstow <[hidden email]>; [hidden email]; [hidden email]; Dominique Hazael-Massieux <[hidden email]>
Subject: Re: [Project review] How to make the best of GitHub for your specification? - 17 December 2015



On 12/17/2015 04:57 AM, Ivan Herman wrote:
> Philippe (or anyone)
>
> I saw the reference to http://www.w3.org/2010/webperf/board/, which is a really nice tool. Is this tool generally available so that a group can pick it up and adapt it to a specific group?

The source of that code is at
  https://github.com/w3c/webperf-dashboard

available under the MIT license.

Dominique has been playing with it as well to adapt it for the WebRTC WG.


>
> https://labs.w3.org/hatchery/midgard/
>
> but I am not sure it is still actively managed (and not all
> repositories are automatically added to it from github in the
> configuration panel, although that would make it really useful…). But
> the webperf dashboard seems to be handier insofar as it is based on
> open issues as opposed to each comments as separate items…

I've also started to play with the webperf dashboard and the w3c api to see the possibilities there. But that's only vague attempts so far.

Philippe