Skip to content

Identify knowledge base entries that needs updating for TF-PSA-Crypto and for Mbed TLS 4.0 #163

Open
@gilles-peskine-arm

Description

@gilles-peskine-arm

The scope of this task is the knowledge base entries, i.e. https://github.com/Mbed-TLS/mbedtls-docs/tree/main/kb . The goal of this task is to identify documents that need a major update, or that are made obsolete, by Mbed TLS 4.0 and TF-PSA-Crypto 1.0.

This task is somewhat time-bound and does not need to be exhaustive. The knowledge base entries are not versioned, so we accept that they can get somewhat out of date. However, we don't want to have articles that are outright misleading to new readers. Thus reviewing every single line of every document is out of scope. What is in scope is to spend at least a few minutes on each document and decide if it can stay as is, or needs a major revision, or is only applicable to older versions.

Note that users don't have to use the latest release. In particular, articles that are applicable to Mbed TLS 3.6 LTS must not be removed for at least as long as we officially support 3.6. But an article that is only applicable up to 3.6 should have a note at the beginning saying so.

Deliverables:

  • File issues for articles that need updates.
  • Optionally, make minor updates directly.

Scheduling: this should be done close to the 1.0/4.0 release, when we have a precise idea of what goes into that release.

Metadata

Metadata

Assignees

No one assigned

    Labels

    size-sEstimated task size: small (~2d)

    Type

    Projects

    Status

    Blocked

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions