Nitrokey / nitrokey-documentation

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

Update nitrokey 3 OpenPGP to add installation procedure and factory reset #159

Closed sosthene-nitrokey closed 1 year ago

jans23 commented 1 year ago

Shouldn't we locate openpgp.rst and reset.rst at /shared/ instead of /nitrokey3/shared/ ?

I assume you copied content from another file to /nitrokey3/shared/openpgp.rst Wouldn't it be better to share and include the file instead of copying the content?

sosthene-nitrokey commented 1 year ago

The reset is specific to the Nitrokey 3, so I don't see why it should be shared with the rest, even though I did copy some text from the fido2 reset instructions. The OpenPGP one is modified to add the header containing instruction to use a firmware release more recent than 1.4.0, and to call it "Nitrokey 3" instead of just "Nitrokey"

jans23 commented 1 year ago

In this case I don't understand why it the files are in "nitrokey3/shared" at all.

Can openpgp.rst be generalized and "include" be used to avoid duplicate text?

sosthene-nitrokey commented 1 year ago

The note to upgrade to 1.4.0 doesn't make sense for other devices

jans23 commented 1 year ago

The note to upgrade to 1.4.0 doesn't make sense for other devices

Yes, that's why I suggest to separate this product-specific note and combine it with a generalized openpgp.rst via "include" statements.

sosthene-nitrokey commented 1 year ago

Ok, I'll do that.