doc: add information about s2n-tls software architecture #4868
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* add software architecture md file * insert the file before connection doc
maddeleine
reviewed
Nov 5, 2024
goatgoose
reviewed
Nov 5, 2024
* move those general docs to config and connection chapters * move config chapter in front of the connection chapter
goatgoose
reviewed
Nov 5, 2024
* remove some repeating sentences * rephrase some sentences to make them read more precise
goatgoose
approved these changes
Nov 6, 2024
* make doc wording more precise based on comments
maddeleine
reviewed
Nov 6, 2024
* add software architecture information on top of the connection chapter * resolve a nit
lrstewart
reviewed
Nov 8, 2024
* remove repetitive sentences, and make wording more precise. * link relevant sections to software architecture's overview.
* change wording * move software architecture section to proper position * give general introductions about connection and config
lrstewart
reviewed
Nov 15, 2024
* rewrite the connection explanation for it to be more general * explain connection is established by handshake, and how config interacts with a connection
lrstewart
approved these changes
Nov 18, 2024
goatgoose
approved these changes
Nov 19, 2024
Co-authored-by: Lindsay Stewart <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolved issues:
The usage guide doesn't have documentations for general s2n-tls software architecture.
Description of changes:
I have updated our
usage-guideto include documentation about s2n-tls high level software architecture. Since the architecture mostly involvess2n_connectionands2n_config, I decided to create a new markdown file for software architecture before the connection usage guide. Therefore, I need to rename those documentations after the connection usage guide.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.