From d04b91eb486597016fa6f69862c3729eabde1cf5 Mon Sep 17 00:00:00 2001 From: Heiko Schaefer Date: Wed, 6 Dec 2023 15:00:02 +0100 Subject: [PATCH 1/5] soften versions section --- book/source/01-intro.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book/source/01-intro.md b/book/source/01-intro.md index 21402c6..7a3a638 100644 --- a/book/source/01-intro.md +++ b/book/source/01-intro.md @@ -46,7 +46,7 @@ This document describes OpenPGP concepts at the "library" level of abstraction, ## Which version of OpenPGP does this address? -The documentation mainly covers version 6 of OpenPGP, while occasionally noting differences to previous versions that are relevant to application developers. +This documentation covers all aspects of modern OpenPGP, most of which are common between current and upcoming versions. The basic concepts of OpenPGP are shared between all versions. Where there are differences, we center version 6, while occasionally noting differences to previous versions that are relevant to application developers. Version 4 of OpenPGP will remain relevant for a number of years; some version 3 artifacts are still in use as of this writing. From 162d24a55a2bfa9feb9b8873415ba21d8a7dfe96 Mon Sep 17 00:00:00 2001 From: "Tammi L. Coles" Date: Sat, 9 Dec 2023 15:45:37 +0100 Subject: [PATCH 2/5] emphasize version agnostic, general applicability --- book/source/01-intro.md | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/book/source/01-intro.md b/book/source/01-intro.md index 7a3a638..c9151fb 100644 --- a/book/source/01-intro.md +++ b/book/source/01-intro.md @@ -5,11 +5,9 @@ SPDX-License-Identifier: CC-BY-SA-4.0 # Introducing OpenPGP -This documentation project seeks to introduce OpenPGP concepts and functionalities to software developers who wish to use it in their projects. +This documentation project is designed to provide a comprehensive understanding of OpenPGP, highlighting its functionalities and applications for software developers. While this document predominantly references [OpenPGP version 6, as outlined in the latest RFC](https://datatracker.ietf.org/doc/draft-ietf-openpgp-crypto-refresh/), it is important to note that the fundamental principles and functionalities of OpenPGP have remained consistent across its versions since its major release in 1998. -This document describes [OpenPGP version 6](https://datatracker.ietf.org/doc/draft-ietf-openpgp-crypto-refresh/), with occasional remarks about differences to earlier versions. - -This text is *not* intended as a guide for end-users of OpenPGP-related software. +This documentation project seeks to introduce all OpenPGP concepts and functionalities to application developers who wish to use it in their projects. ## What is OpenPGP? @@ -46,7 +44,6 @@ This document describes OpenPGP concepts at the "library" level of abstraction, ## Which version of OpenPGP does this address? -This documentation covers all aspects of modern OpenPGP, most of which are common between current and upcoming versions. The basic concepts of OpenPGP are shared between all versions. Where there are differences, we center version 6, while occasionally noting differences to previous versions that are relevant to application developers. +This documentation encompasses the core aspects of modern OpenPGP, demonstrating that, at a foundational level, there is a significant overlap in functionality across various versions. Our focus on version 6 does not imply a preference or superiority over other versions; rather, it serves as a current reference point. We acknowledge that earlier versions, particularly version 4, continue to be relevant and widely used in ongoing projects. -Version 4 of OpenPGP will remain relevant for a number of years; -some version 3 artifacts are still in use as of this writing. +Where differences between versions exist, specific attention is given to those aspects pertinent to application developers, ensuring that the content is version-agnostic and broadly applicable. \ No newline at end of file From bcc004ebc1560ee6d83b913aa291878411b36aed Mon Sep 17 00:00:00 2001 From: "Tammi L. Coles" Date: Sat, 9 Dec 2023 16:01:00 +0100 Subject: [PATCH 3/5] clarify first rfc release --- book/source/01-intro.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/book/source/01-intro.md b/book/source/01-intro.md index c9151fb..86e8c2f 100644 --- a/book/source/01-intro.md +++ b/book/source/01-intro.md @@ -5,9 +5,9 @@ SPDX-License-Identifier: CC-BY-SA-4.0 # Introducing OpenPGP -This documentation project is designed to provide a comprehensive understanding of OpenPGP, highlighting its functionalities and applications for software developers. While this document predominantly references [OpenPGP version 6, as outlined in the latest RFC](https://datatracker.ietf.org/doc/draft-ietf-openpgp-crypto-refresh/), it is important to note that the fundamental principles and functionalities of OpenPGP have remained consistent across its versions since its major release in 1998. +This documentation project is designed to provide a comprehensive understanding of OpenPGP, highlighting its functionalities and applications for software developers. While this document predominantly references [OpenPGP version 6, as outlined in the latest RFC](https://datatracker.ietf.org/doc/draft-ietf-openpgp-crypto-refresh/), it is important to note that the fundamental principles and functionalities of OpenPGP have remained consistent across its versions since its first release as an open standard in RFC 2440 in 1998. -This documentation project seeks to introduce all OpenPGP concepts and functionalities to application developers who wish to use it in their projects. +This documentation project seeks to introduce all OpenPGP concepts and functionalities to application developers who wish to use it in their projects. ## What is OpenPGP? From 8a165de9f191332443b1b17a3edb2ca8b107f1ba Mon Sep 17 00:00:00 2001 From: "Tammi L. Coles" Date: Sat, 9 Dec 2023 16:12:19 +0100 Subject: [PATCH 4/5] edit version issue to show broad applicability --- book/source/01-intro.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/book/source/01-intro.md b/book/source/01-intro.md index 86e8c2f..3315521 100644 --- a/book/source/01-intro.md +++ b/book/source/01-intro.md @@ -44,6 +44,8 @@ This document describes OpenPGP concepts at the "library" level of abstraction, ## Which version of OpenPGP does this address? -This documentation encompasses the core aspects of modern OpenPGP, demonstrating that, at a foundational level, there is a significant overlap in functionality across various versions. Our focus on version 6 does not imply a preference or superiority over other versions; rather, it serves as a current reference point. We acknowledge that earlier versions, particularly version 4, continue to be relevant and widely used in ongoing projects. +This documentation encompasses the core aspects of modern OpenPGP practices, applicable across different versions. This respects that, at a foundational level, there is significant overlap, continuity, and consistency from its earliest version to its latest. -Where differences between versions exist, specific attention is given to those aspects pertinent to application developers, ensuring that the content is version-agnostic and broadly applicable. \ No newline at end of file +While using version 6 as a reference for current standards, we include insights derived from earlier versions, particularly version 4, which continues to be widely used in ongoing projects. + +Where differences between versions exist, specific attention is given to those aspects pertinent to application developers, ensuring that the content is as version-agnostic as possible and, thus, broadly applicable for developers working with various iterations of OpenPGP. \ No newline at end of file From 1b4ef4aa0a0ae71e1842e79ea3206f8048c37f95 Mon Sep 17 00:00:00 2001 From: "Tammi L. Coles" Date: Sat, 9 Dec 2023 16:18:47 +0100 Subject: [PATCH 5/5] reduce repetition --- book/source/01-intro.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book/source/01-intro.md b/book/source/01-intro.md index 3315521..fd01f53 100644 --- a/book/source/01-intro.md +++ b/book/source/01-intro.md @@ -48,4 +48,4 @@ This documentation encompasses the core aspects of modern OpenPGP practices, app While using version 6 as a reference for current standards, we include insights derived from earlier versions, particularly version 4, which continues to be widely used in ongoing projects. -Where differences between versions exist, specific attention is given to those aspects pertinent to application developers, ensuring that the content is as version-agnostic as possible and, thus, broadly applicable for developers working with various iterations of OpenPGP. \ No newline at end of file +Where differences between OpenPGP versions are relevant to application development, we provide focused insights to ensure the content remains as version-agnostic as possible and, thus, broadly applicable for developers working with various iterations of OpenPGP. \ No newline at end of file