Commit graph

538 commits

Author SHA1 Message Date
Heiko Schaefer
4d8ade3502
Add diagram for signature packet structure 2023-11-03 18:51:12 +01:00
Heiko Schaefer
e814cc5bb1
tmp: placeholder images, waiting for replacements in skvis-draft 2023-11-03 18:51:12 +01:00
Heiko Schaefer
1ec7d9a2ea
David points out that "magic" can be read as intimidating.
Like a topic is very hard to understand, or only accessible to wizards.
2023-11-03 18:51:12 +01:00
Tammi L. Coles
aa50f22d2c Merge pull request 'Minor edits for ch3' (#99) from heiko-ch3 into draft
Reviewed-on: https://codeberg.org/openpgp/notes/pulls/99
2023-11-03 11:33:16 +00:00
Tammi L. Coles
bac6fbe6fd clause correction in 69f5bce965 2023-11-03 12:31:21 +01:00
Heiko Schaefer
5e97344039
fix link target name 2023-11-03 12:26:06 +01:00
Heiko Schaefer
d33c8d7933
ch3: sharpen our terminology, use "hash digest" by default
Fixes #98
2023-11-03 12:25:50 +01:00
Heiko Schaefer
40924bef0d
Slightly expand/clarify phrasing on quantum resistance 2023-11-03 12:25:50 +01:00
Tammi L. Coles
545405c176 Merge pull request 'minor edits for ch1' (#103) from heiko-ch1 into draft
Reviewed-on: https://codeberg.org/openpgp/notes/pulls/103
2023-11-03 11:24:59 +00:00
Tammi L. Coles
8bb4baeff7 change verb in ef7a9956e4 2023-11-03 12:20:58 +01:00
Tammi L. Coles
661beb75e4 correct spelling in be01588cce 2023-11-03 12:18:34 +01:00
Tammi L. Coles
94ef48bdee edit 3ca2bc5529 2023-11-03 12:16:27 +01:00
Heiko Schaefer
f6bcc53211
Fix tense 2023-11-03 12:04:05 +01:00
Heiko Schaefer
75ac101a40
Introduce terms: confidentiality and authenticity 2023-11-03 12:04:05 +01:00
Heiko Schaefer
53473b025c
Remove redundancy 2023-11-03 12:04:04 +01:00
Heiko Schaefer
22b05ed942
Motivation text for this document 2023-11-03 12:04:04 +01:00
Heiko Schaefer
a3cf766492
Reorder text 2023-11-03 12:04:04 +01:00
Tammi L. Coles
cb5738658d Merge pull request 'minor edits for ch2' (#104) from heiko-ch2 into draft
Reviewed-on: https://codeberg.org/openpgp/notes/pulls/104
2023-11-03 11:00:34 +00:00
Tammi L. Coles
139a543db2 resolve https://codeberg.org/openpgp/notes/pulls/104#issuecomment-1318049 2023-11-03 11:59:37 +01:00
Heiko Schaefer
080c88909b
Cut redundancy 2023-11-03 11:53:34 +01:00
Heiko Schaefer
e4631e2b23
"Zooming in" content was moved to chapters at the end of the book 2023-11-03 11:53:34 +01:00
Heiko Schaefer
5eb6d310cf
Fix version claims and add a bit more detail about extensions to 4880.
It's not so straightforward: RFC 2440 and 4880 both define OpenPGP version 4 artifacts. So naming versions in the text is tricky.
2023-11-03 11:53:34 +01:00
Heiko Schaefer
1c9b9d8724
Remove stray brace 2023-11-03 11:53:34 +01:00
Heiko Schaefer
31d64fdb37
Fix link syntax 2023-11-03 11:53:34 +01:00
Heiko Schaefer
5f41b4fe64
update link to component_signatures_chapter 2023-11-03 10:56:05 +01:00
Heiko Schaefer
f336dcf7a3
remove .DS_Store 2023-11-03 10:53:54 +01:00
heiko
30f23eb37e Merge pull request 'tammi-ch4' (#81) from tammi-ch4 into draft
Reviewed-on: https://codeberg.org/openpgp/notes/pulls/81
2023-11-03 09:49:14 +00:00
Heiko Schaefer
8704758dde
Merge branch 'draft' into tammi-ch4
# Conflicts:
#	book/source/04-certificates.md
2023-11-03 10:43:58 +01:00
Tammi L. Coles
8fc4302338 resolve https://codeberg.org/openpgp/notes/pulls/81#issuecomment-1317436 2023-11-03 10:35:36 +01:00
Tammi L. Coles
783b151af6 Resolve https://codeberg.org/openpgp/notes/pulls/81#issuecomment-1291286 2023-11-03 10:20:20 +01:00
Tammi L. Coles
acb1d9f7e1 Resolve https://codeberg.org/openpgp/notes/pulls/81#issuecomment-1291281 2023-11-03 10:16:00 +01:00
Tammi L. Coles
86ce3d8ce2 change to bind to resolve https://codeberg.org/openpgp/notes/pulls/81#issuecomment-1291278 2023-11-03 10:15:16 +01:00
Tammi L. Coles
969fde83b2 change often to typically to resolve https://codeberg.org/openpgp/notes/pulls/81#issuecomment-1291271 2023-11-03 10:14:19 +01:00
Tammi L. Coles
0febf20d24 correct that fingerprint is not unique to resolve https://codeberg.org/openpgp/notes/pulls/81#issuecomment-1291270 2023-11-03 10:10:36 +01:00
Tammi L. Coles
accdb48301 clarify distinct role of primary key to resolve https://codeberg.org/openpgp/notes/pulls/81#issuecomment-1291268 2023-11-03 10:08:55 +01:00
Heiko Schaefer
c563f8a891
Generate updated png (with spelling fix, but for some reason this time with white background 🤷) 2023-11-02 20:07:00 +01:00
heiko
5054549fff Merge pull request 'Run codespell in CI' (#101) from dvzrv/codespell into draft
Reviewed-on: https://codeberg.org/openpgp/notes/pulls/101
2023-11-02 19:06:26 +00:00
Heiko Schaefer
8f5d9f48a1
Add a note that diagram spelling should not be fixed.
We'll fix diagram spellings in the course of the merge into the future 'main' branch.
2023-11-02 19:51:32 +01:00
David Runge
32a05d2c5b
Remove bat based Make file for Windows as it is unused
Signed-off-by: David Runge <dave@sleepmap.de>
2023-11-02 19:05:10 +01:00
David Runge
4459b3b2a9
Add CI job to run codespell on all source files
Fixes https://codeberg.org/openpgp/notes/issues/96

Signed-off-by: David Runge <dave@sleepmap.de>
2023-11-02 19:05:09 +01:00
David Runge
82f59746f2
Add codespell integration, which checks all sources
Add a make target for running `codespell` on all sources.
Skip running codespell on the build directory (we have javascript etc.
in there).
Only emit warnings but do not fail on spelling errors in diagrams.

Signed-off-by: David Runge <dave@sleepmap.de>
2023-11-02 19:05:05 +01:00
David Runge
cb4ac38e05
Fix spelling in source files
Signed-off-by: David Runge <dave@sleepmap.de>
2023-11-02 18:41:36 +01:00
Tammi L. Coles
dde0eae900 spell out the "not unique" issue to resolve https://codeberg.org/openpgp/notes/pulls/81#issuecomment-1291244 2023-11-02 17:52:35 +01:00
Tammi L. Coles
6d9bf44ba5 change fingerprint language to resolve https://codeberg.org/openpgp/notes/pulls/81#issuecomment-1291232 2023-11-02 17:46:55 +01:00
Tammi L. Coles
4d695764d0 connect metadata paragraphs better to resolve https://codeberg.org/openpgp/notes/pulls/81#issuecomment-1291216 2023-11-02 17:42:27 +01:00
Tammi L. Coles
e878c637b8 edit 118 to resolve https://codeberg.org/openpgp/notes/pulls/81#issuecomment-1291275 2023-11-02 17:31:14 +01:00
David Runge
e13127e064
When link checking, always build HTML from scratch
To be on the safe side, always build HTML pages from scratch, so that
lychee checks the actual current version of the files.

Signed-off-by: David Runge <dave@sleepmap.de>
2023-11-02 16:46:18 +01:00
David Runge
c9e7b03f53
Fail on warnings when building with sphinx-build
Fixes https://codeberg.org/openpgp/notes/issues/90

Signed-off-by: David Runge <dave@sleepmap.de>
2023-11-02 16:46:18 +01:00
David Runge
5fd9676392
Add a file to keep the static dir around when cloning the repo
Signed-off-by: David Runge <dave@sleepmap.de>
2023-11-02 16:46:17 +01:00
David Runge
415fb44ace
Do not fail on footnotes directly following a heading
Signed-off-by: David Runge <dave@sleepmap.de>
2023-11-02 16:46:16 +01:00