THE SPDX WIKI IS NO LONGER ACTIVE. ALL CONTENT HAS BEEN MOVED TO https://github.com/spdx
Difference between revisions of "Tech Reports"
From SPDX Wiki
(→Tech Report Submission Checklist) |
(→Peer Review Criteria) |
||
| (31 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | == Overview == | + | == Program Overview == |
| − | + | ||
| − | == | + | The objective of the SPDX Report program is to create a repository of articles to capture and share community knowledge about everything and anything SPDX. This knowledge base covers a diverse collection of topics including (but not limited to): technical issues, best practices, relevant legal topics, tool proposals, adoption strategies and analysis, license compliance considerations, position papers and so forth. Periodically one of the SPDX working groups may select an article for publication on the SPDX website (spdx.org). |
| + | |||
| + | == SPDX Reports == | ||
| + | The current list of reports can be found here: http://wiki.spdx.org/view/Tech_Reports/TechReports2014 | ||
| + | |||
| + | == Publication Checklist == | ||
# For consideration author(s) need to publish their work under one of the following Creative Common Licenses: | # For consideration author(s) need to publish their work under one of the following Creative Common Licenses: | ||
| − | #* '''Attribution-NoDerivs CC BY-ND''' - This license allows for redistribution, commercial and non-commercial, as long as it is passed along unchanged and in whole, with credit to | + | #* '''Attribution-NoDerivs CC BY-ND''' - This license allows for redistribution, commercial and non-commercial, as long as it is passed along unchanged and in whole, with credit to the author(s). [http://creativecommons.org/licenses/by-nd/3.0/ See:] |
| − | #* '''Attribution CC BY''' - This license lets others distribute, remix, tweak, and build upon | + | #* '''Attribution CC BY''' - This license lets others distribute, remix, tweak, and build upon the work, even commercially, as long as they credit the author(s) for the original creation. [http://creativecommons.org/licenses/by/3.0/ See:] |
| − | #* '''Attribution-ShareAlike CC BY-SA''' - This license lets others remix, tweak, and build upon | + | #* '''Attribution-ShareAlike CC BY-SA''' - This license lets others remix, tweak, and build upon the work even for commercial purposes, as long as they credit the author(s) and license their new creations under the identical terms. [http://creativecommons.org/licenses/by-sa/3.0/ See:] |
| − | # Author(s) should | + | # Author(s) should submit an abstract to: press@spdx.org. |
| − | # The SPDX Business Working Group will review the proposal at an upcoming reoccurring bi-weekly meeting | + | # The SPDX Business Working Group will review the abstract proposal at an upcoming reoccurring bi-weekly meeting. |
| + | # The author(s) will be informed via email if their proposal was accepted or rejected. If accepted the author(s) will be given a deadline for final submission. | ||
| + | # If the final draft is received by the designated deadline in .docx format, it will be reviewed in its entirety by at least two reviewers. It will either be accepted or sent back to the author(s) for revision. This process repeats itself until the report is either formally accepted by both reviewers, rejected by at least one reviewer or withdrawn by the author(s). | ||
| + | # Once a report is accepted for publication: | ||
| + | #* The report will be assigned a unique tech report number (e.g., SPDX TR 2013-004) | ||
| + | #* Formatted using the standard SPDX tech report template | ||
| + | #* Entered into the SPDX tech report database | ||
| + | #* Announcement is made to the SPDX general list about the reports availability along with the abstract and a link. | ||
# Periodically an SPDX working group may select certain reports for publication on the main website spdx.org. | # Periodically an SPDX working group may select certain reports for publication on the main website spdx.org. | ||
| + | == Peer Review Acceptance Criteria == | ||
| + | * Must be reviewed by at least two members from two different working groups (Technical, Legal and Business). | ||
| + | * At least 51% of the reviewers must approve. | ||
| + | * Author(s) of the article cannot be reviewers. | ||
| + | * The following review criteria includes: | ||
| + | ** The content is relevant to the SPDX community | ||
| + | ** The content is easy to understand (sufficiently well written) | ||
| + | ** No obvious grammar or spelling mistakes present | ||
| + | ** It has been formatted using the SPDX tech report template and all the major sections have been include (where applicable). For example, includes an Abstract, Introduction, Main Content, Summary, References and About Author sections. | ||
| + | ** Appropriate disclaimers are included (e.g., not legal advice, not necessary opinions of the SPDX project or the Linux Foundation). | ||
| + | ** There is no length requirement. | ||
| + | == Tech Report Queue == | ||
{| class="wikitable sortable" border="1" | {| class="wikitable sortable" border="1" | ||
|+ | |+ | ||
| − | |||
| − | |||
! align="left" width=9% | TR # | ! align="left" width=9% | TR # | ||
! align="left" width=25% | Topic | ! align="left" width=25% | Topic | ||
| Line 25: | Line 46: | ||
! class="unsortable" | Comments | ! class="unsortable" | Comments | ||
|- | |- | ||
| − | | | + | | SPDX-TR-2014-1 |
| − | | File | + | | Rationale for Choosing the CC0 1.0 for SPDX File Data |
| − | | | + | | Published |
| − | | | + | | Mark Gisi |
| 2013-10-03 | | 2013-10-03 | ||
| − | | | + | | Decision Summary behind choosing CC0 1.0 for SPDX File Data |
|- | |- | ||
| − | | | + | | SPDX-TR-2014-2 |
| − | | | + | | Accessing the SPDX License List |
| − | | | + | | Preparing for publication |
| − | | | + | | Gary O'Neall |
| − | | | + | | 2014-03-15 |
| − | | | + | | Technical Discussion [[File:SPDX-TR-2014-2_v1_0.pdf]] |
|- | |- | ||
| − | | | + | | SPDX-TR-2014-3 |
| − | + | | SPDX Version 2.0 – Requirements and User Stories | |
| − | + | | Preparing for publication | |
| − | + | | Kirsten Newcomer | |
| − | + | | 2014-03-26 | |
| − | | | + | | Requirements doc |
| − | + | ||
| − | + | ||
| − | + | ||
| − | | | + | |
| − | | | + | |
| − | | | + | |
| − | | | + | |
|- | |- | ||
|} | |} | ||
| Line 57: | Line 71: | ||
== For Assistance == | == For Assistance == | ||
If you would like to learn more about the SPDX Tech Publication program, provide feedback on the current process or make recommendation on how to improve the process contact: | If you would like to learn more about the SPDX Tech Publication program, provide feedback on the current process or make recommendation on how to improve the process contact: | ||
| − | : | + | : press@spdx.org |
| − | + | ||
| − | + | ||
Latest revision as of 06:48, 17 September 2014
Contents
Program Overview
The objective of the SPDX Report program is to create a repository of articles to capture and share community knowledge about everything and anything SPDX. This knowledge base covers a diverse collection of topics including (but not limited to): technical issues, best practices, relevant legal topics, tool proposals, adoption strategies and analysis, license compliance considerations, position papers and so forth. Periodically one of the SPDX working groups may select an article for publication on the SPDX website (spdx.org).
SPDX Reports
The current list of reports can be found here: http://wiki.spdx.org/view/Tech_Reports/TechReports2014
Publication Checklist
- For consideration author(s) need to publish their work under one of the following Creative Common Licenses:
- Attribution-NoDerivs CC BY-ND - This license allows for redistribution, commercial and non-commercial, as long as it is passed along unchanged and in whole, with credit to the author(s). See:
- Attribution CC BY - This license lets others distribute, remix, tweak, and build upon the work, even commercially, as long as they credit the author(s) for the original creation. See:
- Attribution-ShareAlike CC BY-SA - This license lets others remix, tweak, and build upon the work even for commercial purposes, as long as they credit the author(s) and license their new creations under the identical terms. See:
- Author(s) should submit an abstract to: press@spdx.org.
- The SPDX Business Working Group will review the abstract proposal at an upcoming reoccurring bi-weekly meeting.
- The author(s) will be informed via email if their proposal was accepted or rejected. If accepted the author(s) will be given a deadline for final submission.
- If the final draft is received by the designated deadline in .docx format, it will be reviewed in its entirety by at least two reviewers. It will either be accepted or sent back to the author(s) for revision. This process repeats itself until the report is either formally accepted by both reviewers, rejected by at least one reviewer or withdrawn by the author(s).
- Once a report is accepted for publication:
- The report will be assigned a unique tech report number (e.g., SPDX TR 2013-004)
- Formatted using the standard SPDX tech report template
- Entered into the SPDX tech report database
- Announcement is made to the SPDX general list about the reports availability along with the abstract and a link.
- Periodically an SPDX working group may select certain reports for publication on the main website spdx.org.
Peer Review Acceptance Criteria
- Must be reviewed by at least two members from two different working groups (Technical, Legal and Business).
- At least 51% of the reviewers must approve.
- Author(s) of the article cannot be reviewers.
- The following review criteria includes:
- The content is relevant to the SPDX community
- The content is easy to understand (sufficiently well written)
- No obvious grammar or spelling mistakes present
- It has been formatted using the SPDX tech report template and all the major sections have been include (where applicable). For example, includes an Abstract, Introduction, Main Content, Summary, References and About Author sections.
- Appropriate disclaimers are included (e.g., not legal advice, not necessary opinions of the SPDX project or the Linux Foundation).
- There is no length requirement.
Tech Report Queue
| TR # | Topic | Status | Who | Date Submitted | Comments |
|---|---|---|---|---|---|
| SPDX-TR-2014-1 | Rationale for Choosing the CC0 1.0 for SPDX File Data | Published | Mark Gisi | 2013-10-03 | Decision Summary behind choosing CC0 1.0 for SPDX File Data |
| SPDX-TR-2014-2 | Accessing the SPDX License List | Preparing for publication | Gary O'Neall | 2014-03-15 | Technical Discussion File:SPDX-TR-2014-2 v1 0.pdf |
| SPDX-TR-2014-3 | SPDX Version 2.0 – Requirements and User Stories | Preparing for publication | Kirsten Newcomer | 2014-03-26 | Requirements doc |
For Assistance
If you would like to learn more about the SPDX Tech Publication program, provide feedback on the current process or make recommendation on how to improve the process contact:
- press@spdx.org
