Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
gilles-peskine-arm opened this issue Jan 20, 2025 · 0 comments
Labels
size-s Estimated task size: small (~2d)

Comments

@gilles-peskine-arm
Copy link
Contributor

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.

@gilles-peskine-arm gilles-peskine-arm added the size-s Estimated task size: small (~2d) label Jan 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size-s Estimated task size: small (~2d)
Projects
Status: Blocked
Development

No branches or pull requests

1 participant