Create a DOCS folder with some documents

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:

• spdx-cryptographic-algorithms-list-release-process.md #52
  • SPDX Cryptographic Algorithm List Release Process. Reference
  • This document will be placed inside the folder docs
• cryptographic-algorithm-inclusion-removal-criteria.md #61
  • Description of the principles to determine whether a candidate license should be included/removed of 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 #55

Other documents, already available, that live in root

• LICENSE
• README.md
• CONTRIBUTING.md
  • This document will have a more detailed contribution process description, including how to propose new algorithms. #59

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
• cryptographic-algorithm-inclusion-removal-criteria.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 spdx-cryptographic-algorithms-list-release-process.md and add it to docs folder #62
• Create cryptographic-algorithm-inclusion-removal-criteria.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 #55
• Move crypto-algorithms-list-properties-description.md to docs
• Enhance the CONTRIBUTING.md file #60

DoD

• Link to the docs folder: https://github.com/spdx/cryptographic-algorithm-list/tree/main/docs
• Link to spdx-cryptographic-algorithms-list-release-process.md: https://github.com/spdx/cryptographic-algorithm-list/blob/main/docs/spdx-cryptographic-algorithms-list-release-process.md
• Link to cryptographic-algorithm-inclusion-removal-criteria.md: https://github.com/spdx/cryptographic-algorithm-list/blob/main/docs/cryptographic-algorithm-inclusion-removal-criteria.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: https://github.com/spdx/cryptographic-algorithm-list/blob/main/docs/crypto-algorithms-list-properties-description.md

Start by reviewing the issue checklist and the referenced release-history and release-notes documents from the license-list-XML repository. Create RELEASE-HISTORY.md and CHANGELOG.md at the repository root, using the described release dates, versions, and release notes. Done means both files exist at the root and the documentation links in the DoD resolve.