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: reorder deprecated tls docs #34687

Closed

Conversation

jeromecovington
Copy link
Contributor

In other api docs, it seems that deprecated classes and methods are
listed along with others, and marked as deprecated. In tls docs,
deprecations were listed at the bottom of the document. This commit
reorders them to what seems to be the standard, and corrects some links
in doc/api/deprecations.md

Checklist

In other api docs, it seems that deprecated classes and methods are
listed along with others, and marked as deprecated. In tls docs,
deprecations were listed at the bottom of the document. This commit
reorders them to what seems to be the standard, and corrects some links
in doc/api/deprecations.md
@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Aug 9, 2020
@jeromecovington
Copy link
Contributor Author

cc @Trott

jasnell
jasnell previously approved these changes Aug 10, 2020
Copy link
Member

@jasnell jasnell left a comment

Choose a reason for hiding this comment

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

This had been done intentionally to try to encourage that pattern throughout the other docs. I'd much rather see us go the other direction, moving deprecated APIs out to separate sections.

@jasnell jasnell dismissed their stale review August 10, 2020 14:37

Hit the wrong button

Copy link
Member

@jasnell jasnell left a comment

Choose a reason for hiding this comment

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

This had been done intentionally to try to encourage that pattern throughout the other docs. I'd much rather see us go the other direction, moving deprecated APIs out to separate sections.

@Trott
Copy link
Member

Trott commented Aug 10, 2020

This had been done intentionally to try to encourage that pattern throughout the other docs. I'd much rather see us go the other direction, moving deprecated APIs out to separate sections.

Why do we want to do that?

@jasnell
Copy link
Member

jasnell commented Aug 10, 2020

Why do we want to do that?

Frankly, to make deprecation easier to find, or easier to ignore.

@Trott
Copy link
Member

Trott commented Aug 10, 2020

Why do we want to do that?

Frankly, to make deprecation easier to find, or easier to ignore.

Easier to find: I don't think we should optimize for "I need to find all the deprecated functions in one place". I think we should optimize for "I need to know how this function works. I need to find it in a predictable place in the docs. I don't know that it's deprecated, or wouldn't think to look Someplace Else for deprecated functions."

Easier to ignore: Valid, but similarly, I don't think it's what we should optimize for over "the method is where I expect to find it".

The tls doc does not have all of the deprecated APIs listed in that section. So it's already arguably kind of a failing experiment. server.connections is not there. And moving it will change any the links to it in our docs or on the internet, increasing friction for deprecation changes. Breaking working URLs is also a big negative to the approach. (EDIT: Crossed out because actually, that depends on how it's done, so arguably not a valid concern on my part.)

On balance, I support this change and halting any move to requiring deprecated APIs to be tucked away at the bottom of the docs.

/ping @nodejs/documentation

@jasnell jasnell dismissed their stale review August 10, 2020 19:01

Doubt I'll have much luck winning folks over to my side ;-) ....won't block

Trott pushed a commit that referenced this pull request Aug 19, 2020
In other api docs, it seems that deprecated classes and methods are
listed along with others, and marked as deprecated. In tls docs,
deprecations were listed at the bottom of the document. This commit
reorders them to what seems to be the standard, and corrects some links
in doc/api/deprecations.md

PR-URL: #34687
Reviewed-By: Rich Trott <rtrott@gmail.com>
@Trott
Copy link
Member

Trott commented Aug 19, 2020

Landed in be360e2

@Trott Trott closed this Aug 19, 2020
BethGriggs pushed a commit that referenced this pull request Aug 20, 2020
In other api docs, it seems that deprecated classes and methods are
listed along with others, and marked as deprecated. In tls docs,
deprecations were listed at the bottom of the document. This commit
reorders them to what seems to be the standard, and corrects some links
in doc/api/deprecations.md

PR-URL: #34687
Reviewed-By: Rich Trott <rtrott@gmail.com>
@danielleadams danielleadams mentioned this pull request Aug 20, 2020
BethGriggs pushed a commit that referenced this pull request Aug 20, 2020
In other api docs, it seems that deprecated classes and methods are
listed along with others, and marked as deprecated. In tls docs,
deprecations were listed at the bottom of the document. This commit
reorders them to what seems to be the standard, and corrects some links
in doc/api/deprecations.md

PR-URL: #34687
Reviewed-By: Rich Trott <rtrott@gmail.com>
addaleax pushed a commit that referenced this pull request Sep 22, 2020
In other api docs, it seems that deprecated classes and methods are
listed along with others, and marked as deprecated. In tls docs,
deprecations were listed at the bottom of the document. This commit
reorders them to what seems to be the standard, and corrects some links
in doc/api/deprecations.md

PR-URL: #34687
Reviewed-By: Rich Trott <rtrott@gmail.com>
addaleax pushed a commit that referenced this pull request Sep 22, 2020
In other api docs, it seems that deprecated classes and methods are
listed along with others, and marked as deprecated. In tls docs,
deprecations were listed at the bottom of the document. This commit
reorders them to what seems to be the standard, and corrects some links
in doc/api/deprecations.md

PR-URL: #34687
Reviewed-By: Rich Trott <rtrott@gmail.com>
@codebytere codebytere mentioned this pull request Sep 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants