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

doc: move all TLS-PSK documentation to its section #35717

Merged
merged 1 commit into from
May 25, 2024

Conversation

mildsunrise
Copy link
Member

The documentation on PSK is scattered in various places, I suggest we put it all in its section (and link to there).

PSK is a marginal feature and must be used with care, so I think it's better this way, and we avoid cluttering the options section with really long option entries.

@nodejs/documentation @nodejs/crypto

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. tls Issues and PRs related to the tls subsystem. labels Oct 20, 2020
@mildsunrise
Copy link
Member Author

mildsunrise commented Oct 20, 2020

I've also reworded some things and removed the phrase "identity must use UTF-8 encoding" since it doesn't seem to make sense, identity is a string(?)

doc/api/tls.md Outdated Show resolved Hide resolved
doc/api/tls.md Outdated Show resolved Hide resolved
Copy link
Member

@lundibundi lundibundi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great idea

doc/api/tls.md Outdated Show resolved Hide resolved
@aduh95
Copy link
Contributor

aduh95 commented Jan 18, 2021

@mildsunrise can you please address the comments so this can land?

@Trott
Copy link
Member

Trott commented Feb 28, 2021

@mildsunrise can you please address the comments so this can land?

My comments are non-blocking, so it's really just @lundibundi's one suggestion (which might also be non-blocking)?

doc/api/tls.md Outdated Show resolved Hide resolved
doc/api/tls.md Outdated Show resolved Hide resolved
@aduh95
Copy link
Contributor

aduh95 commented Dec 26, 2023

This needs a rebase.

@aduh95 aduh95 force-pushed the doc-move-tlspsk branch from d0d068a to 7194ba1 Compare May 5, 2024 13:01
@aduh95 aduh95 requested a review from tniessen May 5, 2024 13:02
@aduh95 aduh95 force-pushed the doc-move-tlspsk branch from 7194ba1 to c3358aa Compare May 11, 2024 17:41
@aduh95 aduh95 added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label May 11, 2024
@aduh95 aduh95 merged commit 0d7b5a9 into nodejs:main May 25, 2024
17 checks passed
@aduh95
Copy link
Contributor

aduh95 commented May 25, 2024

Landed in c3358aa

targos pushed a commit that referenced this pull request Jun 1, 2024
PR-URL: #35717
Reviewed-By: Rich Trott <rtrott@gmail.com>
@RafaelGSS RafaelGSS mentioned this pull request Jun 7, 2024
sophoniie pushed a commit to sophoniie/node that referenced this pull request Jun 20, 2024
PR-URL: nodejs#35717
Reviewed-By: Rich Trott <rtrott@gmail.com>
bmeck pushed a commit to bmeck/node that referenced this pull request Jun 22, 2024
PR-URL: nodejs#35717
Reviewed-By: Rich Trott <rtrott@gmail.com>
marco-ippolito pushed a commit that referenced this pull request Jul 19, 2024
PR-URL: #35717
Reviewed-By: Rich Trott <rtrott@gmail.com>
marco-ippolito pushed a commit that referenced this pull request Jul 19, 2024
PR-URL: #35717
Reviewed-By: Rich Trott <rtrott@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. doc Issues and PRs related to the documentations. tls Issues and PRs related to the tls subsystem.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants