Difference between revisions of "Legal Team/Templatizing/ActionPlan"

From SPDX Wiki
Jump to: navigation, search
(Check website generation / tools: --- add testing)
Line 23: Line 23:
 
* '''General Cleanup'''
 
* '''General Cleanup'''
 
** <span style="color: red;">After review is complete and all licenses and exceptions have been merged, general clean-up to include: (WHO? someone from tech team? discuss at OSLS)</span> -->
 
** <span style="color: red;">After review is complete and all licenses and exceptions have been merged, general clean-up to include: (WHO? someone from tech team? discuss at OSLS)</span> -->
** remove body tag
+
*** remove body tag
** fix lower case spdx tags
+
*** fix lower case spdx tags
** get rid of HTML- and UTF8-escaped characters
+
*** get rid of HTML- and UTF8-escaped characters
** ... others?
+
*** update tags as per tech team recommendations (see below)  
** update tags as per tech team recommendations (someone from tech team)  
+
*** ... others?
  
 
=== Finalize XML tag names ===
 
=== Finalize XML tag names ===
Line 33: Line 33:
 
** process: build a table for existing field name (machine-readable name for these from current spec) and new XML tag - DONE
 
** process: build a table for existing field name (machine-readable name for these from current spec) and new XML tag - DONE
 
** Gary took to tech team, and had joint call with legal and tech team to finalize. Notes here: http://wiki.spdx.org/view/Technical_Team/Minutes/2016-10-25 and https://docs.google.com/document/d/1z9n44xLH2MxT576KS_AbTOBtecyl5cw6RsrrQHibQtg/edit
 
** Gary took to tech team, and had joint call with legal and tech team to finalize. Notes here: http://wiki.spdx.org/view/Technical_Team/Minutes/2016-10-25 and https://docs.google.com/document/d/1z9n44xLH2MxT576KS_AbTOBtecyl5cw6RsrrQHibQtg/edit
* update tags as per tech team recommendations (see above)
+
* update tags as per tech team recommendations (action item noted above)
  
 
+
== Action Items - Stage 1b: Switch to Github, using old license list format - Jan 30 ==
 
+
=== Documentation ===
+
 
* Update info for README on Github for initial switch to Github from Git repo, prior to XML conversion (Dennis to draft, ALL review) - DONE
 
* Update info for README on Github for initial switch to Github from Git repo, prior to XML conversion (Dennis to draft, ALL review) - DONE
 
** completed - see here: https://docs.google.com/document/d/1kGSs3CXbtjF_uZmVsjhXMGChyP-pzlszktTr8t4PmmI/edit#
 
** completed - see here: https://docs.google.com/document/d/1kGSs3CXbtjF_uZmVsjhXMGChyP-pzlszktTr8t4PmmI/edit#
* Review various webpages for updating (changes to be made now? or what until stage 2?) - Alan did first pass, which raised various questions and other things to address, need to revisit now that naming issue has been resolved with tech team
+
* <span style="color: red;">update README on Jan 30 or after with this text </span>
** license matching guidelines page
+
* <span style="color: red;">update webpages where needed: (JILAYNE w/help from rest of legal team) </span>
** license list overview page,
+
** info about XML tags (http://wiki.spdx.org/view/Legal_Team/Templatizing/tags-matching) - this may be more likely stage 2 and become part of spec as an appendix
+
 
+
== Action Items - Stage 1b: Switch to Github, using old license list format - Jan 29 ==
+
* update README (see above for link to text)
+
* update any relevant webpages:
+
 
** links to master files
 
** links to master files
 
** page on requesting a new license - how to update, just point to README?
 
** page on requesting a new license - how to update, just point to README?
Line 53: Line 45:
  
 
== Action Items - Stage 2: Go live with XML conversion==
 
== Action Items - Stage 2: Go live with XML conversion==
 
=== Create new tool to take text of new license and convert to XML file ===
 
* to do so by hand is a bit tedious. Will still need human review before finalizing. Initial tool Kris used probably won't be applicable. Would be nice if this could be web-based
 
* discuss with tech team, find someone to take this on? ---> discuss at OSLS
 
 
=== Documentation: Define a new process for License List via Github and with new XML format ===
 
* i.e., how to request a new license, what kind of pull requests we want, underlying process etc.
 
* included checking with Kate re: moving license list to Github primary (instead of LF Git and mirrored to Github)
 
  
 
=== Check website generation / tools ===
 
=== Check website generation / tools ===
Line 67: Line 51:
 
* preview of website before release
 
* preview of website before release
 
* Testing regime for XML (either manually or by continuous integration) to validate that XML source generates correct text
 
* Testing regime for XML (either manually or by continuous integration) to validate that XML source generates correct text
 +
 +
=== Documentation ===
 +
* Review various webpages for updating
 +
** Alan did first pass, which raised various questions and other things to address, need to revisit now that naming issue has been resolved with tech team
 +
** license matching guidelines page
 +
** license list overview page
 +
** README
 +
** other pages?
 +
** info about XML tags (http://wiki.spdx.org/view/Legal_Team/Templatizing/tags-matching) - this may become part of spec as an appendix, but where to put in meantime?
 +
 +
=== Create new tool to take text of new license and convert to XML file ===
 +
* to do so by hand is a bit tedious. Will still need human review before finalizing. Initial tool Kris used probably won't be applicable. Would be nice if this could be web-based
 +
* discuss with tech team, find someone to take this on? ---> discuss at OSLS
  
 
=== Coordination with tech team and SPDX Spec v2.2 ===
 
=== Coordination with tech team and SPDX Spec v2.2 ===
Line 72: Line 69:
 
* explanation of XML tags - to go in markup appendix or new appendix?
 
* explanation of XML tags - to go in markup appendix or new appendix?
 
* ---> discuss at OSLS
 
* ---> discuss at OSLS
 +
 +
=== Tool for verifying XML against known text file ===
 +
* Brad to provide better explanation

Revision as of 19:06, 19 January 2017

Action Items - Stage 1a: XML Conversion of Existing Licenses

  • Existing License PRs
    • Finish main review of all licenses so that all can merged (Who: ALL)
  • Kris to put original "conversion" tool (to convert text files into XML format, to then be reviewed) in public repository so anyone else can use it or improve it (KRIS)
  • Exceptions
    • Convert and add exceptions to repository (KRIS or someone from tech team using Kris' tool)
    • note from Gary: tools don't care whether in same or different directory
    • Review exceptions and merge exception PRs (ALL)
  • Deprecated licenses
    • outcome: Proposed solution to add a boolean attribute named deprecated to the SPDX element with a default value of false. For the "+" deprecated licenses, we would copy the XML file, rename it to include the "+" and add deprecated=true to the SPDX attributed.
    • Convert and add deprecated licenses to repository (GARY)
    • Review and merge deprecated license PRs (ALL)
  • PRs tagged "requires acknowledgement" or "has self-referring numbering"
    • Originally, we planned to add XML tags to reflect these characteristics (and not merge these licenses until we do so). For now, though, we will leave this as a potential feature for the future, and proceed to merge these licenses as long as their basic formatting looks correct. (We will be able to go back and review which PRs had these labels even after merging.)
    • Merge those labeled "approved" and "requires acknowledgement" (JILAYNE) --> DONE
    • In future, may also need a more thorough review of existing licenses to see if any others meet these criteria (i.e. can't rely solely on the labeled PRs)
  • True-up license list to current release
    • Need to true-up changes to existing licenses from 2.3 (when XML repo was created) to current 2.6 release using spreadsheet (?? NAME)
    • Convert and add new licenses to repo from 2.4, 2.5. 2.6 (KRIS or someone from tech team using Kris' tool)
    • Review and merge PRs for new licenses/exceptions since 2.3 (ALL)
  • General Cleanup
    • After review is complete and all licenses and exceptions have been merged, general clean-up to include: (WHO? someone from tech team? discuss at OSLS) -->
      • remove body tag
      • fix lower case spdx tags
      • get rid of HTML- and UTF8-escaped characters
      • update tags as per tech team recommendations (see below)
      • ... others?

Finalize XML tag names

Action Items - Stage 1b: Switch to Github, using old license list format - Jan 30

  • Update info for README on Github for initial switch to Github from Git repo, prior to XML conversion (Dennis to draft, ALL review) - DONE
  • update README on Jan 30 or after with this text
  • update webpages where needed: (JILAYNE w/help from rest of legal team)
    • links to master files
    • page on requesting a new license - how to update, just point to README?
    • what else?

Action Items - Stage 2: Go live with XML conversion

Check website generation / tools

  • As of Sept 16 call, Gary had done a first pass on tools to generate website and caught a bunch of validation errors, many of which were from lower case <spdx> tag. Gary to see what other validations were and fix and merge if simply or create pull request/submit to legal team if needs review
  • other updates to spdx-tools for new XML format to generate the website along with the 5 different license formats in available in the license-list-data git repository (Gary)
  • preview of website before release
  • Testing regime for XML (either manually or by continuous integration) to validate that XML source generates correct text

Documentation

  • Review various webpages for updating
    • Alan did first pass, which raised various questions and other things to address, need to revisit now that naming issue has been resolved with tech team
    • license matching guidelines page
    • license list overview page
    • README
    • other pages?
    • info about XML tags (http://wiki.spdx.org/view/Legal_Team/Templatizing/tags-matching) - this may become part of spec as an appendix, but where to put in meantime?

Create new tool to take text of new license and convert to XML file

  • to do so by hand is a bit tedious. Will still need human review before finalizing. Initial tool Kris used probably won't be applicable. Would be nice if this could be web-based
  • discuss with tech team, find someone to take this on? ---> discuss at OSLS

Coordination with tech team and SPDX Spec v2.2

  • revisions to current appendix in spec as to markup (e.g., var v. alt markup tag)
  • explanation of XML tags - to go in markup appendix or new appendix?
  • ---> discuss at OSLS

Tool for verifying XML against known text file

  • Brad to provide better explanation