-
Notifications
You must be signed in to change notification settings - Fork 3
Open
0 / 10 of 1 issue completedLabels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
Background
When you check the License List, there is a DOCS folder including several documents that are absent on the CryptAlg List.
Rationale
The current list misses some documents that are required to publish the List on the website. We need to create them before the List is published on the website
Description
A DOCS folder needs to be created to include several documents. Some of those documents are required before publishing the List on the SPDX website. Some others are not and can be created later on.
The documents that will be created before publishing the list of the SPDX Website are:
- release-process.md
- SPDX Cryptographic Algorithm List Release Process. Reference
- This document will be placed inside the folder docs
- algorithm-inclusion-principles.md
- Description of the principles to determine whether a candidate license should be included on the SPDX Cryptographic Algorithm List. Reference
- This document will be placed inside the folder docs
- RELEASE-HISTORY.md
- Table including the release dates and version. Reference
- This document lives in root
- CHANGELOG.md
- SPDX Cryptographic Algorithm List release notes. Reference
- This document lives in root
Other documents that live in DOCS
- crypto-algorithms-list-properties-description.md
- We will add the cardinality to each property described on this document Add to properties the concepts of presence and cardinality #55
Other documents, already available, that live in root
- LICENSE
- README.md
- CONTRIBUTING.md
The ones that will be created in the future are:
- faq.md.
- Frequently Asked Questions page including the most obvious questions and those we get repetitively over time. Reference
- history.md
- A historical timeline for the List Reference 1. Reference 2
- request-new-algorithm.md
- Process description to request, review, accept or reject a new algorithm to be added to the list. Reference
- new-algorithm-workflow.md
- This document provides guidance and checklists for SPDX Cryptography team members who are assigned to shepherd a new algorithm request. Reference
Actions
- Create the docs folder
- Create release-process.md and add it to docs folder SPDX Cryptographic Algorithm List release policy #52
- Create algorithm-inclusion-principles.md and add it to docs folder
- RELEASE-HISTORY.md and add it to root
- Create CHANGELOG.md and add it to root
- Add the cardinality to each property Add to properties the concepts of presence and cardinality #55
- Move crypto-algorithms-list-properties-description.md to docs
DoD
- Link to the docs folder
- Link to release-process.md
- Link to algorithm-inclusion-principles.md
- Link to RELEASE-HISTORY.md
- Link to CHANGELOG.md
- Link to crypto-algorithms-list-properties-description.md including the cardinality, inside the docs folder
Reactions are currently unavailable
Sub-issues
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation