Re: documenting the publishing process

Will do.

Gregg Kellogg
gregg@greggkellogg.net

On Mar 20, 2014, at 10:34 AM, Ivan Herman <ivan@w3.org> wrote:

> Gregg,
> 
> I did not know about the diff stuff. Can you add it to the document? Obviously it is irrelevant for now, but will be soon...
> 
> Thanks
> 
> Ivan
> 
> On 20 Mar 2014, at 18:18 , Gregg Kellogg <gregg@greggkellogg.net> wrote:
> 
>> On Mar 20, 2014, at 7:06 AM, Ivan Herman <ivan@w3.org> wrote:
>> 
>>> Dear all,
>>> 
>>> I was wondering, with some of you (ie, the editors), what the best way is to use github plus the W3C pubrules checker together when a formal publication occurs. I have also consulted my colleagues who have more experience with that particular combination of tools, and I have come up with a process that seems to work relatively well. It is based on the idea that we would store 'snapshots' of publications on the github for future reference; it may also come handy later. 
>>> 
>>> I have documented the whole process on
>>> 
>>> https://github.com/w3c/csvw/blob/gh-pages/publishing_process.md
>>> 
>>> The current publication round essentially followed this route. The advantage is that you can also do part of the steps (if you are an editor), ie, if I am run over by a bus (it should not always be DanBri:-) then at least you can do some of what is needed...
>> 
>> Note that Robin is working on integrating the new PubRules checker into ReSpec [1], so that will simplify the process even more.
>> 
>> One thing that's missing is generating the "diff from previous version", which ReSpec can also do for you, if the document has the appropriate headers. In this case, doing a diff from the previous WD is probably easiest for people to track continued progress, but it does require keeping up previousPublishDate, and previousDiffURI to make it work. We should also maintain the edDraftURI to point to the working version (e.g., /syntax/index.html).
>> 
>> The process is very much what we used for the JSON-LD docs.
>> 
>> Gregg
>> 
>> [1] http://lists.w3.org/Archives/Public/spec-prod/2014JanMar/0035.html
>> 
>>> Cheers
>>> 
>>> Ivan
>>> 
>>> ----
>>> Ivan Herman, W3C 
>>> Digital Publishing Activity Lead
>>> Home: http://www.w3.org/People/Ivan/
>>> mobile: +31-641044153
>>> GPG: 0x343F1A3D
>>> FOAF: http://www.ivan-herman.net/foaf
> 
> 
> ----
> Ivan Herman, W3C 
> Digital Publishing Activity Lead
> Home: http://www.w3.org/People/Ivan/
> mobile: +31-641044153
> GPG: 0x343F1A3D
> FOAF: http://www.ivan-herman.net/foaf
> 
> 
> 
> 
> 

Received on Thursday, 20 March 2014 17:45:13 UTC