search

Nitrokey / nitrokey-documentation

User documentation of Nitrokey's products
https://docs.nitrokey.com
32 stars 36 forks source link

nk3: Document version info #146

Closed robin-nitrokey closed 1 year ago

robin-nitrokey commented 1 year ago

This patch documents the release types and the downgrade protection for the Nitrokey 3.

To do:

sosthene-nitrokey commented 1 year ago

I think it would also be great to document which features are available in each release.

jans23 commented 1 year ago

Isn't this what release notes are for (which are at Github)?

robin-nitrokey commented 1 year ago

I agree, but this is very likely to be out of sync quickly. That’s why I referred to the release notes where we maintain a list of supported features:

See the release notes_ on GitHub for more information on the features available in a release.

How could we make this clearer?

sosthene-nitrokey commented 1 year ago

Oh right, I missed that this was already in the release notes. It wasn't always the case.

szszszsz commented 1 year ago

Aside from that, are all variants tested for use safety before publishing? Like flashing this particular variant will never break the device? Precisely speaking, does update path stable -> testing -> stable always work?

robin-nitrokey commented 1 year ago

Aside from that, are all variants tested for use safety before publishing? Like flashing this particular variant will never break the device? Precisely speaking, does update path stable -> testing -> stable always work?

It should be tested at least once even for test releases. Other than that, it is hard to answer the question. Of course we only release firmwares that we assume to not break devices. But we can miss something, and the chances for that are higher with a test release than with a stable release.

szszszsz commented 1 year ago

Worth noting into the table too then :-) As a user I would appreciate to know things like that - whether my data are lost, and whenever my device is broken by using this particular firmware variant.

robin-nitrokey commented 1 year ago

I’ve added another sentence to the description to make this clear. I’d prefer to merge it like this so that we at least have some documentation on the topic. We can still improve it later by adding a table but currently I don’t see how to do this properly, both regarding formatting and phrasing.

robin-nitrokey commented 1 year ago

Moved to the main Nitrokey 3 page.