Re: Automatically Generating an offline OpenChain Conformance Handbook - Beta - Comments/Action Needed


Gary O'Neall
 

Note that if we translate the questionnaire JSON files (which I believe is planned), translated versions of the handbook will also be generated automatically. 

 

A bit more detail on how this works:

- The English version of the questionnaire is a file questionnaire.json in the conformance-questionnaire github repository

- Translated versions can be added appending the language code to the questionnaire file name (e.g. questionnaire-ja.json)

- A PDF document will be automatically generated for all translated versions of the questionnaire (e.g. questionnaire-ja.pdf)

 

The tools to produce the PDF document is open source and in the scripts directory in the conformance-questionnaire github repository.

 

If there is interest in this approach, I plan on updating the scripts to provide a better formatted document.  Suggestions for improvements are welcome.

 

Gary

> -----Original Message-----

> From: openchain-bounces@... <openchain-

> bounces@...> On Behalf Of Shane Coughlan

> Sent: Monday, October 29, 2018 7:15 PM

> To: openchain@...

> Cc: Openchain-conformance@...

> Subject: Re: [OpenChain] Automatically Generating an offline OpenChain

> Conformance Handbook - Beta - Comments/Action Needed

>

> companies could download, print and/or *translate* the document to suit

> workflows… sorry all.

>

> > On Oct 30, 2018, at 11:00, Shane Coughlan <coughlan@...>

> wrote:

> >

> > Dear all (flag for Miriam + conformance team)

> >

> > Comments/Action needed

> >

> > We previously maintained a document for “manual OpenChain

> Conformance.” The idea was that companies could download, print and/or

> the document to suit workflows beyond our online conformance web app.

> You can find a version of that document here:

> >

> https://wiki.linuxfoundation.org/_media/openchain/openchain_conforman

> ce_conformance_check_1.1.pdfhttps://wiki.linuxfoundation.org/_media/o

> penchain/openchain_conformance_conformance_check_1.1.pdf

> >

> > Gary has been doing something pretty exciting to make it quicker and

> faster to create such a manual document. He is automating the creation of

> such documents from inside the conformance web app. Check it out here:

> > https://github.com/OpenChain-Project/conformance-

> questionnaire/blob/master/docs/questionnaire.pdf

> >

> > Check out the background code on GitHub:

> > https://github.com/OpenChain-Project/conformance-questionnaire

> >

> > Does this approach work for you? Should we continue to build this

> document?

> >

> > Regards

> >

> > Shane

> >

> > --

> > Shane Coughlan

> > General Manager, OpenChain

> > e: coughlan@...

> > p: +81 (0) 80 4035 8083

> > w: www.openchainproject.org

> >

> > Professional profile: http://www.linkedin.com/in/shanecoughlan

> >

> > Get my free book on open source compliance here:

> > https://www.linuxfoundation.org/news-media/research/practical-gpl-

> compliance

> >

>

> _______________________________________________

> OpenChain mailing list

> OpenChain@...

> https://lists.linuxfoundation.org/mailman/listinfo/openchain

Join main@lists.openchainproject.org to automatically receive all group messages.