doc: security: Update cryptographic documentation #73241
Conversation
ceolin
requested review from
dleach02 and
frkv
and removed request for
ithinuel and
carlescufi
|
@valeriosetti @tomi-font FYI ! |
ceolin
force-pushed
the
doc/security/crypto
branch
from
d48aa46
to
3450d36
Compare
doc/services/crypto/psa_crypto.rst
Outdated
| * Algorithm Flexibility | ||
|
|
||
| PSA Crypto API supports a wide range of cryptographic algorithms, |
There was a problem hiding this comment.
please consider using the following construct ("definition lists") for all these types of enumerations in the file:
| * Algorithm Flexibility | |
| PSA Crypto API supports a wide range of cryptographic algorithms, | |
| Algorithm Flexibility | |
| PSA Crypto API supports a wide range of cryptographic algorithms, |
This makes things much easier to read
There was a problem hiding this comment.
Looks good to me. Do we have a design guideline for documentation ? If don't would be nice to have these guidelines documented to get a consistent look'n feel
ceolin
force-pushed
the
doc/security/crypto
branch
2 times, most recently
from
a9746df
to
50ad9c2
Compare
|
@tomi-font @valeriosetti @kartben Thanks for the review. I have addressed all comments. Please take a look again |
Yep, we will need it, but we are still doing a lot of changes. Lets wait a little bit more to work on that. This section is more high-level and it is better to have it sooner than later. |
Not certain that's what you're pointing at, but for my part I've been adding entries along with the changes. Would be glad to receive your comments on them if you have any: #73267, #72565 |
Zephyr's transition to PSA Crypto API and demoting TinyCrypt. Lets not promote TinyCrypt in the overview. Signed-off-by: Flavio Ceolin <[email protected]>
TinyCrypt is being removed from Zephyr in favor of PSA Crypto. Signed-off-by: Flavio Ceolin <[email protected]>
Add PSA Crypto in the cryptographic services section. Signed-off-by: Flavio Ceolin <[email protected]>
ceolin
force-pushed
the
doc/security/crypto
branch
from
50ad9c2
to
32045ba
Compare
|
@tomi-font thanks for reviewing it :) |
|
@kartben can you take another look please ? |
There was a problem hiding this comment.
looks good, thanks! should there be another round of updates (or future PRs on the topic) it would be great to add a redirect (doc/_scripts/redirects.py) from the dropped tinycrypt page to somewhere else (probably services/crypto/index) so that it's not a 404 for folks browsing e.g. https://docs.zephyrproject.org/3.6.0/services/crypto/tinycrypt.html and clicking on "see the latest version ..."
Remove TinyCrypt documentation and add PSA Crypto.