Editing Set Up

Dear all (especially the currently identified editors),

This is just to get you started on editing the docs, something that, 
with the exception of Simon and, to some extent, Peter, will be new to 
you. That makes it scary - let me try and reduce the stress if I can.

The basics are that I have created skeleton docs in the GitHub Repo 
(https://github.com/w3c/dxwg/) at

https://github.com/w3c/dxwg/tree/gh-pages/ucr

and

https://github.com/w3c/dxwg/tree/gh-pages/dcat

You can see the rendered results at

https://w3c.github.io/dxwg/ucr/

and

https://w3c.github.io/dxwg/dcat/


Take a peek at the actual repo and for each document you'll see 2 files: 
the index.html file and the config. A tool, ReSpec, does a lot of the 
donkey work for you. It takes care of all that fancy W3C boilerplate 
stuff so you don't have to include it in the HTML yourself. See 
https://github.com/w3c/respec/wiki for chapter and verse on ReSpec.

The coolest feature, I think, is the look up of all RFCs and W3C 
standards, drafts and notes. This is done through a database at 
specref.org which is automatically updated every time W3C publishes a 
new doc. That's why, if you look at the paragraph of actual text that 
I've written in the DCAT doc, my simple inclusion of, literally, 
[[HCLS-Dataset]] automatically generates the relevant reference.

But what if a ref isn't in specref? Then you need to add it to the 
config file yourself. So that's what I've done for DCAT-AP and DATS.

I won't try and cover everything here. There's general guidance at 
https://w3c.github.io/ and we should probably have a separate call about 
it to get you going. In general:

- people who want to make a contribution should do so in their own repo 
(a fork) or a separate branch.
- Only editors should actually merge Pull Requests into the main doc.

There's a bunch of techie stuff I need to do to set up mailing lists 
hooks and so on - I'll do that in the coming days - but feel free to 
play around with your docs now.

One thing I do need to do though, is to invite you to join the GitHub 
Repo's team. TO do that I need to know your GitHub account user name. 
Simon, Peter and Alejandra I know but I need to know:

Ixcehl
Jaroslav
Thomas

(If you don't have a GitHub account, please set one up - you'll need it).

Only W3C staff can add you to the relevant team, so it's reasonably secure.

Hope this is enough to get you started,

Phil

-- 


Phil Archer
Data Strategist, W3C
http://www.w3.org/

http://philarcher.org
+44 (0)7887 767755
@philarcher1

Received on Monday, 5 June 2017 16:42:25 UTC