Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(2) Quinn Introduction Chapter, Connection Setup Page #921

Merged
merged 11 commits into from
Jan 28, 2021
Merged

(2) Quinn Introduction Chapter, Connection Setup Page #921

merged 11 commits into from
Jan 28, 2021

Conversation

TimonPost
Copy link
Contributor

@TimonPost TimonPost commented Nov 17, 2020

This PR is part of a series of PR's regarding the book creation as described in #865. Each page of this chapter will have its own PR for reducing PR size.

Live Version

A live version of this page can be found here. This book shows all the work that I have up-to-now. The pages that are visible but don't have a PR yet should are welcome to have general feedback.

Chapter Motivation

This chapter will go through the protocol by examples. The chapters are in the required order, first, we look at configuring a certificate which is required, then at setting up a connection, and finally at sending data about this connection. In the future, more pages can be added.

After reading this chapter the reader should be able to send data over a secured with a real or self-signed certificate, or insecure, connection.

The target audience is people who are new to the library and want to get started quickly by some examples and a short explanation. It is not meant to describe the entire API.

Page Motivation

The page introduces the reader to set up an endpoint and to acquire access to the Connection and NewConnection types. The process of certificates (#920) and data transfer (#922) is omitted on this page to prevent duplication.

Remarks

  • Some links to other chapters don't work yet, but will be working as soon other PR's are merged.

docs/book/src/quinn/set-up-connection.md Outdated Show resolved Hide resolved
docs/book/src/quinn/set-up-connection.md Outdated Show resolved Hide resolved
docs/book/src/quinn/set-up-connection.md Outdated Show resolved Hide resolved
docs/book/src/quinn/set-up-connection.md Outdated Show resolved Hide resolved
docs/book/src/quinn/set-up-connection.md Outdated Show resolved Hide resolved
docs/book/src/quinn/set-up-connection.md Outdated Show resolved Hide resolved
docs/book/src/quinn/set-up-connection.md Outdated Show resolved Hide resolved
@TimonPost
Copy link
Contributor Author

Thanks for the feedback. It is ready for another feedback round!

docs/book/src/quinn/set-up-connection.md Outdated Show resolved Hide resolved
docs/book/src/quinn/set-up-connection.md Outdated Show resolved Hide resolved
@TimonPost
Copy link
Contributor Author

It is ready for another round!

docs/book/src/quinn/set-up-connection.md Outdated Show resolved Hide resolved
docs/book/src/quinn/set-up-connection.md Outdated Show resolved Hide resolved
docs/book/src/quinn/set-up-connection.md Outdated Show resolved Hide resolved
docs/book/src/quinn/set-up-connection.md Outdated Show resolved Hide resolved
@TimonPost
Copy link
Contributor Author

Nice, it's ready!

@djc
Copy link
Member

djc commented Jan 18, 2021

Please fix the conflict here.

@TimonPost
Copy link
Contributor Author

Conflict fixed 👍

@djc djc merged commit 41171ee into quinn-rs:main Jan 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants