Hi all,

Wanted to let you all know that after several months in the making I pushed my 
MarkDown conversion of the SPDX specification 2.1 to  
https://github.com/spdx/spdx-spec/<https://emea01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fspdx%2Fspdx-spec%2F&data=01%7C01%7C%7Cf2120f455d4f4faac95608d4c2558dd9%7C6d4034cd72254f72b85391feaea64919%7C1&sdata=3L8REnWI8Ovt8OgAVdlA8t1DhAktLjgqQ1IqQjjAJ9g%3D&reserved=0>

Benefits


·         Working on GitHub and using MarkDown should make it easier for people 
to contribute either via Git, editing files online or by filling issue

·         Specification now be build as HTML, PDF, ePUB or Mobipocket

·         HTML version is now mobile friendly and PDF has a table of contents

·         Every change on master branch is automatically build and deployed as 
HTML to 
https://spdx.github.io/spdx-spec/<https://emea01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fspdx.github.io%2Fspdx-spec%2F&data=01%7C01%7C%7Cf2120f455d4f4faac95608d4c2558dd9%7C6d4034cd72254f72b85391feaea64919%7C1&sdata=J8QzqaphIudJs%2FF60l6VrCbGB88bfmiGFlZrDAPKMbI%3D&reserved=0>
 (using Travis CI)

Limitations

·         Simplified lay-out as MarkDown has some limitations compared to 
Google Docs. See for example table of contents – no section included due not 
being able to directly link to sections within different chapters

To Do

·         Write CONTRIBUTING.md  - explain to contributors how they can 
participate in shaping future version of the specification. Propose we discuss 
best workflow in the next call.

·         Minor issues - broken links, lay-out issues or spelling mistakes in 
original specification

·         Introduce workaround for MarkDown shortcomings in HTML version

·         Automate publishing of PDF, ePUB, Mobipocket to GitHub Releases for a 
new version of specification

·         Upgrade to GitBook 4.x when it becomes available



All fixes will be made on the development/2.1.1 branch. If you find something 
feel free to send me an email or raise an issue.

Regards,

Thomas Steenbergen
Principal Engineer Open Source Governance and Policy

HERE Deutschland GmbH, Place of Business: Invalidenstraße 116, 10115 Berlin, 
Germany – Commercial Register: Amtsgericht Charlottenburg, HRB 106443B - 
USt-IdNr.: DE 812 845 193 - Managing Directors: Michael Bültmann, Robertus A.J. 
Houben



_______________________________________________
Spdx-tech mailing list
[email protected]
https://lists.spdx.org/mailman/listinfo/spdx-tech

Reply via email to