Skip to content

Create a DOCS folder with some documents #56

@toscalix

Description

@toscalix

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

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
  • 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

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

Sub-issues

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions